public abstract class AbstractProgressBar extends javax.faces.component.UIComponentBase implements MetaComponentResolver, MetaComponentEncoder, EventsMouseProps
The <r: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.
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY
Component family
|
static String |
COMPONENT_TYPE
Component type
|
static String |
STATE_META_COMPONENT_ID |
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
META_COMPONENT_SEPARATOR_CHAR
Constructor and Description |
---|
AbstractProgressBar() |
Modifier and Type | Method and Description |
---|---|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId) |
abstract Object |
getData()
Serialized (on default with JSON) data passed on the client by a developer on AJAX request.
|
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 |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
abstract String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
abstract String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
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 String |
getResource() |
abstract String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
abstract String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
abstract Object |
getValue()
Sets the current value of the progress
|
abstract boolean |
isEnabled()
Enables/disables polling.
|
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) |
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
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String STATE_META_COMPONENT_ID
public abstract String getOnbegin()
public abstract String getLabel()
public abstract Object getData()
public abstract void setData(Object data)
public abstract int getInterval()
Interval (in ms) for call poll requests.
Default value 1000 ms (1 sec)
public abstract boolean isEnabled()
Enables/disables polling.
Default value is "true".
public abstract String getOnbeforedomupdate()
public abstract String getOncomplete()
public abstract String getOnfinish()
public abstract String getInitialClass()
public abstract String getRemainingClass()
public abstract String getProgressClass()
public abstract String getFinishClass()
public abstract SwitchType getMode()
The mode for updating the progress bar, can be one of:
Default is "ajax"
public abstract Object getMaxValue()
Max value, after which complete state should be rendered.
Default value is "100".
public abstract Object getMinValue()
Min value when initial state should be rendered.
Default value is "0".
public abstract Object getValue()
public abstract String getResource()
public abstract String getStyle()
public abstract String getStyleClass()
public void encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId) throws IOException
encodeMetaComponent
in interface MetaComponentEncoder
IOException
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
visitTree
in class javax.faces.component.UIComponent
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolver
null
if provided meta-component name is
not a supported one.resolveClientId
in interface MetaComponentResolver
facesContext
- - current instance of FacesContext
contextComponent
- - instance of UIComponent
that requested resolution of meta-componentmetaComponentId
- - name of meta-component (without leading '@' sign)null
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolver
null
substituteUnresolvedClientId
in interface MetaComponentResolver
facesContext
- - current instance of FacesContext
contextComponent
- - instance of UIComponent
that requested resolution of meta-componentmetaComponentId
- - name of meta-component (without leading '@' sign)null
Copyright © 2014 JBoss by Red Hat. All rights reserved.