Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
 package javax.faces.component;

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 javax.faces.render.Renderer, detects that this control has been activated, it will queue an javax.faces.event.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:

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

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

 public class UICommand extends UIComponentBase
     implements ActionSource2 {
     // ------------------------------------------------------ Manifest Constants


The standard component type for this component.

     public static final String COMPONENT_TYPE = "javax.faces.Command";


The standard component family for this component.

     public static final String COMPONENT_FAMILY = "javax.faces.Command";

Properties that are tracked by state saving.
    enum PropertyKeys {
    // ------------------------------------------------------------ Constructors


Create a new UICommand instance with default property values.

    public UICommand() {
    // -------------------------------------------------------------- Properties
    public String getFamily() {
        return ();
    // ------------------------------------------------- ActionSource/ActionSource2 Properties


This has been replaced by getActionExpression().
    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 = ((MethodExpressionMethodBindingAdapterme).getWrapped();
            } else {
                // otherwise, this is a real MethodExpression.  Wrap it
                // in a MethodBinding.
                result = new MethodBindingMethodExpressionAdapter(me);
        return result;


This has been replaced by setActionExpression(javax.el.MethodExpression).
    public void setAction(MethodBinding action) {
        MethodExpressionMethodBindingAdapter adapter;
        if (null != action) {
            adapter = new MethodExpressionMethodBindingAdapter(action);
        } else {

Use getActionListeners() instead.
    public MethodBinding getActionListener() {


This has been replaced by addActionListener(javax.faces.event.ActionListener).
    public void setActionListener(MethodBinding actionListener) {


The immediate flag.

    //private Boolean immediate;
    public boolean isImmediate() {
        return (BooleangetStateHelper().eval(.false);
    public void setImmediate(boolean immediate) {


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

    public Object getValue() {
        return getStateHelper().eval(.);


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

value the new value
    public void setValue(Object value) {
    // ---------------------------------------------------- ActionSource / ActionSource2 Methods
    public void setActionExpression(MethodExpression actionExpression) {
    public void addActionListener(ActionListener listener) {
    public ActionListener[] getActionListeners() {
        ActionListener al[] = (ActionListener [])
        return (al);

    public void removeActionListener(ActionListener listener) {
    // ----------------------------------------------------- UIComponent Methods


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

event javax.faces.event.FacesEvent to be broadcast
javax.faces.event.AbortProcessingException Signal the JavaServer Faces implementation that no further processing on the current event should be performed
java.lang.IllegalArgumentException if the implementation class of this javax.faces.event.FacesEvent is not supported by this component
java.lang.NullPointerException if event is null
    public void broadcast(FacesEvent eventthrows AbortProcessingException {
        // Perform standard superclass processing (including calling our
        // ActionListeners)
        if (event instanceof ActionEvent) {
            FacesContext context = getFacesContext();
            // Notify the specified action listener method (if any)
            MethodBinding mb = getActionListener();
            if (mb != null) {
                mb.invoke(contextnew Object[] { event });
            // Invoke the default ActionListener
            ActionListener listener =
            if (listener != null) {


Intercept queueEvent and take the following action. If the event is an javax.faces.event.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 queueEvent(FacesEvent e) {
        UIComponent c = e.getComponent();
        if (e instanceof ActionEvent && c instanceof ActionSource) {
            if (((ActionSourcec).isImmediate()) {
            } else {
New to GrepCode? Check out our FAQ X