javax.faces.component: public class: UICommand

javax.faces.component
public class: UICommand [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UICommand

All Implemented Interfaces:
ActionSource2, PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Direct Known Subclasses:
HtmlCommandButton, HtmlCommandLink

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:

ActionListener s, 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 "javax.faces.Button". This value can be changed by calling the setRendererType() method.

Nested Class Summary:
enum class	UICommand.PropertyKeys	Properties that are tracked by state saving.

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.
public static final String	COMPONENT_FAMILY	The standard component family for this component.

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public UICommand() { super(); setRendererType("javax.faces.Button"); } Create a new UICommand instance with default property values.

Constructor:

 public UICommand() {
        super();
        setRendererType("javax.faces.Button");
}

Create a new UICommand instance with default property values.

Method from javax.faces.component.UICommand Summary:
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getFamily, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.UICommand Detail:
public void addActionListener(ActionListener listener) { addFacesListener(listener); }
public void broadcast(FacesEvent event) throws AbortProcessingException { // Perform standard superclass processing (including calling our // ActionListeners) super.broadcast(event); if (event instanceof ActionEvent) { FacesContext context = getFacesContext(); // Notify the specified action listener method (if any) MethodBinding mb = getActionListener(); if (mb != null) { mb.invoke(context, new Object[] { event }); } // Invoke the default ActionListener ActionListener listener = context.getApplication().getActionListener(); if (listener != null) { listener.processAction((ActionEvent) event); } } } 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 .
public MethodBinding getAction() { MethodBinding result = null; MethodExpression me; if (null != (me = getActionExpression())) { // if the MethodExpression is an instance of our private // wrapper class. if (me.getClass().equals(MethodExpressionMethodBindingAdapter.class)) { result = ((MethodExpressionMethodBindingAdapter) me).getWrapped(); } else { // otherwise, this is a real MethodExpression. Wrap it // in a MethodBinding. result = new MethodBindingMethodExpressionAdapter(me); } } return result; } Deprecated! `This` - has been replaced by #getActionExpression . {@inheritDoc}
public MethodExpression getActionExpression() { return (MethodExpression) getStateHelper().get(PropertyKeys.actionExpression); }
public MethodBinding getActionListener() { return (MethodBinding) getStateHelper().get(PropertyKeys.methodBindingActionListener); } Deprecated! `Use` - #getActionListeners instead. {@inheritDoc}
public ActionListener[] getActionListeners() { ActionListener al[] = (ActionListener []) getFacesListeners(ActionListener.class); return (al); }
public String getFamily() { return (COMPONENT_FAMILY); }
public Object getValue() { return getStateHelper().eval(PropertyKeys.value); } Returns the `value` property of the `UICommand`. This is most often rendered as a label.
public boolean isImmediate() { return (Boolean) getStateHelper().eval(PropertyKeys.immediate, false); } The immediate flag.
public void queueEvent(FacesEvent e) { UIComponent c = e.getComponent(); if (e instanceof ActionEvent && c instanceof ActionSource) { if (((ActionSource) c).isImmediate()) { e.setPhaseId(PhaseId.APPLY_REQUEST_VALUES); } else { e.setPhaseId(PhaseId.INVOKE_APPLICATION); } } super.queueEvent(e); } 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.
public void removeActionListener(ActionListener listener) { removeFacesListener(listener); }
public void setAction(MethodBinding action) { MethodExpressionMethodBindingAdapter adapter; if (null != action) { adapter = new MethodExpressionMethodBindingAdapter(action); setActionExpression(adapter); } else { setActionExpression(null); } } Deprecated! `This` - has been replaced by #setActionExpression(javax.el.MethodExpression) . {@inheritDoc}
public void setActionExpression(MethodExpression actionExpression) { getStateHelper().put(PropertyKeys.actionExpression, actionExpression); }
public void setActionListener(MethodBinding actionListener) { getStateHelper().put(PropertyKeys.methodBindingActionListener, actionListener); } Deprecated! `This` - has been replaced by #addActionListener(javax.faces.event.ActionListener) . {@inheritDoc}
public void setImmediate(boolean immediate) { getStateHelper().put(PropertyKeys.immediate, immediate); }
public void setValue(Object value) { getStateHelper().put(PropertyKeys.value, value); } Sets the `value` property of the `UICommand`. This is most often rendered as a label.

Method from javax.faces.component.UICommand Detail:

 public  void addActionListener(ActionListener listener) {
        addFacesListener(listener);
}

 public  void broadcast(FacesEvent event) throws AbortProcessingException {
        // Perform standard superclass processing (including calling our
        // ActionListeners)
        super.broadcast(event);
        if (event instanceof ActionEvent) {
            FacesContext context = getFacesContext();
            // Notify the specified action listener method (if any)
            MethodBinding mb = getActionListener();
            if (mb != null) {
                mb.invoke(context, new Object[] { event });
            }
            // Invoke the default ActionListener
            ActionListener listener =
              context.getApplication().getActionListener();
            if (listener != null) {
                listener.processAction((ActionEvent) event);
            }
        }
}

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 .

 public MethodBinding getAction() {
        MethodBinding result = null;
        MethodExpression me;
        if (null != (me = getActionExpression())) {
            // if the MethodExpression is an instance of our private
            // wrapper class.
            if (me.getClass().equals(MethodExpressionMethodBindingAdapter.class)) {
                result = ((MethodExpressionMethodBindingAdapter) me).getWrapped();
            } else {
                // otherwise, this is a real MethodExpression.  Wrap it
                // in a MethodBinding.
                result = new MethodBindingMethodExpressionAdapter(me);
            }
        }
        return result;
}

Deprecated! This - has been replaced by #getActionExpression .

{@inheritDoc}

 public MethodExpression getActionExpression() {
        return (MethodExpression) getStateHelper().get(PropertyKeys.actionExpression);
}

 public MethodBinding getActionListener() {
        return (MethodBinding) getStateHelper().get(PropertyKeys.methodBindingActionListener);
}

Deprecated! Use - #getActionListeners instead.

{@inheritDoc}

 public ActionListener[] getActionListeners() {
        ActionListener al[] = (ActionListener [])
        getFacesListeners(ActionListener.class);
        return (al);
}

 public String getFamily() {
        return (COMPONENT_FAMILY);
}

 public Object getValue() {
        return getStateHelper().eval(PropertyKeys.value);
}

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

 public boolean isImmediate() {
        return (Boolean) getStateHelper().eval(PropertyKeys.immediate, false);
}

The immediate flag.

 public  void queueEvent(FacesEvent e) {
        UIComponent c = e.getComponent();
        if (e instanceof ActionEvent && c instanceof ActionSource) {
            if (((ActionSource) c).isImmediate()) {
                e.setPhaseId(PhaseId.APPLY_REQUEST_VALUES);
            } else {
                e.setPhaseId(PhaseId.INVOKE_APPLICATION);
            }
        }
        super.queueEvent(e);
}

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.

 public  void removeActionListener(ActionListener listener) {
        removeFacesListener(listener);
}

 public  void setAction(MethodBinding action) {
        MethodExpressionMethodBindingAdapter adapter;
        if (null != action) {
            adapter = new MethodExpressionMethodBindingAdapter(action);
            setActionExpression(adapter);
        } else {
            setActionExpression(null);
        }
}

Deprecated! This - has been replaced by #setActionExpression(javax.el.MethodExpression) .

{@inheritDoc}

 public  void setActionExpression(MethodExpression actionExpression) {
        getStateHelper().put(PropertyKeys.actionExpression, actionExpression);
}

 public  void setActionListener(MethodBinding actionListener) {
        getStateHelper().put(PropertyKeys.methodBindingActionListener, actionListener);
}

Deprecated! This - has been replaced by #addActionListener(javax.faces.event.ActionListener) .

{@inheritDoc}

 public  void setImmediate(boolean immediate) {
        getStateHelper().put(PropertyKeys.immediate, immediate);
}

 public  void setValue(Object value) {
        getStateHelper().put(PropertyKeys.value, value);
}

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