Home » Mojarra-2.0.1 » javax » faces » component » [javadoc | source]
javax.faces.component
public interface: ActionSource [javadoc | source]

All Known Implementing Classes:
    HtmlCommandButton, ActionSource2, UICommand, HtmlCommandLink

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

Method from javax.faces.component.ActionSource Summary:
addActionListener,   getAction,   getActionListener,   getActionListeners,   isImmediate,   removeActionListener,   setAction,   setActionListener,   setImmediate
Method from javax.faces.component.ActionSource Detail:
 public  void addActionListener(ActionListener listener)
 public MethodBinding getAction()Deprecated! This -  has been replaced by ActionSource2#getActionExpression .

    If the implementing class also implements ActionSource2 , the implementation of this method must call through to ActionSource2#getActionExpression and examine the result. If the result came from a previous call to #setAction , extract the MethodBinding from it and return it. Otherwise, wrap the returned javax.el.MethodExpression in a MethodBinding implementation, and return it.

    If the implementing class does not implement ActionSource2, return the MethodBinding pointing 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.

 public MethodBinding getActionListener()Deprecated! Use -  #getActionListeners  instead.

    If #setActionListener was not previously called for this instance, this method must return null. If it was called, this method must return the exact MethodBinding instance that was passed to #setActionListener .

    The method to be invoked, if this UIComponent is activated by the user, will be called during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.

 abstract public ActionListener[] getActionListeners()

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

 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.

 public  void removeActionListener(ActionListener listener)
 public  void setAction(MethodBinding action)Deprecated! This -  has been replaced by ActionSource2#setActionExpression(javax.el.MethodExpression) .

    If the implementing class also implements ActionSource2 , the implementation of this method must wrap the argument action in a class that implements javax.el.MethodExpression and call through to ActionSource2#setActionExpression , passing the wrapped action.

    If the implementing class does not implement ActionSource2, 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.

 public  void setActionListener(MethodBinding actionListener)Deprecated! This -  has been replaced by #addActionListener(javax.faces.event.ActionListener) .

    Wrap the argument actionListener in an implementation of ActionListener and store it in the internal data structure that backs the #getActionListeners method, taking care to over-write any instance that was stored by a previous call to setActionListener.

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

 public  void setImmediate(boolean immediate)

    Set the "immediate execution" flag for this UIComponent .