|
||||||||||
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
javax.faces.component.UICommand
public class UICommand
Type | Phases | Description |
---|---|---|
javax.faces.event.ActionEvent |
Invoke Application Apply Request Values |
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. |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
UICommand()
Construct an instance of the UICommand. |
Method Summary | |
---|---|
void |
addActionListener(ActionListener listener)
Adds a action listener. |
void |
broadcast(FacesEvent event)
Invoke any listeners attached to this object which are listening for an event whose type matches the specified event's runtime type. |
MethodBinding |
getAction()
Deprecated. Use getActionExpression() instead. |
javax.el.MethodExpression |
getActionExpression()
Gets Specifies the action to take when this command is invoked. |
MethodBinding |
getActionListener()
Deprecated. |
ActionListener[] |
getActionListeners()
Returns an array of attached action listeners. |
java.lang.String |
getFamily()
|
java.lang.Object |
getValue()
Gets The initial value of this component. |
boolean |
isImmediate()
Gets A boolean value that identifies the phase during which action events should fire. |
void |
queueEvent(FacesEvent event)
|
void |
removeActionListener(ActionListener listener)
Removes a action listener. |
void |
restoreState(FacesContext facesContext,
java.lang.Object state)
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object. |
java.lang.Object |
saveState(FacesContext facesContext)
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has. |
void |
setAction(MethodBinding action)
Deprecated. Use setActionExpression instead. |
void |
setActionExpression(javax.el.MethodExpression actionExpression)
Sets Specifies the action to take when this command is invoked. |
void |
setActionListener(MethodBinding actionListener)
Deprecated. |
void |
setImmediate(boolean immediate)
Sets A boolean value that identifies the phase during which action events should fire. |
void |
setValue(java.lang.Object value)
Sets The initial value of this component. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UICommand()
Method Detail |
---|
public void setAction(MethodBinding action)
setAction
in interface ActionSource
public MethodBinding getAction()
getAction
in interface ActionSource
public void broadcast(FacesEvent event) throws AbortProcessingException
UIComponentBase
This method does not propagate the event up to parent components, ie listeners attached to parent components don't automatically get called.
If any of the listeners throws AbortProcessingException then that exception will prevent any further listener callbacks from occurring, and the exception propagates out of this method without alteration.
ActionEvent events are typically queued by the renderer associated with this component in its decode method; ValueChangeEvent events by the component's validate method. In either case the event's source property references a component. At some later time the UIViewRoot component iterates over its queued events and invokes the broadcast method on each event's source object.
broadcast
in class UIComponentBase
event
- must not be null.
AbortProcessingException
public void queueEvent(FacesEvent event)
queueEvent
in class UIComponentBase
public boolean isImmediate()
isImmediate
in interface ActionSource
public void setImmediate(boolean immediate)
setImmediate
in interface ActionSource
immediate
- the new immediate valuepublic java.lang.Object getValue()
public void setValue(java.lang.Object value)
value
- the new value valuepublic javax.el.MethodExpression getActionExpression()
getActionExpression
in interface ActionSource2
public void setActionExpression(javax.el.MethodExpression actionExpression)
setActionExpression
in interface ActionSource2
actionExpression
- the new actionExpression valuepublic MethodBinding getActionListener()
getActionListener
in interface ActionSource
public void setActionListener(MethodBinding actionListener)
setActionListener
in interface ActionSource
actionListener
- the new actionListener valuepublic void addActionListener(ActionListener listener)
addActionListener
in interface ActionSource
listener
- the action listener to addpublic void removeActionListener(ActionListener listener)
removeActionListener
in interface ActionSource
listener
- the action listener to removepublic ActionListener[] getActionListeners()
getActionListeners
in interface ActionSource
public java.lang.Object saveState(FacesContext facesContext)
UIComponentBase
saveState
in interface StateHolder
saveState
in class UIComponentBase
public void restoreState(FacesContext facesContext, java.lang.Object state)
UIComponentBase
restoreState
in interface StateHolder
restoreState
in class UIComponentBase
state
- is an object previously returned by
the saveState method of this class.public java.lang.String getFamily()
getFamily
in class UIComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |