progressBar (VDL Documentation Generator - Generated Documentation)

Toggle Sidebar

Description:
ProgressBar is a UIComponent that displays a progress bar and can operate as a server-side or client-side progress indicator.

This component includes a client-side JavaScript API which can be accessed using the clientKey attribute and the Liferay.component() method:
- set() - The set() method can be used to set the client-side value of the component e.g. Liferay.component('progressBar').set('value', value);.
- start() - The start() method starts polling the server for the value of the component.
- stop() - The stop() method stops the component's polling of the server.

Since:

3.2.5-ga6

Component Information
Info	Value
Component Type	`com.liferay.faces.alloy.component.progressbar.ProgressBar`
Handler Class	None
Renderer Type	`com.liferay.faces.alloy.component.progressbar.ProgressBarRenderer`
Description	None

Attributes
Name	Required	Type	Description
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An EL expression that binds the Java reference to this component in the component tree to a bean property.
`clientKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The key name that can be used to reference the component on the client.
`height`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The the height (in pixels) of the progress bar.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A unique identifier for this component.
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The label which appears on the progress bar. The `{0}` token can be used to include the value in the label.
`layout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The direction in which the layout of the component should be displayed. Valid values include `lineDirection` (the default) and `pageDirection`.
`maxProgress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The maximum value that the progress bar can have. Defaults to 100.
`minProgress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The minimum value that the progress bar can have. Defaults to 0.
`oncomplete`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client-side javascript to be executed when progress has completed.
`pollingDelay`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The delay (in milliseconds) before dispatching a polling Ajax request after recieving the response of a previous request. Defaults to 3000.
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value of this attribute is true.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the css style of the element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The value of this component, which is typically bound via EL to a model bean property. Defaults to 0.
`width`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The the width (in pixels) of the progress bar.

alloy

Tag progressBar