You are viewing an old version (v. 19) of this page.
<< View previous version | view page history | view next version >>
Overview
Progress bar is a progress indicator that can work on the client side by itself or gets its progress update from the server using ajax.
Getting Started
Client side only:
<script type="text/javascript"> function begin() { this.progressInterval = setInterval ( function() { clientSideBar.setValue(clientSideBar.getValue() + 10); } , 2000); } function stop() { clearInterval(this.progressInterval); clientSideBar.setValue(0); } </script> ... <ace:panel> <ace:progressBar widgetVar="clientSideBar" /> </ace:panel> ... <h:commandButton onclick="begin();" ... /> <h:commandButton onclick="stop();" ... />
<ace:progressBar widgetVar="#{upload.widgetVarName}" usePolling="true" pollingInterval="2000" value="#{upload.progressValue}" ... /> ... <h:commandButton onclick="#{upload.widgetVarName}.start();" ... />
Attributes
 | TagLib Documentation This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available here. |
usePolling specifies the mode of progressBar, in polling mode progress value is retrieved periodically from a backing bean.
cancelListener, changeListener, completeListener are the listeners for the different stages of the progress. In the change event you can get the value and percentage of the progress bar.
pollingInterval is time between polls to the server in milliseconds.
Event Listeners
| changeListener | Listener to be invoked when the value of the progressbar changes. |
| completeListener | Listener to be invoked when the value of the progressbar reaches the maximum value. |
| cancelListener | Listener to be invoked when the progress process is cancelled by calling cancel(). |
Client Behavior Events
| complete | Fired when the value of the progressbar reaches the maximum value (default event). |
| cancel | Fired when the progress process is cancelled by calling cancel(). |
| change | Fired when the value of the progressbar changes. |
JavaScript API
The client side progress bar object is exposed through the global variable named by the widgetVar attribute. You can use the getValue() and setValue() methods to read and change the value. Use the start() and cancel() methods for polling. See Getting Started above for examples.