ProgressBar

You are viewing an old version (v. 12) of this page.
The latest version is v. 27, last edited on Dec 11, 2014 (view differences | )
<< 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.

Usage

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();" ... />

Client polling server:

        <ace:progressBar widgetVar="#{upload.widgetVarName}" usePolling="true" pollingInterval="2000" value="#{upload.progressValue}" ... />
        ...
        <h:commandButton onclick="#{upload.widgetVarName}.start();" ... />

Component 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.

JavaScript APIs / Client Behaviours

The client side progress bar object is exposed through the global variable name specified in 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 Usage above for examples.

Keyboard and ARIA Support

Known Issues

Other Resources

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

© Copyright 2017 ICEsoft Technologies Canada Corp.