|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.AbstractProgressBar
org.richfaces.component.UIProgressBar
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIProgressBar
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.
| Nested Class Summary | |
|---|---|
protected static class |
UIProgressBar.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class org.richfaces.component.AbstractProgressBar |
|---|
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 | |
|---|---|
UIProgressBar()
|
|
| Method Summary | |
|---|---|
Object |
getData()
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
String |
getDefaultEventName()
|
Collection<String> |
getEventNames()
|
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. |
org.richfaces.component.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()
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated |
String |
getOndblclick()
|
String |
getOnfinish()
The client-side script method to be called when progress is finished |
String |
getOnmousedown()
|
String |
getOnmousemove()
|
String |
getOnmouseout()
|
String |
getOnmouseover()
|
String |
getOnmouseup()
|
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. |
String |
getResource()
|
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. |
void |
setData(Object data)
|
void |
setEnabled(boolean enabled)
|
void |
setFinishClass(String finishClass)
|
void |
setInitialClass(String initialClass)
|
void |
setInterval(int interval)
|
void |
setLabel(String label)
|
void |
setMaxValue(Object maxValue)
|
void |
setMinValue(Object minValue)
|
void |
setMode(org.richfaces.component.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 |
setResource(String resource)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setValue(Object value)
|
| Methods inherited from class org.richfaces.component.AbstractProgressBar |
|---|
encodeMetaComponent, resolveClientId, substituteUnresolvedClientId, visitTree |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, 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 javax.faces.component.behavior.ClientBehaviorHolder |
|---|
addClientBehavior, getClientBehaviors |
| Methods inherited from interface org.richfaces.component.MetaComponentEncoder |
|---|
encodeMetaComponent |
| Methods inherited from interface org.richfaces.component.MetaComponentResolver |
|---|
resolveClientId, substituteUnresolvedClientId |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIProgressBar()
| Method Detail |
|---|
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()
AbstractProgressBar
getData in class AbstractProgressBarpublic 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 String getFinishClass()
AbstractProgressBar
getFinishClass in class AbstractProgressBarpublic void setFinishClass(String finishClass)
public String getInitialClass()
AbstractProgressBar
getInitialClass 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()
AbstractProgressBar
getLabel in class AbstractProgressBarpublic void setLabel(String label)
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 org.richfaces.component.SwitchType getMode()
AbstractProgressBarThe mode for updating the progress bar, can be one of:
Default is "ajax"
getMode in class AbstractProgressBarpublic void setMode(org.richfaces.component.SwitchType mode)
public String getOnbeforedomupdate()
AbstractProgressBar
getOnbeforedomupdate in class AbstractProgressBarpublic void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
AbstractProgressBar
getOnbegin in class AbstractProgressBarpublic void setOnbegin(String onbegin)
public String getOnclick()
getOnclick in class AbstractProgressBarpublic void setOnclick(String onclick)
public String getOncomplete()
AbstractProgressBar
getOncomplete in class AbstractProgressBarpublic void setOncomplete(String oncomplete)
public String getOndblclick()
getOndblclick in class AbstractProgressBarpublic void setOndblclick(String ondblclick)
public String getOnfinish()
AbstractProgressBar
getOnfinish in class AbstractProgressBarpublic void setOnfinish(String onfinish)
public String getOnmousedown()
getOnmousedown in class AbstractProgressBarpublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
getOnmousemove in class AbstractProgressBarpublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
getOnmouseout in class AbstractProgressBarpublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
getOnmouseover in class AbstractProgressBarpublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
getOnmouseup in class AbstractProgressBarpublic void setOnmouseup(String onmouseup)
public String getProgressClass()
AbstractProgressBar
getProgressClass in class AbstractProgressBarpublic void setProgressClass(String progressClass)
public String getRemainingClass()
AbstractProgressBar
getRemainingClass in class AbstractProgressBarpublic void setRemainingClass(String remainingClass)
public String getResource()
getResource in class AbstractProgressBarpublic void setResource(String resource)
public String getStyle()
AbstractProgressBar
getStyle in class AbstractProgressBarpublic void setStyle(String style)
public String getStyleClass()
AbstractProgressBar
getStyleClass in class AbstractProgressBarpublic void setStyleClass(String styleClass)
public Object getValue()
AbstractProgressBar
getValue in class AbstractProgressBarpublic void setValue(Object value)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||