RichFaces ( Legacy URL )
Tag progressBar


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


Tag Information
Tag Classorg.richfaces.taglib.ProgressBarTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
actionListenerfalsefalsejavax.el.MethodExpression
(signature must match void actionListener(javax.faces.event.ActionEvent))
MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSinglefalsefalsejavax.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".
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdatesfalsefalsejavax.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
completeClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component progress line rendering
datafalsefalsejavax.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
enabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Enables/disables polling. Default value is "true".
eventsQueuefalsefalsejavax.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.)
finishClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the progress bar complete state
focusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID of an element to set focus after request is completed on client side
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
ignoreDupResponsesfalsefalsejavax.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
immediatefalsefalsejavax.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
initialClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the progress bar initial state
intervalfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Interval (in ms) for call poll requests. Default value 1000 ms (1 sec)
labelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Attribute defines a simple label instead of rendering children component
limitToListfalsefalsejavax.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.
maxValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Max value, after which complete state should be rendered. Default value is "100".
minValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Min value when initial state should be rendered. Default value is "0".
modefalsefalsejavax.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".
onbeforedomupdatefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before DOM is updated
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is clicked
oncompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after the request is completed
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is double-clicked
onmousedownfalsefalsejavax.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
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved within the element
onmouseoutfalsefalsejavax.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
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the element
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a mouse button is released
onsubmitfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before an ajax request is submitted
parametersfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Parameters for macrosubstitution in the label
processfalsefalsejavax.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
progressVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
DEPRECATED. Provides access to value of the component on the client
reRenderfalsefalsejavax.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
reRenderAfterCompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Set of componets to rerender after completion
remainClassfalsefalsejavax.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
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
similarityGroupingIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
If there are any component requests with identical IDs then these requests will be grouped.
statusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID (in format of call UIComponent.findComponent()) of Request status component
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the component
styleClassfalsefalsejavax.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.
timeoutfalsefalsejavax.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
titlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Advisory title information about markup elements generated for this component
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Sets the current value of the progress

Variables
No Variables Defined.


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.