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`) | boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only
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`) | CSS class that defines style for 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`) | CSS class that defines style for complete state of the component
focus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | id of element to set focus after request 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`) | CSS class that defines style for initial state of the component
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", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components
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 "client".
onbeforedomupdate | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call before DOM has been updated on client side
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is clicked
oncomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call after request completed on client side
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is double-clicked
onkeydown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed down
onkeypress | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed and released
onkeyup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is released
onmousedown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is pressed down
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved within
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved away
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved onto
onmouseup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is released
onsubmit | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call before submission of ajax event
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`) | 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`) | CSS class that defines style for remained part of progress bar
rendered | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
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(s) is/are to be applied when this component is rendered
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS class that defines style for progress bar
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.