The standard component family for this component.

The standard component type for this component.

Create a new UICommand instance with default property values.

Implements javax.faces.component.ActionSource.addActionListener.

Doc from javax.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

Overrides javax.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 javax.faces.application.Application.

Parameters

event:FacesEvent

FacesEvent to be broadcast

Annotations

@Override

Exceptions

AbortProcessingException:

Signal the JavaServer 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

Implements javax.faces.component.ActionSource.getAction.

Doc from javax.faces.component.ActionSource.getAction.

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 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:MethodBinding

the action.

Annotations

@Override

Implements javax.faces.component.ActionSource2.getActionExpression.

Doc from javax.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.

Note that it's possible that the returned MethodExpression is just a wrapper around a MethodBinding instance whith was set by a call to ActionSource#setAction. This makes it possible for the default ActionListener to continue to work properly with older components.

Returns:MethodExpression

the action expression.

Annotations

@Override

Implements javax.faces.component.ActionSource.getActionListener.

Doc from javax.faces.component.ActionSource.getActionListener.

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.

Returns:MethodBinding

the action listener.

Annotations

@Override

Implements javax.faces.component.ActionSource.getActionListeners.

Doc from javax.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

Implements abstract javax.faces.component.UIComponent.getFamily.

Doc from javax.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

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.

Implements javax.faces.component.ActionSource.isImmediate.

The immediate flag.

Returns:boolean

Doc from javax.faces.component.ActionSource.isImmediate.

true if immediate, false otherwise.

Annotations

@Override

Overrides javax.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

e:FacesEvent

Doc from javax.faces.component.UIComponent.queueEvent.

FacesEvent to be queued

Annotations

@Override

Implements javax.faces.component.ActionSource.removeActionListener.

Doc from javax.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

Implements javax.faces.component.ActionSource.setAction.

Doc from javax.faces.component.ActionSource.setAction.

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.

Parameters

action:MethodBinding

The new MethodBinding expression

Annotations

@Override

Implements javax.faces.component.ActionSource2.setActionExpression.

Doc from javax.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

Implements javax.faces.component.ActionSource.setActionListener.

Doc from javax.faces.component.ActionSource.setActionListener.

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:MethodBinding

The new method binding expression

Annotations

@Override

Implements javax.faces.component.ActionSource.setImmediate.

Doc from javax.faces.component.ActionSource.setImmediate.

Set the "immediate execution" flag for this UIComponent.

Parameters

immediate:boolean

The new immediate execution flag

Annotations

@Override

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

Parameters

value:Object

the new value