Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: UICommand.java,v 1.79.4.3 2007/10/18 16:57:29 rlubke Exp $
   */
  
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   * 
   * Copyright 1997-2007 Sun Microsystems, Inc. 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 https://glassfish.dev.java.net/public/CDDL+GPL.html
  * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath" exception
  * as provided by Sun in the GPL Version 2 section of the License file that
  * accompanied this code.  If applicable, add the following below the License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [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";
    // ------------------------------------------------------------ Constructors


    

Create a new UICommand instance with default property values.

    public UICommand() {
        super();
        setRendererType("javax.faces.Button");
    }
    // ------------------------------------------------------ Instance Variables
    private Object value = null;
    // -------------------------------------------------------------- Properties
    public String getFamily() {
        return ();
    }
    // ------------------------------------------------- ActionSource/ActionSource2 Properties


    

Deprecated:
This has been replaced by getActionExpression().
    public MethodBinding getAction() {
	MethodBinding result = null;
	if (null != (me = getActionExpression())) {
	    // if the MethodExpression is an instance of our private
	    // wrapper class.
	    }
	    else {
		// otherwise, this is a real MethodExpression.  Wrap it
		// in a MethodBinding.
	    }
	}
	return result;
	    
    }

    

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

Deprecated:
Use getActionListeners() instead.
    public MethodBinding getActionListener() {
        return this.;
    }

    

Deprecated:
This has been replaced by addActionListener(javax.faces.event.ActionListener).
    public void setActionListener(MethodBinding actionListener) {
        this. = actionListener;
    } 

    

The immediate flag.

    private Boolean immediate;
    public boolean isImmediate() {
	if (this. != null) {
	    return (this.);
	}
	ValueExpression ve = getValueExpression("immediate");
	if (ve != null) {
	    try {
	    }
	    catch (ELException e) {
		throw new FacesException(e);
	    }
else {
	    return (false);
	}
    }
    public void setImmediate(boolean immediate) {
        this. = immediate;
    }



    

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

    public Object getValue() {
	if (this. != null) {
	    return (this.);
	}
	if (ve != null) {
	    try {
	    }
	    catch (ELException e) {
		throw new FacesException(e);
	    }
else {
	    return (null);
	}
    }


    

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

Parameters:
value the new value
    public void setValue(Object value) {
        this. = value;
    }
    
    private MethodBinding methodBindingActionListener = null;
    // ---------------------------------------------------- ActionSource / ActionSource2 Methods

    
    

The javax.el.MethodExpression that, when invoked, yields the literal outcome value.

    private MethodExpression actionExpression = null;
    
        return ;
    }
    
    public void setActionExpression(MethodExpression actionExpression) {
        this. = actionExpression;    
    }
    
    
 
    public void addActionListener(ActionListener listener) {
        addFacesListener(listener);
    }
    
    public ActionListener[] getActionListeners() {
        ActionListener al[] = (ActionListener [])
        return (al);
    }



    
 
    public void removeActionListener(ActionListener listener) {
        removeFacesListener(listener);
    }
    // ----------------------------------------------------- StateHolder Methods
    private Object[] values;
    public Object saveState(FacesContext context) {
        if ( == null) {
              = new Object[5];
        }
      
        [0] = super.saveState(context);
        [1] = saveAttachedState(context);
        [2] = saveAttachedState(context);
        [3] = ;
        [4] = ;
        
        return ();
    }
    public void restoreState(FacesContext contextObject state) {
         = (Object[]) state;
        super.restoreState(context, values[0]);
            restoreAttachedState(context[1]);
         = 
         = (Boolean[3];
         = [4];
        
    }
    // ----------------------------------------------------- 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.

Parameters:
event javax.faces.event.FacesEvent to be broadcast
Throws:
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)
        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(contextnew Object[] { event });
            }
            // Invoke the default ActionListener
            ActionListener listener =
              context.getApplication().getActionListener();
            if (listener != null) {
                listener.processAction((ActionEventevent);
            }
        }
    }

    

Intercept queueEvent and, for javax.faces.event.ActionEvents, mark the phaseId for the event to be PhaseId.APPLY_REQUEST_VALUES if the immediate flag is true, PhaseId.INVOKE_APPLICATION otherwise.

    public void queueEvent(FacesEvent e) {
        UIComponent c = e.getComponent();
        if (e instanceof ActionEvent && c instanceof ActionSource) {
            if (((ActionSourcec).isImmediate()) {
                e.setPhaseId(.);
            } else {
                e.setPhaseId(.);
            }
        }
        super.queueEvent(e);
    }
New to GrepCode? Check out our FAQ X