/*
    * 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 org.apache.myfaces.custom.navmenu;
  
  import java.util.Iterator;
  import java.util.StringTokenizer;
  
  import javax.faces.component.ActionSource;
  import javax.faces.component.UIComponent;
  import javax.faces.component.UISelectItem;
  import javax.faces.context.FacesContext;
  import javax.faces.el.EvaluationException;
  import javax.faces.el.MethodBinding;
  import javax.faces.el.ValueBinding;
  import javax.faces.event.AbortProcessingException;
  import javax.faces.event.ActionEvent;
  import javax.faces.event.ActionListener;
  import javax.faces.event.FacesEvent;
  
  import org.apache.myfaces.component.UserRoleAware;
  import org.apache.myfaces.component.UserRoleUtils;
  import org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlCommandNavigationItem;
  import org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlPanelNavigationMenu;
  
  /**
   * A menu item. Used by navigationMenu, jscookMenu. 
   * 
   * Unless otherwise specified, all attributes accept static values or EL expressions.
   * 
   * @JSFComponent
   *   name = "t:navigationMenuItem"
   *   bodyContent = "JSP"
   *   class = "org.apache.myfaces.custom.navmenu.UINavigationMenuItem"
   *   tagClass = "org.apache.myfaces.custom.navmenu.HtmlNavigationMenuItemTag"
   * @since 1.1.7
   * @author Thomas Spiegl (latest modification by $Author: lu4242 $)
   * @version $Revision: 719425 $ $Date: 2008-11-20 18:41:15 -0500 (Thu, 20 Nov 2008) $
   */
  public abstract class AbstractUINavigationMenuItem extends UISelectItem implements
      UserRoleAware, ActionSource {
      private static final boolean DEFAULT_IMMEDIATE = true;
  
      public static final String COMPONENT_TYPE = "org.apache.myfaces.NavigationMenuItem";
      public static final String COMPONENT_FAMILY = "javax.faces.SelectItem";
  
      public AbstractUINavigationMenuItem() {
          super();
      }
  
      public String getFamily() {
          return COMPONENT_FAMILY;
      }
  
      /**
       * @JSFProperty 
       */
      public abstract String getIcon();
  
      /**
       * @JSFProperty
       *   defaultValue="false" 
       */
      public abstract boolean isSplit();
  
      /**
       * @JSFProperty
       *   defaultValue="false" 
       *   tagExcluded = "true"
       */
      public abstract boolean isOpen();
      
      public abstract void setOpen(boolean open);
  
      public abstract void setActive(boolean active);
  
      /**
       * @JSFProperty
       *   defaultValue="false"
       *   tagExcluded = "true"
       */
      public abstract boolean isActive();
  
      /**
      * @JSFProperty
      *   defaultValue="true" 
      *   tagExcluded="true"
      */
     public abstract boolean isImmediate();
 
     /**
      * @JSFProperty
      *   tagExcluded = "true"
      */
     public abstract String getExternalLink();
 
     // Action Source
     public abstract void setAction(MethodBinding action);
 
     /**
      * Specifies the action to take when this command is invoked.
      *
      * 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.
      *
      * 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.
      * 
      * @JSFProperty
      *   stateHolder = "true"
      *   literalOnly = "true"
      *   returnSignature="java.lang.String"
      */
     public abstract MethodBinding getAction();
     
     public abstract void setActionListener(MethodBinding actionListener);
 
     /**
      * A method binding EL expression that identifies an action listener method
      * to be invoked if this component is activated by the user. 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.
      *  
      * @JSFProperty
      *   stateHolder = "true"
      *   literalOnly = "true"
      *   returnSignature="void"
      *   methodSignature="javax.faces.event.ActionEvent"
      */
     public abstract MethodBinding getActionListener();
 
     public void addActionListener(ActionListener listener) {
         addFacesListener(listener);
     }
 
     public ActionListener[] getActionListeners() {
         return (ActionListener[]) getFacesListeners(ActionListener.class);
     }
 
     public void removeActionListener(ActionListener listener) {
         removeFacesListener(listener);
     }
 
     // Action Source
 
     /**
      * 
      * @JSFProperty 
      */
     public abstract String getTarget();
 
     /**
      * When set instead of a Hyperlink a span tag is rendered in 
      * the corresponding Component
      * 
      * @JSFProperty
      *   defaultValue="false" 
      */
     public abstract boolean isDisabled();
 
     /**
      * CSS-Style Attribute to render when disabled is true
      * 
      * @JSFProperty 
      */
     public abstract String getDisabledStyle();
 
     /**
      * @see javax.faces.component.UIComponent#broadcast(javax.faces.event.FacesEvent)
      */
     public void broadcast(FacesEvent event) throws AbortProcessingException {
         super.broadcast(event);
 
         if (event instanceof ActionEvent) {
             FacesContext context = getFacesContext();
 
             MethodBinding actionListenerBinding = getActionListener();
             if (actionListenerBinding != null) {
                 try {
                     actionListenerBinding.invoke(context,
                                                  new Object[]{event});
                 }
                 catch (EvaluationException e) {
                     Throwable cause = e.getCause();
                     if (cause != null
                         && cause instanceof AbortProcessingException) {
                         throw (AbortProcessingException) cause;
                     }
                     else {
                         throw e;
                     }
                 }
             }
 
             ActionListener defaultActionListener = context.getApplication()
                 .getActionListener();
             if (defaultActionListener != null) {
                 defaultActionListener.processAction((ActionEvent) event);
             }
         }
     }
 
     /**
      * CSS-Style Class to use when disabled is true
      * 
      * @JSFProperty 
      */
     public abstract String getDisabledStyleClass();
 
     /**
      * @JSFProperty
      *   localMethod="true"
      *   tagExcluded = "true" 
      */
     public abstract String getActiveOnViewIds();
     
     protected abstract String getLocalActiveOnViewIds();
     
     public String getActiveOnViewIdsDirectly() {
         return getLocalActiveOnViewIds();
     }
 
     //START isRendered hack
     //UISelectItem and UISelectItems does not use rendered 
     //(inherited from UIComponentBase)
     //but this components use it, so we need to implement it
     //here (isInherited hack does not work because custom code 
     //is added on isRendered, so the variable must be defined
     //here).
     
     private static final boolean DEFAULT_RENDERED = true;
     
     private Boolean _rendered = null;
     
     /**
      * A boolean value that indicates whether this component should be rendered.
      * Default value: true.
      * 
      * @JSFProperty tagExcluded = "false"
      */
     public boolean isRendered() {
         if (!UserRoleUtils.isVisibleOnUserRole(this))
             return false;
         //return super.isRendered();
         if (_rendered != null) return _rendered.booleanValue();
         ValueBinding vb = getValueBinding("rendered");
         Boolean v = vb != null ? (Boolean)vb.getValue(getFacesContext()) : null;
         return v != null ? v.booleanValue() : DEFAULT_RENDERED;
     }
     
     public void setRendered(boolean rendered)
     {
         _rendered = Boolean.valueOf(rendered);
     }
     
     public Object saveState(FacesContext facesContext)
     {
         Object[] values = new Object[2];
         values[0] = super.saveState(facesContext);
         values[1] = _rendered;
         return values; 
     }
 
     public void restoreState(FacesContext facesContext, Object state)
     {
         Object[] values = (Object[])state;
         super.restoreState(facesContext,values[0]);
         _rendered = (java.lang.Boolean) values[1];
     }
     //END isRendered hack
     
     public void toggleActive(FacesContext context) {
         StringTokenizer tokenizer = new StringTokenizer(this.getActiveOnViewIdsDirectly(), ";");
         while (tokenizer.hasMoreTokens()) {
             String token = tokenizer.nextToken();
             if (token.trim().equals(context.getViewRoot().getViewId())) {
                 this.deactivateAll();
                 this.setActive(true);
                 openParents();
             }
             else {
                 this.setActive(false);
             }
         }
     }
 
     private void openParents() {
         UIComponent comp = this;
 
         while ((comp = comp.getParent()) instanceof AbstractUINavigationMenuItem) {
             AbstractUINavigationMenuItem parent = (AbstractUINavigationMenuItem) comp;
             if (!parent.isOpen())
                 parent.setOpen(true);
             else
                 return;
         }
     }
 
     public void deactivateAll() {
         UIComponent parent = this.getParent();
         while (!(parent instanceof HtmlPanelNavigationMenu) && parent != null) {
             parent = parent.getParent();
         }
         if (parent == null) {
             throw new IllegalStateException("no PanelNavigationMenu!");
         }
 
         HtmlPanelNavigationMenu root = (HtmlPanelNavigationMenu) parent;
         for (Iterator it = root.getChildren().iterator(); it.hasNext();) {
             Object o = it.next();
             if (o instanceof AbstractUINavigationMenuItem) {
                 AbstractUINavigationMenuItem navItem = (AbstractUINavigationMenuItem) o;
                 navItem.setActive(false);
                 if (navItem.getChildCount() > 0) {
                     navItem.deactivateChildren();
                 }
             }
             if (o instanceof HtmlCommandNavigationItem) {
                 HtmlCommandNavigationItem current = (HtmlCommandNavigationItem) o;
                 current.setActive(false);
                 if (current.getChildCount() > 0) {
                     current.deactivateChildren();
                 }
             }
         }
     }
 
     public void deactivateChildren() {
         for (Iterator it = this.getChildren().iterator(); it.hasNext();) {
             Object o = it.next();
             if (o instanceof AbstractUINavigationMenuItem) {
                 AbstractUINavigationMenuItem current = (AbstractUINavigationMenuItem) o;
                 current.setActive(false);
                 if (current.getChildCount() > 0) {
                     current.deactivateChildren();
                 }
             }
         }
     }
 
     public Boolean getActiveDirectly() {
         return Boolean.valueOf(isActive());
     }
 }