UIProgressBar (RichFaces Distribution Assembler 4.5.5.Final API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - org.richfaces.component.AbstractProgressBar
    - - org.richfaces.component.UIProgressBar

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AjaxActivatorProps, AjaxProps, EventsMouseProps, StyleClassProps, StyleProps, MetaComponentEncoder, MetaComponentResolver
```
@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UIProgressBar
extends AbstractProgressBar
implements javax.faces.component.behavior.ClientBehaviorHolder, MetaComponentEncoder, MetaComponentResolver, AjaxProps, EventsMouseProps, StyleClassProps, StyleProps
```
The <rich:progressBar> component displays a progress bar to indicate the status of a process to the user. It can update either through Ajax or on the client side, and the look and feel can be fully customized.

Author:

"Andrey Markavtsov"

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class UIProgressBar.Properties

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`UIProgressBar.Properties`

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_FAMILY

static String COMPONENT_TYPE
- Fields inherited from class org.richfaces.component.AbstractProgressBar
  STATE_META_COMPONENT_ID
- Fields inherited from class javax.faces.component.UIComponent
  ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
- Fields inherited from interface org.richfaces.component.MetaComponentResolver
  META_COMPONENT_SEPARATOR_CHAR

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_FAMILY`
`static String`	`COMPONENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

UIProgressBar()

Constructors
Constructor and Description
`UIProgressBar()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getData()` Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
`String`	`getDefaultEventName()`
`Collection<String>`	`getEventNames()`
`Object`	`getExecute()` IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
`String`	`getFamily()`
`String`	`getFinishClass()` Space-separated list of CSS style class(es) to be applied when before progress finishes.
`String`	`getInitialClass()` Space-separated list of CSS style class(es) to be applied when before progress starts.
`int`	`getInterval()` Interval (in ms) for call poll requests.
`String`	`getLabel()` Defines a simple label instead of rendering children component
`Object`	`getMaxValue()` Max value, after which complete state should be rendered.
`Object`	`getMinValue()` Min value when initial state should be rendered.
`SwitchType`	`getMode()` The mode for updating the progress bar, can be one of:
`String`	`getOnbeforedomupdate()` The client-side script method to be called after the ajax response comes back, but before the DOM is updated
`String`	`getOnbegin()` The client-side script method to be called before an ajax request.
`String`	`getOnclick()` Javascript code executed when a pointer button is clicked over this element.
`String`	`getOncomplete()` The client-side script method to be called after the DOM is updated
`String`	`getOndblclick()` Javascript code executed when a pointer button is double clicked over this element.
`String`	`getOnfinish()` The client-side script method to be called when progress is finished
`String`	`getOnmousedown()` Javascript code executed when a pointer button is pressed down over this element.
`String`	`getOnmousemove()` Javascript code executed when a pointer button is moved within this element.
`String`	`getOnmouseout()` Javascript code executed when a pointer button is moved away from this element.
`String`	`getOnmouseover()` Javascript code executed when a pointer button is moved onto this element.
`String`	`getOnmouseup()` Javascript code executed when a pointer button is released over this element.
`String`	`getProgressClass()` Space-separated list of CSS style class(es) to be applied to the progress bar element.
`String`	`getRemainingClass()` Space-separated list of CSS style class(es) to be applied to the remaining part of the progress bar.
`Object`	`getRender()` IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
`String`	`getResource()`
`String`	`getStatus()` Name of the request status component that will indicate the status of the Ajax request
`String`	`getStyle()` CSS style(s) to be applied when this component is rendered.
`String`	`getStyleClass()` Space-separated list of CSS style class(es) to be applied when this element is rendered.
`Object`	`getValue()` Sets the current value of the progress
`boolean`	`isEnabled()` Enables/disables polling.
`boolean`	`isLimitRender()` If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
`boolean`	`isResetValues()` If true, indicate that this particular Ajax transaction is a value reset transaction.
`void`	`setData(Object data)`
`void`	`setEnabled(boolean enabled)`
`void`	`setExecute(Object execute)`
`void`	`setFinishClass(String finishClass)`
`void`	`setInitialClass(String initialClass)`
`void`	`setInterval(int interval)`
`void`	`setLabel(String label)`
`void`	`setLimitRender(boolean limitRender)`
`void`	`setMaxValue(Object maxValue)`
`void`	`setMinValue(Object minValue)`
`void`	`setMode(SwitchType mode)`
`void`	`setOnbeforedomupdate(String onbeforedomupdate)`
`void`	`setOnbegin(String onbegin)`
`void`	`setOnclick(String onclick)`
`void`	`setOncomplete(String oncomplete)`
`void`	`setOndblclick(String ondblclick)`
`void`	`setOnfinish(String onfinish)`
`void`	`setOnmousedown(String onmousedown)`
`void`	`setOnmousemove(String onmousemove)`
`void`	`setOnmouseout(String onmouseout)`
`void`	`setOnmouseover(String onmouseover)`
`void`	`setOnmouseup(String onmouseup)`
`void`	`setProgressClass(String progressClass)`
`void`	`setRemainingClass(String remainingClass)`
`void`	`setRender(Object render)`
`void`	`setResetValues(boolean resetValues)`
`void`	`setResource(String resource)`
`void`	`setStatus(String status)`
`void`	`setStyle(String style)`
`void`	`setStyleClass(String styleClass)`
`void`	`setValue(Object value)`

Methods inherited from class org.richfaces.component.AbstractProgressBar
encodeMetaComponent, resolveClientId, substituteUnresolvedClientId, visitTree

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors

Methods inherited from interface org.richfaces.component.MetaComponentEncoder
encodeMetaComponent

Methods inherited from interface org.richfaces.component.MetaComponentResolver
resolveClientId, substituteUnresolvedClientId

- Field Detail
  - COMPONENT_TYPE
```
public static final String COMPONENT_TYPE
```
    See Also:
    Constant Field Values
  - COMPONENT_FAMILY
```
public static final String COMPONENT_FAMILY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - UIProgressBar
```
public UIProgressBar()
```
- Method Detail
  - getFamily
```
public String getFamily()
```
    Specified by:
    
    getFamily in class javax.faces.component.UIComponent
  - getEventNames
```
public Collection<String> getEventNames()
```
    Specified by:
    
    getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getEventNames in class javax.faces.component.UIComponentBase
  - getDefaultEventName
```
public String getDefaultEventName()
```
    Specified by:
    
    getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class javax.faces.component.UIComponentBase
  - getData
```
public Object getData()
```
    Description copied from interface: AjaxActivatorProps
    
    Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
    
    Specified by:
    
    getData in interface AjaxActivatorProps
  - setData
```
public void setData(Object data)
```
    Specified by:
    
    setData in class AbstractProgressBar
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from class: AbstractProgressBar
    
    Enables/disables polling.
    
    Default value is "true".
    
    Specified by:
    
    isEnabled in class AbstractProgressBar
  - setEnabled
```
public void setEnabled(boolean enabled)
```
  - getExecute
```
public Object getExecute()
```
    Description copied from interface: AjaxProps
    
    IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of IDs, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
    
    Specified by:
    
    getExecute in interface AjaxProps
    
    Specified by:
    
    getExecute in class AbstractProgressBar
  - setExecute
```
public void setExecute(Object execute)
```
  - getFinishClass
```
public String getFinishClass()
```
    Description copied from class: AbstractProgressBar
    
    Space-separated list of CSS style class(es) to be applied when before progress finishes. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getFinishClass in class AbstractProgressBar
  - setFinishClass
```
public void setFinishClass(String finishClass)
```
  - getInitialClass
```
public String getInitialClass()
```
    Description copied from class: AbstractProgressBar
    
    Space-separated list of CSS style class(es) to be applied when before progress starts. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getInitialClass in class AbstractProgressBar
  - setInitialClass
```
public void setInitialClass(String initialClass)
```
  - getInterval
```
public int getInterval()
```
    Description copied from class: AbstractProgressBar
    
    Interval (in ms) for call poll requests.
    
    Default value 1000 ms (1 sec)
    
    Specified by:
    
    getInterval in class AbstractProgressBar
  - setInterval
```
public void setInterval(int interval)
```
  - getLabel
```
public String getLabel()
```
    Description copied from class: AbstractProgressBar
    
    Defines a simple label instead of rendering children component
    
    Specified by:
    
    getLabel in class AbstractProgressBar
  - setLabel
```
public void setLabel(String label)
```
  - isLimitRender
```
public boolean isLimitRender()
```
    Description copied from interface: AjaxActivatorProps
    
    If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
    
    Specified by:
    
    isLimitRender in interface AjaxActivatorProps
    
    Specified by:
    
    isLimitRender in class AbstractProgressBar
  - setLimitRender
```
public void setLimitRender(boolean limitRender)
```
  - getMaxValue
```
public Object getMaxValue()
```
    Description copied from class: AbstractProgressBar
    
    Max value, after which complete state should be rendered.
    
    Default value is "100".
    
    Specified by:
    
    getMaxValue in class AbstractProgressBar
  - setMaxValue
```
public void setMaxValue(Object maxValue)
```
  - getMinValue
```
public Object getMinValue()
```
    Description copied from class: AbstractProgressBar
    
    Min value when initial state should be rendered.
    
    Default value is "0".
    
    Specified by:
    
    getMinValue in class AbstractProgressBar
  - setMinValue
```
public void setMinValue(Object minValue)
```
  - getMode
```
public SwitchType getMode()
```
    Description copied from class: AbstractProgressBar
    
    The mode for updating the progress bar, can be one of:
    
    ajax
    
    The progress bar updates in the same way as the <a4j:poll> component. The <rich:progressBar> component repeatedly polls the server for the current progress value.
    
    client
    
    The progress bar must be explicitly updated on the client side through the JavaScript API.
    
    Default is "ajax"
    
    Specified by:
    
    getMode in class AbstractProgressBar
  - setMode
```
public void setMode(SwitchType mode)
```
  - getOnbeforedomupdate
```
public String getOnbeforedomupdate()
```
    Description copied from interface: AjaxActivatorProps
    
    The client-side script method to be called after the ajax response comes back, but before the DOM is updated
    
    Specified by:
    
    getOnbeforedomupdate in interface AjaxActivatorProps
  - setOnbeforedomupdate
```
public void setOnbeforedomupdate(String onbeforedomupdate)
```
  - getOnbegin
```
public String getOnbegin()
```
    Description copied from interface: AjaxProps
    
    The client-side script method to be called before an ajax request.
    
    Specified by:
    
    getOnbegin in interface AjaxProps
  - setOnbegin
```
public void setOnbegin(String onbegin)
```
  - getOnclick
```
public String getOnclick()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is clicked over this element.
    
    Specified by:
    
    getOnclick in interface EventsMouseProps
  - setOnclick
```
public void setOnclick(String onclick)
```
  - getOncomplete
```
public String getOncomplete()
```
    Description copied from interface: AjaxActivatorProps
    
    The client-side script method to be called after the DOM is updated
    
    Specified by:
    
    getOncomplete in interface AjaxActivatorProps
  - setOncomplete
```
public void setOncomplete(String oncomplete)
```
  - getOndblclick
```
public String getOndblclick()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is double clicked over this element.
    
    Specified by:
    
    getOndblclick in interface EventsMouseProps
  - setOndblclick
```
public void setOndblclick(String ondblclick)
```
  - getOnfinish
```
public String getOnfinish()
```
    Description copied from class: AbstractProgressBar
    
    The client-side script method to be called when progress is finished
    
    Specified by:
    
    getOnfinish in class AbstractProgressBar
  - setOnfinish
```
public void setOnfinish(String onfinish)
```
  - getOnmousedown
```
public String getOnmousedown()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is pressed down over this element.
    
    Specified by:
    
    getOnmousedown in interface EventsMouseProps
  - setOnmousedown
```
public void setOnmousedown(String onmousedown)
```
  - getOnmousemove
```
public String getOnmousemove()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved within this element.
    
    Specified by:
    
    getOnmousemove in interface EventsMouseProps
  - setOnmousemove
```
public void setOnmousemove(String onmousemove)
```
  - getOnmouseout
```
public String getOnmouseout()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved away from this element.
    
    Specified by:
    
    getOnmouseout in interface EventsMouseProps
  - setOnmouseout
```
public void setOnmouseout(String onmouseout)
```
  - getOnmouseover
```
public String getOnmouseover()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved onto this element.
    
    Specified by:
    
    getOnmouseover in interface EventsMouseProps
  - setOnmouseover
```
public void setOnmouseover(String onmouseover)
```
  - getOnmouseup
```
public String getOnmouseup()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is released over this element.
    
    Specified by:
    
    getOnmouseup in interface EventsMouseProps
  - setOnmouseup
```
public void setOnmouseup(String onmouseup)
```
  - getProgressClass
```
public String getProgressClass()
```
    Description copied from class: AbstractProgressBar
    
    Space-separated list of CSS style class(es) to be applied to the progress bar element. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getProgressClass in class AbstractProgressBar
  - setProgressClass
```
public void setProgressClass(String progressClass)
```
  - getRemainingClass
```
public String getRemainingClass()
```
    Description copied from class: AbstractProgressBar
    
    Space-separated list of CSS style class(es) to be applied to the remaining part of the progress bar. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getRemainingClass in class AbstractProgressBar
  - setRemainingClass
```
public void setRemainingClass(String remainingClass)
```
  - getRender
```
public Object getRender()
```
    Description copied from interface: AjaxActivatorProps
    
    IDs of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
    
    Specified by:
    
    getRender in interface AjaxActivatorProps
    
    Specified by:
    
    getRender in class AbstractProgressBar
  - setRender
```
public void setRender(Object render)
```
  - isResetValues
```
public boolean isResetValues()
```
    Description copied from interface: AjaxActivatorProps
    
    If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
    
    Specified by:
    
    isResetValues in interface AjaxActivatorProps
  - setResetValues
```
public void setResetValues(boolean resetValues)
```
  - getResource
```
public String getResource()
```
    Specified by:
    
    getResource in class AbstractProgressBar
  - setResource
```
public void setResource(String resource)
```
  - getStatus
```
public String getStatus()
```
    Description copied from interface: AjaxProps
    
    Name of the request status component that will indicate the status of the Ajax request
    
    Specified by:
    
    getStatus in interface AjaxProps
    
    Specified by:
    
    getStatus in class AbstractProgressBar
  - setStatus
```
public void setStatus(String status)
```
  - getStyle
```
public String getStyle()
```
    Description copied from interface: StyleProps
    
    CSS style(s) to be applied when this component is rendered.
    
    Specified by:
    
    getStyle in interface StyleProps
  - setStyle
```
public void setStyle(String style)
```
  - getStyleClass
```
public String getStyleClass()
```
    Description copied from interface: StyleClassProps
    
    Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getStyleClass in interface StyleClassProps
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
  - getValue
```
public Object getValue()
```
    Description copied from class: AbstractProgressBar
    
    Sets the current value of the progress
    
    Specified by:
    
    getValue in class AbstractProgressBar
  - setValue
```
public void setValue(Object value)
```

Class UIProgressBar

Nested Class Summary

Field Summary

Fields inherited from class org.richfaces.component.AbstractProgressBar

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface org.richfaces.component.MetaComponentResolver

Constructor Summary

Method Summary

Methods inherited from class org.richfaces.component.AbstractProgressBar

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

Methods inherited from interface org.richfaces.component.MetaComponentEncoder

Methods inherited from interface org.richfaces.component.MetaComponentResolver

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UIProgressBar

Method Detail

getFamily

getEventNames

getDefaultEventName

getData

setData

isEnabled

setEnabled

getExecute

setExecute

getFinishClass

setFinishClass

getInitialClass

setInitialClass

getInterval

setInterval

getLabel

setLabel

isLimitRender

setLimitRender

getMaxValue

setMaxValue

getMinValue

setMinValue

getMode

setMode

getOnbeforedomupdate

setOnbeforedomupdate

getOnbegin

setOnbegin

getOnclick

setOnclick

getOncomplete

setOncomplete

getOndblclick

setOndblclick

getOnfinish

setOnfinish

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getProgressClass

setProgressClass

getRemainingClass

setRemainingClass

getRender

setRender

isResetValues

setResetValues

getResource

setResource

getStatus

setStatus