EE4J 10.0.0 · jakarta.faces.component.UICommand

UICommand is a UIComponent that represents a user interface component which, when activated by the user, triggers an application specific "command" or "action". Such a component is typically rendered as a push button, a menu item, or a hyperlink.

When the decode() method of this UICommand, or its corresponding Renderer, detects that this control has been activated, it will queue an ActionEvent. Later on, the broadcast() method will ensure that this event is broadcast to all interested listeners.

Listeners will be invoked in the following order:

ActionListeners, in the order in which they were registered.
The "actionListener" MethodExpression (which will cover the "actionListener" that was set as a MethodBinding).
The default ActionListener, retrieved from the Application - and therefore, any attached "action" MethodExpression.

By default, the rendererType property must be set to "jakarta.faces.Button". This value can be changed by calling the setRendererType() method.

Modifier and Type	Class and Description
pack-priv static enum	UICommand.PropertyKeys Properties that are tracked by state saving.

Field Summary

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY The standard component family for this component.
public static final String	COMPONENT_TYPE The standard component type for this component.

Constructor Summary

Access	Constructor and Description
public	UICommand() Create a new `UICommand` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public void	addActionListener(ActionListener The `ActionListener` to be added listener) Implements jakarta.faces.component.ActionSource.addActionListener. Add a new `ActionListener` to the set of listeners interested in being notified when `ActionEvent`s occur.
public void	broadcast(FacesEvent `FacesEvent` to be broadcast event) Overrides jakarta.faces.component.UIComponentBase.broadcast. In addition to to the default `UIComponent#broadcast` processing, pass the `ActionEvent` being broadcast to the method referenced by `actionListener` (if any), and to the default `ActionListener` registered on the `jakarta.faces.application.Application`.
public MethodExpression	getActionExpression() Implements jakarta.faces.component.ActionSource2.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[]	getActionListeners() Implements jakarta.faces.component.ActionSource.getActionListeners. Return the set of registered `ActionListener`s for this `ActionSource` instance.
public String	getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs.
public Object	Returns: The object representing the value of this component. getValue() Returns the `value` property of the `UICommand`.
public boolean	isImmediate() Implements jakarta.faces.component.ActionSource.isImmediate. The immediate flag.
public void	queueEvent(FacesEvent `FacesEvent` to be queued event) Overrides jakarta.faces.component.UIComponentBase.queueEvent. Intercept `queueEvent` and take the following action.
public void	removeActionListener(ActionListener The `ActionListener` to be removed listener) Implements jakarta.faces.component.ActionSource.removeActionListener. Remove an existing `ActionListener` (if any) from the set of listeners interested in being notified when `ActionEvent`s occur.
public void	setActionExpression(MethodExpression The new method expression actionExpression) Implements jakarta.faces.component.ActionSource2.setActionExpression. 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) Implements jakarta.faces.component.ActionSource.setImmediate. Set the "immediate execution" flag for this `UIComponent`.
public void	setValue(Object the new value value) Sets the `value` property of the `UICommand`.

Field Detail

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE The standard component type for this component.

Constructor Detail

UICommand	back to summary
public UICommand() Create a new `UICommand` instance with default property values.

Method Detail

addActionListener back to summary

addActionListener	back to summary
public void addActionListener(ActionListener listener) Implements jakarta.faces.component.ActionSource.addActionListener. Doc from jakarta.faces.component.ActionSource.addActionListener. 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 Annotations @Override Exceptions NullPointerException: if `listener` is `null`

public void addActionListener(ActionListener listener)

Implements jakarta.faces.component.ActionSource.addActionListener.

Doc from jakarta.faces.component.ActionSource.addActionListener.

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

Parameters

listener:ActionListener: The ActionListener to be added

Annotations

@Override

Exceptions

NullPointerException:: if listener is null

broadcast back to summary

broadcast	back to summary
public void broadcast(FacesEvent event) throws AbortProcessingException Overrides jakarta.faces.component.UIComponentBase.broadcast. In addition to to the default `UIComponent#broadcast` processing, pass the `ActionEvent` being broadcast to the method referenced by `actionListener` (if any), and to the default `ActionListener` registered on the `jakarta.faces.application.Application`. Parameters event:FacesEvent `FacesEvent` to be broadcast Annotations @Override Exceptions AbortProcessingException: Signal the Jakarta Faces implementation that no further processing on the current event should be performed IllegalArgumentException: if the implementation class of this `FacesEvent` is not supported by this component NullPointerException: if `event` is `null`

public void broadcast(FacesEvent event) throws AbortProcessingException

Overrides jakarta.faces.component.UIComponentBase.broadcast.

In addition to to the default UIComponent#broadcast processing, pass the ActionEvent being broadcast to the method referenced by actionListener (if any), and to the default ActionListener registered on the jakarta.faces.application.Application.

Parameters

event:FacesEvent: FacesEvent to be broadcast

Annotations

@Override

Exceptions

AbortProcessingException:: Signal the Jakarta Faces implementation that no further processing on the current event should be performed
IllegalArgumentException:: if the implementation class of this FacesEvent is not supported by this component
NullPointerException:: if event is null

getActionExpression back to summary

getActionExpression	back to summary
public MethodExpression getActionExpression() Implements jakarta.faces.component.ActionSource2.getActionExpression. Doc from jakarta.faces.component.ActionSource2.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. Returns:MethodExpression the action expression. Annotations @Override

public MethodExpression getActionExpression()

Implements jakarta.faces.component.ActionSource2.getActionExpression.

Doc from jakarta.faces.component.ActionSource2.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.

