Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces
Tag progressBar

The <rich:progressBar> component is designed for displaying a progress bar which shows the current status of the process.

Tag Information
Tag Class | org.richfaces.taglib.ProgressBarTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
actionListener | false | false | `javax.el.MethodExpression` (signature must match `void actionListener(javax.faces.event.ActionEvent)`) | MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSingle | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
binding | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`) | The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdates | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
completeClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component progress line rendering
data | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
enabled | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Enables/disables polling. Default value is "true".
eventsQueue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
finishClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the progress bar complete state
focus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID of an element to set focus after request is completed on client side
id | false | false | `java.lang.String` | Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now
immediate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase
initialClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the progress bar initial state
interval | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Interval (in ms) for call poll requests. Default value 1000 ms (1 sec)
label | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Attribute defines a simple label instead of rendering children component
limitToList | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
maxValue | false | 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 | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Min value when initial state should be rendered. Default value is "0".
mode | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Attributes defines AJAX or CLIENT modes for component. Possible values are "ajax", "client". Default value is "ajax".
onbeforedomupdate | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called before DOM is updated
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element is clicked
oncomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called after the request is completed
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element is double-clicked
onmousedown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a mouse button is pressed down over the element
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved within the element
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved away from the element
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved onto the element
onmouseup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a mouse button is released
onsubmit | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called before an ajax request is submitted
parameters | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Parameters for macrosubstitution in the label
process | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
progressVar | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | DEPRECATED. Provides access to value of the component on the client
reRender | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
reRenderAfterComplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Set of componets to rerender after completion
remainClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the remained part of the progress bar
rendered | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
similarityGroupingId | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | If there are any component requests with identical IDs then these requests will be grouped.
status | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID (in format of call UIComponent.findComponent()) of Request status component
style | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style rules to be applied to the component
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component. Corresponds to the HTML "class" attribute.
timeout | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Response waiting time on a particular request. If a response is not received during this time, the request is aborted
title | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Advisory title information about markup elements generated for this component
value | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Sets the current value of the progress

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.