<af:progressIndicator>

af:progressIndicator progressIndicator progress indicator

UIComponent class: oracle.adf.view.rich.component.rich.output.RichProgressIndicator
Component type: oracle.adf.RichProgressIndicator

The progressIndicator component can be used to give users an indication that there is a back end task in progress. A ProgressIndicator's state is tracked by the org.apache.myfaces.trinidad.model.BoundedRangeModel attached to this component through its 'value' attribute. The BoundedRangeModel provides a 'value' and a 'maximum' to the component. If either the 'value' or the 'maximum are negative numbers, the progressIndicator is in an indeterminate state and shows up as a spinner animation. If the 'value' is not negative (and the 'maximum' is negative), the progressIndicator is in a finished indeterminate state and shows up as a stopped spinner. When the 'value' and 'maximum' are non-negative values, the component switches to a determinate mode and renders a progress bar indicating percentage of task completion ('value' / 'maximum'). Each of these various states will show a hover description for that state Once the task is complete, if an 'action' has been assigned to the progressIndicator, then an ActionEvent is triggered.

The progressIndicator component can be used with a poll component from the page as a partial trigger, in order that it be updated at regular intervals in PPR mode as determined by the pollInterval from the poll component.

The following example explains the usage of progressIndicator Component.

  <af:progressIndicator id="progId" value="#{boundedRangeModel}" />
          

Events

Type Phases Description
javax.faces.event.ActionEvent Any Phase,
Invoke Application
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Attributes

Name Type Supports EL? Description
action javax.faces.el.MethodBinding Yes A reference to an action method sent by the progress component, or the static outcome of an action. This is invoked when the task under progress is complete.
actionListener javax.faces.el.MethodBinding Only EL A method reference to an action listener. This is invoked after the task in progress is complete.
attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding oracle.adf.view.rich.component.<wbr/>rich.output.RichProgressIndicator Only EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
clientComponent boolean Yes whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
customizationId String Yes This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediate boolean Yes whether data validation - client-side or server-side - will be skipped when events are generated by this component. When immediate is true, the command's action and ActionListeners, including the default ActionListener provided by the JavaServer Faces implementation, will be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase. Because validation runs during Process Validators (after Apply Request Values, but before Invoke Application), setting immediate to true will skip validation.
inlineStyle String Yes the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
partialTriggers String[] Yes the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
rendered boolean Yes whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client).
shortDesc String Yes the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.
styleClass String Yes a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
value Object Yes The data model being used by this progress component. The model should be of type org.apache.myfaces.trinidad.model.BoundedRangeModel.
visible boolean Yes the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core