The outputProgress component can be used to report progress to users in cases where a
long running server-side task is necessary. This component can be run in either of two modes;
"determinate" and "indeterminate".
Determinate mode should be used in cases where the number of steps or units of work in a long-running
process are known. In determinate mode (default) the outputProgress component renders a progress bar
that indicates the completion percentage for a task. Typically, the progress bar will gradually progress
from 0 to 100 % complete in incremental steps determined by the application.
Indeterminate mode should be used in cases when it is not possible to predicate how long a long-running
process will take to complete, or how many steps or units of work are required to complete the task.
In indeterminate mode the outputProgress component renders an animated icon or progress bar that
indicates generally that activity is taking place.
| Attributes |
| Name | Required | Request-time | Type | Description |
| id | false | false | java.lang.String | Every component may have an unique id. Automatically created if omitted. |
| indeterminate | false | false | java.lang.String | When true percent numbers are hidden for an unknown task duration. |
| rendered | false | false | java.lang.String | If false, this component will not be rendered. |
| binding | false | false | java.lang.String | Component binding. |
| value | false | false | java.lang.String | Binding to an application bean method that returns an int percentage value. |
| label | false | false | java.lang.String |
The default label is the percentage value. The default can be
overridden by defining the label attribute.
|
| labelComplete | false | false | java.lang.String |
The label to be displayed on completion of process. Could be used
with label attribute. The default value is Done.
|
| labelPosition | false | false | java.lang.String | Percentage text could be set to different positions. Valid values are |left | right | top | topcenter | topright | bottom | bottomcenter | bottomright | embed | |
| styleClass | false | false | java.lang.String |
Defines the base class name for all style classes used in outputConnectionStatus. Default value is iceOutputProgress
- iceOutputProgressIndeterminateActiveClass
- iceOutputProgressIndeterminateInactiveClass
- iceOutputProgressText
- iceOutputProgressBackground
- iceOutputProgressFill
|
| style | false | false | java.lang.String |
CSS style(s) to be applied when this component is rendered.
|
| renderedOnUserRole | false | false | java.lang.String |
If user is in given role, this component will be rendered normally. If not, nothing is
rendered and the body of this tag will be skipped.
|