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"Info | Value |
---|---|
Component Type | org.richfaces.ProgressBar |
Handler Class | None |
Renderer Type | org.richfaces.ProgressBarRenderer |
Description | 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" |
Name | Required | Type | Description |
---|---|---|---|
binding |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent )
| The value binding expression used to wire up this component to a component property of a JavaBean class |
data |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| 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 |
enabled |
false
| javax.el.ValueExpression
(must evaluate to boolean )
| Enables/disables polling. Default value is "true". |
finishClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| 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. |
id |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
initialClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| 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. |
interval |
false
| javax.el.ValueExpression
(must evaluate to int )
| Interval (in ms) for call poll requests. Default value 1000 ms (1 sec) |
label |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Defines a simple label instead of rendering children component |
maxValue |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| Max value, after which complete state should be rendered. Default value is "100". |
minValue |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| Min value when initial state should be rendered. Default value is "0". |
mode |
false
| javax.el.ValueExpression
(must evaluate to org.richfaces.component.SwitchType )
| The mode for updating the progress bar, can be one of:
Default is "ajax" |
onbeforedomupdate |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called after the ajax response comes back, but before the DOM is updated |
onbegin |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called before an ajax request. |
onclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is clicked over this element. |
oncomplete |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called after the DOM is updated |
ondblclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is double clicked over this element. |
onfinish |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called when progress is finished |
onmousedown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is moved within this element. |
onmouseout |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is released over this element. |
progressClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| 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. |
remainingClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| 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. |
rendered |
false
| javax.el.ValueExpression
(must evaluate to boolean )
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
style |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| CSS style(s) to be applied when this component is rendered. |
styleClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| 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. |
value |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| Sets the current value of the progress |
Output generated by Vdldoc View Declaration Language Documentation Generator.