ICE Components
Tag outputProgress


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.


Tag Information
Tag Classcom.icesoft.faces.component.outputprogress.OutputProgressTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.StringThe value binding expression linking this component to a property in a backing bean
idfalsefalsejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
indeterminatefalsefalsejava.lang.StringWhen true percent numbers are hidden for an unknown task duration.
labelfalsefalsejava.lang.StringThe default label is the percentage value. The default can be overridden by defining the label attribute.
labelCompletefalsefalsejava.lang.StringThe label to be displayed on completion of process. Could be used with label attribute. The default value is Done.
labelPositionfalsefalsejava.lang.StringPercentage text could be set to different positions. Valid values are |left | right | top | topcenter | topright | bottom | bottomcenter | bottomright | embed |
renderedfalsefalsejava.lang.StringFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
renderedOnUserRolefalsefalsejava.lang.StringIf 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.
stylefalsefalsejava.lang.StringCSS style(s) to be applied when this component is rendered.
styleClassfalsefalsejava.lang.String

Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Defines the base class name for all style classes used. Default value is iceOutProg

  • iceOutProg
  • iceOutProgBg
  • iceOutProgTxt
The main div which shows progress bar renderes out different style classes depending on the mode:

Standard Mode:
  • iceOutProgFill
Indeterminate Mode:
  • iceOutProgIndetActv (during the progress)
  • iceOutProgIndetInactv (progress finished)

valuefalsefalsejava.lang.String

The percentage progress that should be depicted to the user, from 0 to 100 inclusive. When indeterminate="true", 0 and 100 denote inactivity, and values between denote activity.


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.