/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
    *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package javax.faces.component;
  
  import javax.el.MethodExpression;
  import javax.el.ValueExpression;
  import javax.faces.context.FacesContext;
  import javax.faces.el.MethodBinding;
  import javax.faces.event.AbortProcessingException;
  import javax.faces.event.ActionEvent;
  import javax.faces.event.ActionListener;
  import javax.faces.event.FacesEvent;
  import javax.faces.event.PhaseId;
  
  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFListener;
  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
  
  /**
   * 
   * UICommand is a base abstraction for components that implement ActionSource.
   * 
   */
  @JSFComponent(defaultRendererType = "javax.faces.Button")
  public class UICommand extends UIComponentBase implements ActionSource2
  {
      public static final String COMPONENT_TYPE = "javax.faces.Command";
      public static final String COMPONENT_FAMILY = "javax.faces.Command";
  
      private boolean _immediate;
      private boolean _immediateSet;
      private Object _value;
      private MethodExpression _actionExpression;
      private MethodBinding _actionListener;
  
      /**
       * Construct an instance of the UICommand.
       */
      public UICommand()
      {
          setRendererType("javax.faces.Button");
      }
  
      /**
       * Specifies the action to take when this command is invoked.
       * <p>
       * If the value is an expression, it is expected to be a method 
       * binding EL expression that identifies an action method. An action method
       * accepts no parameters and has a String return value, called the action
       * outcome, that identifies the next view displayed. The phase that this
       * event is fired in can be controlled via the immediate attribute.
       * </p>
       * <p>
       * If the value is a string literal, it is treated as a navigation outcome
       * for the current view.  This is functionally equivalent to a reference to
       * an action method that returns the string literal.
       * </p>
       * 
       * @deprecated Use getActionExpression() instead.
       */
      public MethodBinding getAction()
      {
          MethodExpression actionExpression = getActionExpression();
          if (actionExpression instanceof _MethodBindingToMethodExpression)
          {
              return ((_MethodBindingToMethodExpression) actionExpression)
                      .getMethodBinding();
          }
          if (actionExpression != null)
          {
              return new _MethodExpressionToMethodBinding(actionExpression);
          }
          return null;
      }
  
      /**
       * @deprecated Use setActionExpression instead.
       */
      public void setAction(MethodBinding action)
      {
          if (action != null)
          {
              setActionExpression(new _MethodBindingToMethodExpression(action));
         }
         else
         {
             setActionExpression(null);
         }
     }
 
     @Override
     public void broadcast(FacesEvent event) throws AbortProcessingException
     {
         super.broadcast(event);
 
         if (event instanceof ActionEvent)
         {
             FacesContext context = getFacesContext();
 
             MethodBinding mb = getActionListener();
             if (mb != null)
             {
                 mb.invoke(context, new Object[]
                 { event });
             }
 
             ActionListener defaultActionListener = context.getApplication()
                     .getActionListener();
             if (defaultActionListener != null)
             {
                 defaultActionListener.processAction((ActionEvent) event);
             }
         }
     }
 
     @Override
     public void queueEvent(FacesEvent event)
     {
         if (event != null && event instanceof ActionEvent)
         {
             UIComponent component = event.getComponent();
             if (component instanceof ActionSource)
             {
                 if (((ActionSource)component).isImmediate())
                 {
                     event.setPhaseId(PhaseId.APPLY_REQUEST_VALUES);
                 }
                 else
                 {
                     event.setPhaseId(PhaseId.INVOKE_APPLICATION);
                 }
             }
         }
         super.queueEvent(event);
     }
 
     /**
      * A boolean value that identifies the phase during which action events
      * should fire.
      * <p>
      * During normal event processing, action methods and action listener methods are fired during the
      * "invoke application" phase of request processing. If this attribute is set to "true", these methods
      * are fired instead at the end of the "apply request values" phase.
      * </p>
      */
     @JSFProperty
     public boolean isImmediate()
     {
         if (_immediateSet)
         {
             return _immediate;
         }
         ValueExpression expression = getValueExpression("immediate");
         if (expression != null)
         {
             return (Boolean) expression.getValue(getFacesContext()
                     .getELContext());
         }
         return false;
     }
 
     public void setImmediate(boolean immediate)
     {
         this._immediate = immediate;
         this._immediateSet = true;
     }
 
     /**
      * The text to display to the user for this command component.
      */
     @JSFProperty
     public Object getValue()
     {
         if (_value != null)
         {
             return _value;
         }
         ValueExpression expression = getValueExpression("value");
         if (expression != null)
         {
             return expression.getValue(getFacesContext().getELContext());
         }
         return null;
     }
 
     public void setValue(Object value)
     {
         this._value = value;
     }
 
     /**
      * The action to take when this command is invoked.
      * <p>
      * If the value is an expression, it is expected to be a method binding EL expression that identifies
      * an action method. An action method accepts no parameters and has a String return value, called the
      * action outcome, that identifies the next view displayed. The phase that this event is fired in
      * can be controlled via the immediate attribute.
      * </p>
      * <p> 
      * If the value is a string literal, it is treated as a navigation outcome for the current view. This
      * is functionally equivalent to a reference to an action method that returns the string literal.
      * </p>
      */
     @JSFProperty(stateHolder = true, returnSignature = "java.lang.Object", jspName = "action")
     public MethodExpression getActionExpression()
     {
         if (_actionExpression != null)
         {
             return _actionExpression;
         }
         ValueExpression expression = getValueExpression("actionExpression");
         if (expression != null)
         {
             return (MethodExpression) expression.getValue(getFacesContext()
                     .getELContext());
         }
         return null;
     }
 
     public void setActionExpression(MethodExpression actionExpression)
     {
         this._actionExpression = actionExpression;
     }
 
     /**
      * A method binding EL expression that identifies an action listener method to be invoked if
      * this component is activated by the user.
      * <p>
      * An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void.
      * The phase that this event is fired in can be controlled via the immediate attribute.
      * 
      * @deprecated
      */
     @JSFProperty(stateHolder = true, returnSignature = "void", methodSignature = "javax.faces.event.ActionEvent")
     public MethodBinding getActionListener()
     {
         if (_actionListener != null)
         {
             return _actionListener;
         }
         ValueExpression expression = getValueExpression("actionListener");
         if (expression != null)
         {
             return (MethodBinding) expression.getValue(getFacesContext()
                     .getELContext());
         }
         return null;
     }
 
     /**
      * @deprecated
      */
     @JSFProperty(returnSignature="void",methodSignature="javax.faces.event.ActionEvent")
     public void setActionListener(MethodBinding actionListener)
     {
         this._actionListener = actionListener;
     }
 
     public void addActionListener(ActionListener listener)
     {
         addFacesListener(listener);
     }
 
     public void removeActionListener(ActionListener listener)
     {
         removeFacesListener(listener);
     }
 
     /**
      * Event delivered when the "action" of the component has been
      * invoked; for example, by clicking on a button. The action may result 
      * in page navigation.
      */
     @JSFListener(event="javax.faces.event.ActionEvent",
             phases="Invoke Application, Apply Request Values")
     public ActionListener[] getActionListeners()
     {
         return (ActionListener[]) getFacesListeners(ActionListener.class);
     }
 
     @Override
     public Object saveState(FacesContext facesContext)
     {
         Object[] values = new Object[6];
         values[0] = super.saveState(facesContext);
         values[1] = _immediate;
         values[2] = _immediateSet;
         values[3] = _value;
         values[4] = saveAttachedState(facesContext, _actionExpression);
         values[5] = saveAttachedState(facesContext, _actionListener);
 
         return values;
     }
 
     @Override
     public void restoreState(FacesContext facesContext, Object state)
     {
         Object[] values = (Object[]) state;
         super.restoreState(facesContext, values[0]);
         _immediate = (Boolean) values[1];
         _immediateSet = (Boolean) values[2];
         _value = values[3];
         _actionExpression = (MethodExpression) restoreAttachedState(
                 facesContext, values[4]);
         _actionListener = (MethodBinding) restoreAttachedState(facesContext,
                 values[5]);
     }
 
     @Override
     public String getFamily()
     {
         return COMPONENT_FAMILY;
     }
 }