Jakarta EE 11.0.0 · jakarta.faces.component.ActionSource

Method Summary

Modifier and Type	Method and Description
public void	addActionListener(ActionListener The `ActionListener` to be added listener) Add a new `ActionListener` to the set of listeners interested in being notified when `ActionEvent`s occur.
public default MethodExpression	Returns: the action expression. getActionExpression() Return the `MethodExpression` 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 ActionListener[]	Returns: the action listeners, or a zero-length array. getActionListeners() Return the set of registered `ActionListener`s for this `ActionSource` instance.
public boolean	Returns: `true` if immediate, `false` otherwise. isImmediate() Return a flag indicating that the default `ActionListener` provided by the Jakarta 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.
public void	removeActionListener(ActionListener The `ActionListener` to be removed listener) Remove an existing `ActionListener` (if any) from the set of listeners interested in being notified when `ActionEvent`s occur.
public default void	setActionExpression(MethodExpression The new method expression action) Set the `MethodExpression` 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.
public void	setImmediate(boolean The new immediate execution flag immediate) Set the "immediate execution" flag for this `UIComponent`.

Method Detail

addActionListener back to summary

addActionListener	back to summary
public void addActionListener(ActionListener listener) Add a new `ActionListener` to the set of listeners interested in being notified when `ActionEvent`s occur. Parameters listener:ActionListener The `ActionListener` to be added Exceptions NullPointerException: if `listener` is `null`

public void addActionListener(ActionListener listener)

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

Parameters

listener:ActionListener: The ActionListener to be added

Exceptions

NullPointerException:: if listener is null

getActionExpression back to summary

getActionExpression	back to summary
public default MethodExpression getActionExpression() Return the `MethodExpression` 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. The default implementation throws `UnsupportedOperationException` and is provided for the sole purpose of not breaking existing applications that extend `ActionSource`. Historically this method was declared in `ActionSource2` for precisely this reason but default methods in interfaces weren't supported. Returns:MethodExpression the action expression. Since 4.1

public default MethodExpression getActionExpression()

Return the MethodExpression 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.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend ActionSource. Historically this method was declared in ActionSource2 for precisely this reason but default methods in interfaces weren't supported.

Returns:MethodExpression: the action expression.
Since: 4.1

getActionListeners back to summary

getActionListeners	back to summary
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. Returns:ActionListener[] the action listeners, or a zero-length array.

public 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:ActionListener[]: the action listeners, or a zero-length array.

isImmediate back to summary

isImmediate	back to summary
public boolean isImmediate() Return a flag indicating that the default `ActionListener` provided by the Jakarta 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:boolean `true` if immediate, `false` otherwise.

public boolean isImmediate()

Return a flag indicating that the default ActionListener provided by the Jakarta 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:boolean: true if immediate, false otherwise.

removeActionListener back to summary

removeActionListener	back to summary
public void removeActionListener(ActionListener listener) Remove an existing `ActionListener` (if any) from the set of listeners interested in being notified when `ActionEvent`s occur. Parameters listener:ActionListener The `ActionListener` to be removed Exceptions NullPointerException: if `listener` is `null`

public void removeActionListener(ActionListener listener)

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

Parameters

listener:ActionListener: The ActionListener to be removed

Exceptions

NullPointerException:: if listener is null

setActionExpression back to summary

setActionExpression	back to summary
public default void setActionExpression(MethodExpression action) Set the `MethodExpression` 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. The default implementation throws `UnsupportedOperationException` and is provided for the sole purpose of not breaking existing applications that extend `ActionSource`. Historically this method was declared in `ActionSource2` for precisely this reason but default methods in interfaces weren't supported. Parameters action:MethodExpression The new method expression Since 4.1

public default void setActionExpression(MethodExpression action)

Set the MethodExpression 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:MethodExpression: The new method expression

Since

4.1

setImmediate back to summary

setImmediate	back to summary
public void setImmediate(boolean immediate) Set the "immediate execution" flag for this `UIComponent`. Parameters immediate:boolean The new immediate execution flag

public void setImmediate(boolean immediate)

Set the "immediate execution" flag for this UIComponent.

Parameters

immediate:boolean: The new immediate execution flag

public Interface ActionSource

Method Summary

Method Detail