package com.explosion.expf.menusandtools.menu;
   
   /* =============================================================================
    *       
    *     Copyright 2004 Stephen Cowx
    *
    *     Licensed 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.
   * 
   * =============================================================================
   */
  
  import java.awt.event.KeyEvent;
  import java.util.Iterator;
  import java.util.Vector;
  
  import javax.swing.JMenu;
  import javax.swing.JMenuBar;
  import javax.swing.JMenuItem;
  import javax.swing.KeyStroke;
  import javax.swing.UIManager;
  
  import com.explosion.expf.Application;
  import com.explosion.expf.ExpConstants;
  import com.explosion.expf.ExpListener;
  import com.explosion.expf.ExpLookAndFeel;
  import com.explosion.expf.menusandtools.menu.segmented.ExpMenuSegment;
  import com.explosion.utilities.exception.ExceptionManagerFactory;
  
  /***
   * This class has a hashtable called elements.  Every menu, menuItem or JCheckBoxMenuItem added
   * using the Add.. functions of this class are inserted into this Hashtable.  These
   * elements are all accessible via the getElement() method.  The getMenu method is a convenience method
   * whioch references the same hashtable.  The elements returned fromthe hashtable aregoing to
   * be one of three types. it is up to the user to decide what they are going to be.
   */
  
  public class ExpMenuBar extends JMenuBar
  {
    private ExpMenu menuFile;
    private ExpMenu menuHelp;
    private ExpMenu menuConfigure;
  
    private Vector topLevelMenus = new Vector();
    
    private MenuHelper menuHelper;
    
    public ExpMenuBar(ExpListener listener) throws Exception
    {
      menuHelper = new MenuHelper(listener);
      
      JMenuItem item = null;
      
      /* Set the name of this menu bar */
      this.setName(ExpConstants.COMPNAME_EXPMENUBAR);
  
      /* Main menu's */
      menuFile = createExpMenu("File", 'f', ExpConstants.MENU_FILE, 1, true);
      menuHelp = createExpMenu("Help", 'h', ExpConstants.MENU_HELP, 1, true);
      menuConfigure = createExpMenu("Tools", 't', ExpConstants.MENU_TOOLS, 1, true);
  
      /* Add file menu first - The others will get added later*/
      topLevelMenus.addElement(menuFile);
  
      /* File menu */
      ExpMenuSegment exitSegment = menuFile.createNewSegment(ExpMenuSegment.ALWAYS_LAST_SEGMENT);
      item = menuHelper.createMenuItem("Exit", 'x', ExpConstants.MENU_EXIT, KeyStroke.getKeyStroke(KeyEvent.VK_E, KeyEvent.CTRL_MASK), 1);
      exitSegment.addElement(item);
  
      /* Help menu */
      ExpMenuSegment helpSegment = menuHelp.createNewSegment(ExpMenuSegment.ANY_POSITION);
      helpSegment.addElement(menuHelper.createMenuItem("Help Contents", 'h', ExpConstants.MENU_HELP_CONTENTS, KeyStroke.getKeyStroke(KeyEvent.VK_F1, KeyEvent.CTRL_MASK), 1));
      helpSegment.addElement(menuHelper.createMenuItem("About", (char) 1, ExpConstants.MENU_ABOUT, null, 1));
      
      /* LAF menu */
      ExpMenu menuLAF = createExpMenu("Look And Feel", 'l', ExpConstants.MENU_LAF, 1, false);
      ExpMenuSegment LAFSegment = menuLAF.createNewSegment(ExpMenuSegment.ANY_POSITION);
      
      for (Iterator it = ExpConstants.looksList.iterator(); it.hasNext();)
      {
          ExpLookAndFeel lf = (ExpLookAndFeel) ExpConstants.looksMap.get(it.next());
          LAFSegment.addElement(menuHelper.createMenuItem(lf.getDisplayName(), (char)-1, lf.getActionName(), null, 1));
          if (UIManager.getLookAndFeel().getClass().getName().equals(lf.getClassName()))
          {
              Application.ensureGlobalCookie(lf.getActionName(),0);
          }
          else
          {
              Application.ensureGlobalCookie(lf.getActionName(),1);
          }
     }
 
     /* Configure menu */
     ExpMenuSegment configSegment = menuConfigure.createNewSegment(ExpMenuSegment.ALWAYS_LAST_SEGMENT);
     configSegment.addElement(menuLAF);
     configSegment.addElement(menuHelper.createMenuItem("Preferences", '0', ExpConstants.MENU_PROPERTIES, null, 1));
 
     /* Set up cookies for all of the static items eg Exit. */
     Application.addToGlobalCookie(ExpConstants.MENU_FILE,1);
     Application.addToGlobalCookie(ExpConstants.MENU_HELP,1);
     Application.addToGlobalCookie(ExpConstants.MENU_TOOLS,1);
     Application.addToGlobalCookie(ExpConstants.MENU_EXIT,1);
     Application.addToGlobalCookie(ExpConstants.MENU_ABOUT,1);
     Application.addToGlobalCookie(ExpConstants.MENU_HELP_CONTENTS,1);
 
     Application.addToGlobalCookie(ExpConstants.MENU_PROPERTIES,1);
     Application.addToGlobalCookie(ExpConstants.MENU_LAF,1);
     
     menuHelper.checkEnabled();
   }
 
   /***
    * Runs through the menus and adds them in recieved order or mapped order.  File ..... Config Help
   */
   public void constructMenus()
   {
     /* If there is a menuMap then we will add the top level menus as per the map. 
      * If not, we just add the menu's in the order they came in..(note) in the second 
      * case, the Help and Configure menu's are hardcoded into last position.
      */ 
     Vector menuMap = Application.getMenuMap();
     if (menuMap != null )
     {
        topLevelMenus = new Vector();
        for (int i = 0; i < menuMap.size(); i++)
        {
          Object item = menuHelper.getElement((String)menuMap.elementAt(i));
          if (item == null)
            ExceptionManagerFactory.getExceptionManager().manageException(new Exception("The menumap contains a reference ('"+menuMap.elementAt(i)+"') to an object which has not been created.  This object will not be added to the top level menus."),null);
          else if (!(item instanceof JMenu))
            ExceptionManagerFactory.getExceptionManager().manageException(new Exception("The menumap contains a reference ('"+menuMap.elementAt(i)+"') to an object which is not an instance of JMenu.  The object is an instance the '"+item.getClass().getName()+"' class.  This object will not be added to the top level menus."),null);
          else
          {
            JMenu menu = (JMenu) item;
            this.add(menu);
            topLevelMenus.addElement(menu);  	
          }  
        }
     }
     else
     {
       topLevelMenus.addElement(menuConfigure);
       topLevelMenus.addElement(menuHelp);
       this.add(menuHelp);
   
       for (int i = 0; i < topLevelMenus.size(); i++)
       {
         ExpMenu menu = (ExpMenu) topLevelMenus.elementAt(i);
         this.add(menu);
       }
     }
   }
   
 
   public Vector getTopLevelMenus()
   {
     return topLevelMenus;
   }
   
   /***
    *  This method adds a JMenu to a MenuBar
    */
   public ExpMenu createExpMenu(String menuText, char mnemonic, String actionCommand, int enabledThreshold, boolean isTopLevel)
   {
     ExpMenu menu = menuHelper.createExpMenu(menuText, mnemonic, actionCommand, enabledThreshold);
 
     /* If thisis a toplevel menu then add it to the list of toplevel menus */
     if (isTopLevel)
      topLevelMenus.addElement(menu);
 
     return menu;
   }
   
   /***
    * Returns the MenuHelper for this MenuBar
    * @return
    */
   public MenuHelper getMenuHelper()
   {
       return this.menuHelper;
   }
 }