|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
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.icefaces.ace.component.progressbar.ProgressBarBase
public class ProgressBarBase
The Progress Bar is a process status indicator that can either work purely on client side or interact with server side using ajax.
For more information, see the ProgressBar Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
ProgressBarBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_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 | |
---|---|
ProgressBarBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
javax.el.MethodExpression |
getCancelListener()
Return the value of the cancelListener property. |
javax.el.MethodExpression |
getChangeListener()
Return the value of the changeListener property. |
javax.el.MethodExpression |
getCompleteListener()
Return the value of the completeListener property. |
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
int |
getPollingInterval()
Return the value of the pollingInterval property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
int |
getValue()
Return the value of the value property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
boolean |
isDisabled()
Return the value of the disabled property. |
boolean |
isUsePolling()
Return the value of the usePolling property. |
void |
setCancelListener(javax.el.MethodExpression cancelListener)
Set the value of the cancelListener property. |
void |
setChangeListener(javax.el.MethodExpression changeListener)
Set the value of the changeListener property. |
void |
setCompleteListener(javax.el.MethodExpression completeListener)
Set the value of the completeListener property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setPollingInterval(int pollingInterval)
Set the value of the pollingInterval property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setUsePolling(boolean usePolling)
Set the value of the usePolling property. |
void |
setValue(int value)
Set the value of the value property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
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, visitTree |
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 |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public ProgressBarBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setCancelListener(javax.el.MethodExpression cancelListener)
Set the value of the cancelListener
property.
Contents: A server side listener to be invoked when a progress is cancelled.
setCancelListener
in interface IProgressBar
public javax.el.MethodExpression getCancelListener()
Return the value of the cancelListener
property.
Contents: A server side listener to be invoked when a progress is cancelled.
getCancelListener
in interface IProgressBar
public void setChangeListener(javax.el.MethodExpression changeListener)
Set the value of the changeListener
property.
Contents: A server side listener to be invoked when the value of the progress bar changes.
setChangeListener
in interface IProgressBar
public javax.el.MethodExpression getChangeListener()
Return the value of the changeListener
property.
Contents: A server side listener to be invoked when the value of the progress bar changes.
getChangeListener
in interface IProgressBar
public void setCompleteListener(javax.el.MethodExpression completeListener)
Set the value of the completeListener
property.
Contents: A server side listener to be invoked when a progress is completed.
setCompleteListener
in interface IProgressBar
public javax.el.MethodExpression getCompleteListener()
Return the value of the completeListener
property.
Contents: A server side listener to be invoked when a progress is completed.
getCompleteListener
in interface IProgressBar
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
Contents: Disables or enables the progressbar.
setDisabled
in interface IProgressBar
public boolean isDisabled()
Return the value of the disabled
property.
Contents: Disables or enables the progressbar.
isDisabled
in interface IProgressBar
public void setPollingInterval(int pollingInterval)
Set the value of the pollingInterval
property.
Contents: Interval in milliseconds to do polling.
setPollingInterval
in interface IProgressBar
public int getPollingInterval()
Return the value of the pollingInterval
property.
Contents: Interval in milliseconds to do polling. Default = '3000'.
getPollingInterval
in interface IProgressBar
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Inline style of the main container element.
setStyle
in interface IProgressBar
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Inline style of the main container element.
getStyle
in interface IProgressBar
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class of the main container element.
setStyleClass
in interface IProgressBar
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the main container element.
getStyleClass
in interface IProgressBar
public void setUsePolling(boolean usePolling)
Set the value of the usePolling
property.
Contents: If true, you can use start() to start polling sever for progress value.
setUsePolling
in interface IProgressBar
public boolean isUsePolling()
Return the value of the usePolling
property.
Contents: If true, you can use start() to start polling sever for progress value.
isUsePolling
in interface IProgressBar
public void setValue(int value)
Set the value of the value
property.
Contents: Value of the progress bar.
setValue
in interface IProgressBar
public int getValue()
Return the value of the value
property.
Contents: Value of the progress bar. Default = '0'.
getValue
in interface IProgressBar
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: Name of the client side widget.
setWidgetVar
in interface IProgressBar
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Name of the client side widget.
getWidgetVar
in interface IProgressBar
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |