org.richfaces.component

Class AbstractProgressBar

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.richfaces.component.AbstractProgressBar

All Implemented Interfaces:

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, AjaxActivatorProps, AjaxProps, EventsMouseProps, StyleClassProps, StyleProps, MetaComponentEncoder, MetaComponentResolver

Direct Known Subclasses:

UIProgressBar

public abstract class AbstractProgressBar
extends javax.faces.component.UIComponentBase
implements MetaComponentResolver, MetaComponentEncoder, AjaxProps, EventsMouseProps, StyleClassProps, StyleProps

The <rich:progressBar> component displays a progress bar to indicate the status of a process to the user. It can update either through Ajax or on the client side, and the look and feel can be fully customized.

Author:

"Andrey Markavtsov"

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY Component family
static String	COMPONENT_TYPE Component type
static String	STATE_META_COMPONENT_ID

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 org.richfaces.component.MetaComponentResolver

META_COMPONENT_SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
AbstractProgressBar()

Method Summary

Methods

Modifier and Type	Method and Description
void	encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId)
abstract Object	getExecute() IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
abstract String	getFinishClass() Space-separated list of CSS style class(es) to be applied when before progress finishes.
abstract String	getInitialClass() Space-separated list of CSS style class(es) to be applied when before progress starts.
abstract int	getInterval() Interval (in ms) for call poll requests.
abstract String	getLabel() Defines a simple label instead of rendering children component
abstract Object	getMaxValue() Max value, after which complete state should be rendered.
abstract Object	getMinValue() Min value when initial state should be rendered.
abstract SwitchType	getMode() The mode for updating the progress bar, can be one of:
abstract String	getOnfinish() The client-side script method to be called when progress is finished
abstract String	getProgressClass() Space-separated list of CSS style class(es) to be applied to the progress bar element.
abstract String	getRemainingClass() Space-separated list of CSS style class(es) to be applied to the remaining part of the progress bar.
abstract Object	getRender() IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
abstract String	getResource()
abstract String	getStatus() Name of the request status component that will indicate the status of the Ajax request
abstract Object	getValue() Sets the current value of the progress
abstract boolean	isEnabled() Enables/disables polling.
abstract boolean	isLimitRender() If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
String	resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId) Resolves and returns string identifying supported meta-component or null if provided meta-component name is not a supported one.
abstract void	setData(Object data)
String	substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId) Provides replacement for unresolved meta-component names.
boolean	visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)

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, getFamily, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.richfaces.component.attribute.AjaxProps

getOnbegin

Methods inherited from interface org.richfaces.component.attribute.AjaxActivatorProps

getData, getOnbeforedomupdate, getOncomplete

Methods inherited from interface org.richfaces.component.attribute.EventsMouseProps

getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup

Methods inherited from interface org.richfaces.component.attribute.StyleClassProps

getStyleClass

Methods inherited from interface org.richfaces.component.attribute.StyleProps

getStyle

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

Component type

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

Component family

See Also:

Constant Field Values

STATE_META_COMPONENT_ID

public static final String STATE_META_COMPONENT_ID

See Also:

Constant Field Values

Constructor Detail

AbstractProgressBar

public AbstractProgressBar()

Method Detail

getLabel

public abstract String getLabel()

Defines a simple label instead of rendering children component

setData

public abstract void setData(Object data)

getInterval

public abstract int getInterval()

Interval (in ms) for call poll requests.

Default value 1000 ms (1 sec)

isEnabled

public abstract boolean isEnabled()

Enables/disables polling.

Default value is "true".

getOnfinish

public abstract String getOnfinish()

The client-side script method to be called when progress is finished

getInitialClass

public abstract String getInitialClass()

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

getRemainingClass

public abstract String getRemainingClass()

Space-separated list of CSS style class(es) to be applied to the remaining part of the progress bar. This value must be passed through as the "class" attribute on generated markup.

getProgressClass

public abstract String getProgressClass()

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

getFinishClass

public abstract String getFinishClass()

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

getMode

public abstract SwitchType getMode()

The mode for updating the progress bar, can be one of:

ajax

The progress bar updates in the same way as the <a4j:poll> component. The <rich:progressBar> component repeatedly polls the server for the current progress value.

client

The progress bar must be explicitly updated on the client side through the JavaScript API.

Default is "ajax"

getMaxValue

public abstract Object getMaxValue()

Max value, after which complete state should be rendered.

Default value is "100".

getMinValue

public abstract Object getMinValue()

Min value when initial state should be rendered.

Default value is "0".

getValue

public abstract Object getValue()

Sets the current value of the progress

getResource

public abstract String getResource()

getExecute

public abstract Object getExecute()

Description copied from interface: AjaxProps

IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of IDs, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords

Specified by:

getExecute in interface AjaxProps

isLimitRender

public abstract boolean isLimitRender()

Description copied from interface: AjaxActivatorProps

If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels

Specified by:

isLimitRender in interface AjaxActivatorProps

getRender

public abstract Object getRender()

Description copied from interface: AjaxActivatorProps

IDs of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords

Specified by:

getRender in interface AjaxActivatorProps

getStatus

public abstract String getStatus()

Description copied from interface: AjaxProps

Name of the request status component that will indicate the status of the Ajax request

Specified by:

getStatus in interface AjaxProps

encodeMetaComponent

public void encodeMetaComponent(javax.faces.context.FacesContext context,
                       String metaComponentId)
                         throws IOException

Specified by:

encodeMetaComponent in interface MetaComponentEncoder

Throws:

IOException

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIComponent

resolveClientId

public String resolveClientId(javax.faces.context.FacesContext facesContext,
                     javax.faces.component.UIComponent contextComponent,
                     String metaComponentId)

Description copied from interface: MetaComponentResolver

Resolves and returns string identifying supported meta-component or null if provided meta-component name is not a supported one.

Specified by:

resolveClientId in interface MetaComponentResolver

Parameters:

facesContext - - current instance of FacesContext

contextComponent - - instance of UIComponent that requested resolution of meta-component

metaComponentId - - name of meta-component (without leading '@' sign)

Returns:

clientId, one of supported meta-names such as @all, @this, etc. or null

substituteUnresolvedClientId

public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
                                  javax.faces.component.UIComponent contextComponent,
                                  String metaComponentId)

Description copied from interface: MetaComponentResolver

Provides replacement for unresolved meta-component names. Returns identifier string for the chosen substitution or null

Specified by:

substituteUnresolvedClientId in interface MetaComponentResolver

Parameters:

facesContext - - current instance of FacesContext

contextComponent - - instance of UIComponent that requested resolution of meta-component

metaComponentId - - name of meta-component (without leading '@' sign)

Returns:

clientId, one of supported meta-names such as @all, @this, etc. or null