@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIProgressBar extends AbstractProgressBar implements javax.faces.component.behavior.ClientBehaviorHolder, MetaComponentEncoder, MetaComponentResolver, 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.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UIProgressBar.Properties |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
STATE_META_COMPONENT_IDATTRS_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_KEYMETA_COMPONENT_SEPARATOR_CHAR| Constructor and Description |
|---|
UIProgressBar() |
| Modifier and Type | Method and Description |
|---|---|
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
String |
getFinishClass()
Space-separated list of CSS style class(es) to be applied when before progress finishes.
|
String |
getInitialClass()
Space-separated list of CSS style class(es) to be applied when before progress starts.
|
int |
getInterval()
Interval (in ms) for call poll requests.
|
String |
getLabel()
Defines a simple label instead of rendering children component
|
Object |
getMaxValue()
Max value, after which complete state should be rendered.
|
Object |
getMinValue()
Min value when initial state should be rendered.
|
SwitchType |
getMode()
The mode for updating the progress bar, can be one of:
|
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnfinish()
The client-side script method to be called when progress is finished
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getProgressClass()
Space-separated list of CSS style class(es) to be applied to the progress bar element.
|
String |
getRemainingClass()
Space-separated list of CSS style class(es) to be applied to the remaining part of the progress bar.
|
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
String |
getResource() |
String |
getStatus()
Name of the request status component that will indicate the status of the Ajax request
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
Object |
getValue()
Sets the current value of the progress
|
boolean |
isEnabled()
Enables/disables polling.
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
void |
setData(Object data) |
void |
setEnabled(boolean enabled) |
void |
setExecute(Object execute) |
void |
setFinishClass(String finishClass) |
void |
setInitialClass(String initialClass) |
void |
setInterval(int interval) |
void |
setLabel(String label) |
void |
setLimitRender(boolean limitRender) |
void |
setMaxValue(Object maxValue) |
void |
setMinValue(Object minValue) |
void |
setMode(SwitchType mode) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbegin(String onbegin) |
void |
setOnclick(String onclick) |
void |
setOncomplete(String oncomplete) |
void |
setOndblclick(String ondblclick) |
void |
setOnfinish(String onfinish) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setProgressClass(String progressClass) |
void |
setRemainingClass(String remainingClass) |
void |
setRender(Object render) |
void |
setResource(String resource) |
void |
setStatus(String status) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setValue(Object value) |
encodeMetaComponent, resolveClientId, substituteUnresolvedClientId, visitTreeaddClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpressionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviorsencodeMetaComponentresolveClientId, substituteUnresolvedClientIdpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UIComponentpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic Object getData()
AjaxPropspublic void setData(Object data)
setData in class AbstractProgressBarpublic boolean isEnabled()
AbstractProgressBarEnables/disables polling.
Default value is "true".
isEnabled in class AbstractProgressBarpublic void setEnabled(boolean enabled)
public Object getExecute()
AjaxPropsgetExecute in interface AjaxPropsgetExecute in class AbstractProgressBarpublic void setExecute(Object execute)
public String getFinishClass()
AbstractProgressBargetFinishClass in class AbstractProgressBarpublic void setFinishClass(String finishClass)
public String getInitialClass()
AbstractProgressBargetInitialClass in class AbstractProgressBarpublic void setInitialClass(String initialClass)
public int getInterval()
AbstractProgressBarInterval (in ms) for call poll requests.
Default value 1000 ms (1 sec)
getInterval in class AbstractProgressBarpublic void setInterval(int interval)
public String getLabel()
AbstractProgressBargetLabel in class AbstractProgressBarpublic void setLabel(String label)
public boolean isLimitRender()
AjaxPropsisLimitRender in interface AjaxPropsisLimitRender in class AbstractProgressBarpublic void setLimitRender(boolean limitRender)
public Object getMaxValue()
AbstractProgressBarMax value, after which complete state should be rendered.
Default value is "100".
getMaxValue in class AbstractProgressBarpublic void setMaxValue(Object maxValue)
public Object getMinValue()
AbstractProgressBarMin value when initial state should be rendered.
Default value is "0".
getMinValue in class AbstractProgressBarpublic void setMinValue(Object minValue)
public SwitchType getMode()
AbstractProgressBarThe mode for updating the progress bar, can be one of:
Default is "ajax"
getMode in class AbstractProgressBarpublic void setMode(SwitchType mode)
public String getOnbeforedomupdate()
AjaxPropsgetOnbeforedomupdate in interface AjaxPropspublic void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
AjaxPropsgetOnbegin in interface AjaxPropspublic void setOnbegin(String onbegin)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOncomplete()
AjaxPropsgetOncomplete in interface AjaxPropspublic void setOncomplete(String oncomplete)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnfinish()
AbstractProgressBargetOnfinish in class AbstractProgressBarpublic void setOnfinish(String onfinish)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getProgressClass()
AbstractProgressBargetProgressClass in class AbstractProgressBarpublic void setProgressClass(String progressClass)
public String getRemainingClass()
AbstractProgressBargetRemainingClass in class AbstractProgressBarpublic void setRemainingClass(String remainingClass)
public Object getRender()
AjaxPropsgetRender in interface AjaxPropsgetRender in class AbstractProgressBarpublic void setRender(Object render)
public String getResource()
getResource in class AbstractProgressBarpublic void setResource(String resource)
public String getStatus()
AjaxPropsgetStatus in interface AjaxPropsgetStatus in class AbstractProgressBarpublic void setStatus(String status)
public String getStyle()
StylePropsgetStyle in interface StylePropspublic void setStyle(String style)
public String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic void setStyleClass(String styleClass)
public Object getValue()
AbstractProgressBargetValue in class AbstractProgressBarpublic void setValue(Object value)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.