|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXProgress
public class UIXProgress
UIXProgress is a base abstraction for components that implement ActionSource and indicate the progress of tasks running in the server, typically navigating to a special page once the task is complete. When the task is complete, an ActionEvent is delivered.
Type | Phases | Description |
---|---|---|
javax.faces.event.ActionEvent |
Any Phase Invoke Application |
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static PropertyKey |
ACTION_KEY
|
static PropertyKey |
ACTION_LISTENER_KEY
|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static PropertyKey |
IMMEDIATE_KEY
|
static FacesBean.Type |
TYPE
|
static PropertyKey |
VALUE_KEY
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
|
UIXProgress()
Construct an instance of the UIXProgress. |
protected |
UIXProgress(String rendererType)
Construct an instance of the UIXProgress. |
Method Summary | |
---|---|
void |
addActionListener(javax.faces.event.ActionListener listener)
Adds a action listener. |
void |
broadcast(javax.faces.event.FacesEvent event)
|
javax.faces.el.MethodBinding |
getAction()
Gets A reference to an action method sent by the progress component, or the static outcome of an action. |
javax.faces.el.MethodBinding |
getActionListener()
Gets A method reference to an action listener. |
javax.faces.event.ActionListener[] |
getActionListeners()
Returns an array of attached action listeners. |
protected FacesBean.Type |
getBeanType()
|
String |
getFamily()
|
Object |
getValue()
Gets The data model being used by this progress component. |
boolean |
isImmediate()
Gets whether data validation - client-side or server-side - will be skipped when events are generated by this component. |
void |
queueEvent(javax.faces.event.FacesEvent e)
|
void |
removeActionListener(javax.faces.event.ActionListener listener)
Removes a action listener. |
void |
setAction(javax.faces.el.MethodBinding action)
Sets A reference to an action method sent by the progress component, or the static outcome of an action. |
void |
setActionListener(javax.faces.el.MethodBinding actionListener)
Sets A method reference to an action listener. |
void |
setImmediate(boolean immediate)
Sets whether data validation - client-side or server-side - will be skipped when events are generated by this component. |
void |
setValue(Object value)
Sets The data model being used by this progress component. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final FacesBean.Type TYPE
public static final PropertyKey VALUE_KEY
public static final PropertyKey ACTION_KEY
public static final PropertyKey ACTION_LISTENER_KEY
public static final PropertyKey IMMEDIATE_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
Constructor Detail |
---|
public UIXProgress()
protected UIXProgress(String rendererType)
Method Detail |
---|
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class UIXComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class UIXComponentBase
javax.faces.event.AbortProcessingException
public final Object getValue()
public final void setValue(Object value)
value
- the new value valuepublic final javax.faces.el.MethodBinding getAction()
getAction
in interface javax.faces.component.ActionSource
public final void setAction(javax.faces.el.MethodBinding action)
setAction
in interface javax.faces.component.ActionSource
action
- the new action valuepublic final javax.faces.el.MethodBinding getActionListener()
getActionListener
in interface javax.faces.component.ActionSource
public final void setActionListener(javax.faces.el.MethodBinding actionListener)
setActionListener
in interface javax.faces.component.ActionSource
actionListener
- the new actionListener valuepublic final boolean isImmediate()
isImmediate
in interface javax.faces.component.ActionSource
public final void setImmediate(boolean immediate)
setImmediate
in interface javax.faces.component.ActionSource
immediate
- the new immediate valuepublic final void addActionListener(javax.faces.event.ActionListener listener)
addActionListener
in interface javax.faces.component.ActionSource
listener
- the action listener to addpublic final void removeActionListener(javax.faces.event.ActionListener listener)
removeActionListener
in interface javax.faces.component.ActionSource
listener
- the action listener to removepublic final javax.faces.event.ActionListener[] getActionListeners()
getActionListeners
in interface javax.faces.component.ActionSource
public String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |