Package jakarta.faces.component

Interface ActionSource

All Known Subinterfaces:
ActionSource2
All Known Implementing Classes:
HtmlCommandButton, HtmlCommandLink, HtmlCommandScript, UICommand, UIViewAction
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 Details

    • isImmediate

      boolean isImmediate()

      Return a flag indicating that the default ActionListener provided by the Jakarta Server 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.

      Returns:
      true if immediate, false otherwise.

    • setImmediate

      void setImmediate(boolean immediate)

      Set the "immediate execution" flag for this UIComponent.

      Parameters:
      immediate - The new immediate execution flag

    • addActionListener

      void addActionListener(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:
      NullPointerException - if listener is null

    • getActionListeners

      ActionListener[] getActionListeners()

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

      Returns:
      the action listeners, or a zero-length array.

    • removeActionListener

      void removeActionListener(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:
      NullPointerException - if listener is null

    • getAction

      @Deprecated 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(jakarta.faces.el.MethodBinding), extract the MethodBinding from it and return it. Otherwise, wrap the returned MethodExpression in a MethodBinding implementation, and return it.

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

      Returns:
      the action.

    • setAction

      @Deprecated void setAction(MethodBinding action)
      Deprecated.
      This has been replaced by ActionSource2.setActionExpression(jakarta.el.MethodExpression).

      If the implementing class also implements ActionSource2, the implementation of this method must wrap the argument action in a class that implements MethodExpression and call through to ActionSource2.setActionExpression(jakarta.el.MethodExpression), 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.

      Parameters:
      action - The new MethodBinding expression

    • getActionListener

      @Deprecated MethodBinding getActionListener()
      Deprecated.
      Use getActionListeners() instead.

      If setActionListener(jakarta.faces.el.MethodBinding) 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(jakarta.faces.el.MethodBinding).

      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.

      Returns:
      the action listener.

    • setActionListener

      @Deprecated void setActionListener(MethodBinding actionListener)
      Deprecated.
      This has been replaced by addActionListener(jakarta.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.

      Parameters:
      actionListener - The new method binding expression