javax.faces.component
Interface ActionSource

All Known Implementing Classes:

UICommand

public interface ActionSource

ActionSource is an interface that may be implemented by any concrete UIComponent that wishes to be a source of ActionEvents, including the ability to invoke application actions via the default ActionListener mechanism.

Method Summary

void	addActionListener(javax.faces.event.ActionListener listener) Add a new ActionListener to the set of listeners interested in being notified when ActionEvents occur.
javax.faces.el.MethodBinding	getAction() Return the MethodBindingpointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.
javax.faces.el.MethodBinding	getActionListener() Return the MethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.
javax.faces.event.ActionListener[]	getActionListeners() Return the set of registered ActionListeners for this ActionSource instance.
boolean	isImmediate() Return a flag indicating that the default ActionListener provided by the JavaServer Faces implementation should be executed immediately (that is, during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase.
void	removeActionListener(javax.faces.event.ActionListener listener) Remove an existing ActionListener (if any) from the set of listeners interested in being notified when ActionEvents occur.
void	setAction(javax.faces.el.MethodBinding action) Set the MethodBinding pointing at the appication action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.
void	setActionListener(javax.faces.el.MethodBinding actionListener) Set the MethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immmediate property.
void	setImmediate(boolean immediate) Set the "immediate execution" flag for this UIComponent.

Method Detail

getAction

public javax.faces.el.MethodBinding getAction()

Return the MethodBindingpointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.

setAction

public void setAction(javax.faces.el.MethodBinding action)

Set the MethodBinding pointing at the appication action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.

Any method referenced by such an expression must be public, with a return type of String, and accept no parameters.

Parameters:

action - The new MethodBinding expression

getActionListener

public javax.faces.el.MethodBinding getActionListener()

Return the MethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.

setActionListener

public void setActionListener(javax.faces.el.MethodBinding actionListener)

Set the MethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immmediate property.

Any method referenced by such an expression must be public, with a return type of void, and accept a single parameter of type ActionEvent.

Parameters:

actionListener - The new method binding expression

isImmediate

public boolean isImmediate()

Return a flag indicating that the default ActionListener provided by the JavaServer Faces implementation should be executed immediately (that is, during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase. The default value for this property must be false.

setImmediate

public void setImmediate(boolean immediate)

Set the "immediate execution" flag for this UIComponent.

Parameters:

immediate - The new immediate execution flag

addActionListener

public void addActionListener(javax.faces.event.ActionListener listener)

Add a new ActionListener to the set of listeners interested in being notified when ActionEvents occur.

Parameters:

listener - The ActionListener to be added

Throws:

java.lang.NullPointerException - if listener is null

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()

Return the set of registered ActionListeners for this ActionSource instance. If there are no registered listeners, a zero-length array is returned.

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener listener)

Remove an existing ActionListener (if any) from the set of listeners interested in being notified when ActionEvents occur.

Parameters:

listener - The ActionListener to be removed

Throws:

java.lang.NullPointerException - if listener is null