Package com.webmethods.caf.faces.component.panel

Class ProgressBar

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

com.webmethods.caf.faces.component.panel.BaseHideablePanel

com.webmethods.caf.faces.component.panel.ProgressBar

All Implemented Interfaces:

IHideablePanel, ILazyHideablePanel, ITableRowStateHolder, Serializable, EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class ProgressBar
extends BaseHideablePanel

Control that displays a progress indicator.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Fields inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

ATTR_CENTER, ATTR_DEFAULT_COMMAND, ATTR_DEFAULT_FOCUS, ATTR_DISABLE_WHEN_HIDDEN, ATTR_HIDE_EFFECT, ATTR_HIDE_EFFECT_OPTIONS, ATTR_OPACITY, ATTR_PROGRESS_DELAY, ATTR_PROGRESS_FLASH_ON_COMPLETE, ATTR_PROGRESS_MSG, ATTR_PROGRESS_USE_HIDE_SHOW_EFFECT, ATTR_SHOW_EFFECT, ATTR_SHOW_EFFECT_OPTIONS, m_savedSuppressed, m_savedVisible

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY, COMPONENT_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

Constructor Summary

Constructors

Constructor	Description
ProgressBar()

Method Summary

Modifier and Type	Method	Description
Integer	getPercentComplete()	Return the percent complete as a number between 0 and 100.
Boolean	getShowWorkMessage()	Returns whether the work message should be displayed.
String	getWorkMessage()	Return the progress work message
void	setPercentComplete(Integer percentComplete)	Set the percent complete as a number between 0 and 100.
void	setShowWorkMessage(Boolean showWorkMessage)	Sets whether the work message should be displayed.
void	setWorkMessage(String workMessage)	Set the progress work message

Methods inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

decode, encodeBegin, encodeChildren, encodeEnd, findSuppressed, getRendersChildren, getSuppressInputs, getTableRowState, isAncestorOrSelf, isDisableWhenHidden, isLazy, isRefreshOnShow, isTwoPass, isVisible, processDecodes, processUpdates, processValidators, setDisableWhenHidden, setLazy, setRefreshOnShow, setSuppressInputs, setTableRowState, setTwoPass, setVisible

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

ProgressBar

public ProgressBar()

Method Details

getPercentComplete

public Integer getPercentComplete()

Return the percent complete as a number between 0 and 100.

Returns:

the percentComplete

setPercentComplete

public void setPercentComplete(Integer percentComplete)

Set the percent complete as a number between 0 and 100.

Parameters:

percentComplete - the percentComplete to set

getWorkMessage

public String getWorkMessage()

Return the progress work message

Returns:

the workMessage

setWorkMessage

public void setWorkMessage(String workMessage)

Set the progress work message

Parameters:

workMessage - the workMessage to set

getShowWorkMessage

public Boolean getShowWorkMessage()

Returns whether the work message should be displayed.

Returns:

the showWorkMessage

setShowWorkMessage

public void setShowWorkMessage(Boolean showWorkMessage)

Sets whether the work message should be displayed.

Parameters:

showWorkMessage - the showWorkMessage to set