com.liferay.faces.alloy.component.progressbar

Class ProgressBarBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

com.liferay.faces.alloy.component.progressbar.ProgressBarBase

All Implemented Interfaces:

com.liferay.faces.util.component.ClientComponent, com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

ProgressBar

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class ProgressBarBase
extends javax.faces.component.UIComponentBase
implements com.liferay.faces.util.component.Styleable, com.liferay.faces.util.component.ClientComponent

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ProgressBarBase.ProgressBarPropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface com.liferay.faces.util.component.ClientComponent

CLIENT_KEY

Constructor Summary

Constructors

Constructor and Description
ProgressBarBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientKey() clientKey attribute description: The key name that can be used to reference the component on the client.
String	getFamily()
String	getHeight() height attribute description: The the height (in pixels) of the progress bar.
String	getLabel() label attribute description: The label which appears on the progress bar.
String	getLayout() layout attribute description: The direction in which the layout of the component should be displayed.
Integer	getMaxProgress() maxProgress attribute description: The maximum value that the progress bar can have.
Integer	getMinProgress() minProgress attribute description: The minimum value that the progress bar can have.
String	getOncomplete() oncomplete attribute description: Client-side javascript to be executed when progress has completed.
Integer	getPollingDelay() pollingDelay attribute description: The delay (in milliseconds) before dispatching a polling Ajax request after recieving the response of a previous request.
String	getStyle() style attribute description: HTML passthrough attribute specifying the css style of the element.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
Integer	getValue() value attribute description: The value of this component, which is typically bound via EL to a model bean property.
String	getWidth() width attribute description: The the width (in pixels) of the progress bar.
void	setClientKey(String clientKey) clientKey attribute description: The key name that can be used to reference the component on the client.
void	setHeight(String height) height attribute description: The the height (in pixels) of the progress bar.
void	setLabel(String label) label attribute description: The label which appears on the progress bar.
void	setLayout(String layout) layout attribute description: The direction in which the layout of the component should be displayed.
void	setMaxProgress(Integer maxProgress) maxProgress attribute description: The maximum value that the progress bar can have.
void	setMinProgress(Integer minProgress) minProgress attribute description: The minimum value that the progress bar can have.
void	setOncomplete(String oncomplete) oncomplete attribute description: Client-side javascript to be executed when progress has completed.
void	setPollingDelay(Integer pollingDelay) pollingDelay attribute description: The delay (in milliseconds) before dispatching a polling Ajax request after recieving the response of a previous request.
void	setStyle(String style) style attribute description: HTML passthrough attribute specifying the css style of the element.
void	setStyleClass(String styleClass) styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
void	setValue(Integer value) value attribute description: The value of this component, which is typically bound via EL to a model bean property.
void	setWidth(String width) width attribute description: The the width (in pixels) of the progress bar.

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.faces.util.component.ClientComponent

getClientId

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

ProgressBarBase

public ProgressBarBase()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getClientKey

public String getClientKey()

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

getClientKey in interface com.liferay.faces.util.component.ClientComponent

setClientKey

public void setClientKey(String clientKey)

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

setClientKey in interface com.liferay.faces.util.component.ClientComponent

getHeight

public String getHeight()

height attribute description:

The the height (in pixels) of the progress bar.

setHeight

public void setHeight(String height)

height attribute description:

The the height (in pixels) of the progress bar.

getLabel

public String getLabel()

label attribute description:

The label which appears on the progress bar. The {0} token can be used to include the value in the label.

setLabel

public void setLabel(String label)

label attribute description:

The label which appears on the progress bar. The {0} token can be used to include the value in the label.

getLayout

public String getLayout()

layout attribute description:

The direction in which the layout of the component should be displayed. Valid values include lineDirection (the default) and pageDirection.

setLayout

public void setLayout(String layout)

layout attribute description:

The direction in which the layout of the component should be displayed. Valid values include lineDirection (the default) and pageDirection.

getMaxProgress

public Integer getMaxProgress()

maxProgress attribute description:

The maximum value that the progress bar can have. The default value is 100.

setMaxProgress

public void setMaxProgress(Integer maxProgress)

maxProgress attribute description:

The maximum value that the progress bar can have. The default value is 100.

getMinProgress

public Integer getMinProgress()

minProgress attribute description:

The minimum value that the progress bar can have. The default value is 0.

setMinProgress

public void setMinProgress(Integer minProgress)

minProgress attribute description:

The minimum value that the progress bar can have. The default value is 0.

getOncomplete

public String getOncomplete()

oncomplete attribute description:

Client-side javascript to be executed when progress has completed.

setOncomplete

public void setOncomplete(String oncomplete)

oncomplete attribute description:

Client-side javascript to be executed when progress has completed.

getPollingDelay

public Integer getPollingDelay()

pollingDelay attribute description:

The delay (in milliseconds) before dispatching a polling Ajax request after recieving the response of a previous request.

setPollingDelay

public void setPollingDelay(Integer pollingDelay)

pollingDelay attribute description:

The delay (in milliseconds) before dispatching a polling Ajax request after recieving the response of a previous request.

getStyle

public String getStyle()

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

getStyle in interface com.liferay.faces.util.component.Styleable

setStyle

public void setStyle(String style)

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

setStyle in interface com.liferay.faces.util.component.Styleable

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

setStyleClass

public void setStyleClass(String styleClass)

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

setStyleClass in interface com.liferay.faces.util.component.Styleable

getValue

public Integer getValue()

value attribute description:

The value of this component, which is typically bound via EL to a model bean property.

setValue

public void setValue(Integer value)

value attribute description:

The value of this component, which is typically bound via EL to a model bean property.

getWidth

public String getWidth()

width attribute description:

The the width (in pixels) of the progress bar.

setWidth

public void setWidth(String width)

width attribute description:

The the width (in pixels) of the progress bar.