Returns:MethodExpression

the action expression.

Annotations

@Override

getActionListeners back to summary

getActionListeners	back to summary
public ActionListener[] getActionListeners() Implements jakarta.faces.component.ActionSource.getActionListeners. Doc from jakarta.faces.component.ActionSource.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. Annotations @Override

public ActionListener[] getActionListeners()

Implements jakarta.faces.component.ActionSource.getActionListeners.

Doc from jakarta.faces.component.ActionSource.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.

Annotations

@Override

getFamily back to summary

getFamily	back to summary
public String getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Doc from jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the `rendererType` property, may be used to select the appropriate `Renderer` for this component instance. Note this method should NOT return `null` Returns:String the component family (not null). Annotations @Override

public String getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations

@Override

getValue back to summary

getValue	back to summary
public Object getValue() Returns the `value` property of the `UICommand`. This is most often rendered as a label. Returns:Object The object representing the value of this component.

public Object getValue()

Returns the value property of the UICommand. This is most often rendered as a label.

Returns:Object: The object representing the value of this component.

isImmediate back to summary

isImmediate	back to summary
public boolean isImmediate() Implements jakarta.faces.component.ActionSource.isImmediate. The immediate flag. Returns:boolean Doc from jakarta.faces.component.ActionSource.isImmediate. `true` if immediate, `false` otherwise. Annotations @Override

public boolean isImmediate()

Implements jakarta.faces.component.ActionSource.isImmediate.

The immediate flag.

Returns:boolean

Doc from jakarta.faces.component.ActionSource.isImmediate.

true if immediate, false otherwise.

Annotations

@Override

queueEvent back to summary

queueEvent	back to summary
public void queueEvent(FacesEvent event) Overrides jakarta.faces.component.UIComponentBase.queueEvent. Intercept `queueEvent` and take the following action. If the event is an `ActionEvent`, obtain the `UIComponent` instance from the event. If the component is an `ActionSource` obtain the value of its "immediate" property. If it is true, mark the phaseId for the event to be `PhaseId.APPLY_REQUEST_VALUES` otherwise, mark the phaseId to be `PhaseId.INVOKE_APPLICATION`. The event must be passed on to `super.queueEvent()` before returning from this method. Parameters event:FacesEvent Doc from jakarta.faces.component.UIComponent.queueEvent. `FacesEvent` to be queued Annotations @Override

public void queueEvent(FacesEvent event)

Overrides jakarta.faces.component.UIComponentBase.queueEvent.

Intercept queueEvent and take the following action. If the event is an ActionEvent, obtain the UIComponent instance from the event. If the component is an ActionSource obtain the value of its "immediate" property. If it is true, mark the phaseId for the event to be PhaseId.APPLY_REQUEST_VALUES otherwise, mark the phaseId to be PhaseId.INVOKE_APPLICATION. The event must be passed on to super.queueEvent() before returning from this method.

Parameters

event:FacesEvent

Doc from jakarta.faces.component.UIComponent.queueEvent.

FacesEvent to be queued

Annotations

@Override

removeActionListener back to summary

removeActionListener	back to summary
public void removeActionListener(ActionListener listener) Implements jakarta.faces.component.ActionSource.removeActionListener. Doc from jakarta.faces.component.ActionSource.removeActionListener. 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 Annotations @Override Exceptions NullPointerException: if `listener` is `null`

public void removeActionListener(ActionListener listener)

Implements jakarta.faces.component.ActionSource.removeActionListener.

Doc from jakarta.faces.component.ActionSource.removeActionListener.

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

Annotations

@Override

Exceptions

NullPointerException:: if listener is null

setActionExpression back to summary

setActionExpression	back to summary
public void setActionExpression(MethodExpression actionExpression) Implements jakarta.faces.component.ActionSource2.setActionExpression. Doc from jakarta.faces.component.ActionSource2.setActionExpression. 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 actionExpression:MethodExpression The new method expression Annotations @Override

public void setActionExpression(MethodExpression actionExpression)

Implements jakarta.faces.component.ActionSource2.setActionExpression.

Doc from jakarta.faces.component.ActionSource2.setActionExpression.

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

actionExpression:MethodExpression: The new method expression

Annotations

@Override

setImmediate back to summary

setImmediate	back to summary
public void setImmediate(boolean immediate) Implements jakarta.faces.component.ActionSource.setImmediate. Doc from jakarta.faces.component.ActionSource.setImmediate. Set the "immediate execution" flag for this `UIComponent`. Parameters immediate:boolean The new immediate execution flag Annotations @Override

public void setImmediate(boolean immediate)

Implements jakarta.faces.component.ActionSource.setImmediate.

Doc from jakarta.faces.component.ActionSource.setImmediate.

Set the "immediate execution" flag for this UIComponent.

Parameters

immediate:boolean: The new immediate execution flag

Annotations

@Override

setValue back to summary

setValue	back to summary
public void setValue(Object value) Sets the `value` property of the `UICommand`. This is most often rendered as a label. Parameters value:Object the new value

public void setValue(Object value)

Sets the value property of the UICommand. This is most often rendered as a label.

Parameters

value:Object: the new value

Modifier and Type	Method and Description
public static UICommand.PropertyKeys	valueOf(String name)
public static UICommand.PropertyKeys[]	values()

public Class UICommand

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum UICommand.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final UICommand.PropertyKeys	actionExpression
public static final UICommand.PropertyKeys	immediate
public static final UICommand.PropertyKeys	methodBindingActionListener
public static final UICommand.PropertyKeys	value