package com.explosion.expf.supportmodules;
   
   /*
    * =============================================================================
    * 
    * 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.Hashtable;
  import java.util.Properties;
  import java.util.Vector;
  
  import javax.swing.JButton;
  import javax.swing.JPanel;
  import javax.swing.KeyStroke;
  
  import com.explosion.expf.Application;
  import com.explosion.expf.ExpActionListener;
  import com.explosion.expf.ExpConstants;
  import com.explosion.expf.ExpFrame;
  import com.explosion.expf.ExpModuleManager;
  import com.explosion.expf.menusandtools.menu.ExpMenu;
  import com.explosion.expf.menusandtools.menu.ExpMenuBar;
  import com.explosion.expf.menusandtools.menu.MenuHelper;
  import com.explosion.expf.menusandtools.menu.segmented.ExpMenuSegment;
  import com.explosion.expf.menusandtools.menu.segmented.ExpSegmentedMenu;
  import com.explosion.expf.menusandtools.tool.ExpToolBar;
  import com.explosion.expf.menusandtools.tool.ExpToolBarSegment;
  import com.explosion.utilities.preferences.Preference;
  
  /***
   * Author: Stephen Cowx Date: Dec 1, 2002 Time: 12:50:18 PM
   * 
   * This ExpModuleManager sets up theApplication with support (menu's , button
   * etc) for editing.
   */
  
  public class FileSupportModule implements ExpModuleManager
  {
  
      private Vector preferences;
      private Hashtable preferenceHash;
  
      private static String newMenuItemName = "New";
      private static String openMenuItemName = "Open";
      private static String saveMenuItemName = "Save";
      private static String saveAsMenuItemName = "Save As";
      private static String saveAllMenuItemName = "Save All";
      private static String closeMenuItemName = "Close";
      private static String closeAllMenuItemName = "Close All";
  
      public void initialiseGui() throws Exception
      {
          ExpMenuBar menuBar = ((ExpFrame) Application.getApplicationFrame()).getExpMenuBar();
          MenuHelper helper = menuBar.getMenuHelper();
          ExpMenu menuFile = (ExpMenu) helper.getMenu(ExpConstants.MENU_FILE);
  
          populateFileMenuSegment(helper, menuFile);
  
          /* Toolbar buttons */
          ExpToolBar toolbar = ((ExpFrame) Application.getApplicationFrame()).getExpToolBar();
          ExpToolBarSegment openclose = toolbar.createNewSegment(ExpToolBarSegment.ANY_POSITION);
  
          JButton newButton = toolbar.createExpToolBarItem(ExpConstants.DEFAULT_NEW_ICON, "New", ExpConstants.MENU_NEW, 1);
          JButton openButton = toolbar.createExpToolBarItem(ExpConstants.DEFAULT_FILEOPEN_ICON, "Open", ExpConstants.MENU_OPEN, 1);
          JButton saveButton = toolbar.createExpToolBarItem(ExpConstants.DEFAULT_FILESAVE_ICON, "Save", ExpConstants.MENU_SAVE, 1);
  
          openclose.addElement(newButton);
          openclose.addElement(openButton);
          openclose.addElement(saveButton);
          openclose.addElement(null);
      }
  
      /***
       * @param helper
       * @param menuFile
       * @throws Exception
       */
      public static void populateFileMenuSegment(MenuHelper helper, ExpSegmentedMenu menu) throws Exception
      {
          /* File menu */
          ExpMenuSegment newSegment = menu.createNewSegment(ExpMenuSegment.ALWAYS_FIRST_SEGMENT);
          newSegment.addElement(helper.createMenuItem(newMenuItemName, 'n', ExpConstants.MENU_NEW, KeyStroke.getKeyStroke(KeyEvent.VK_N, KeyEvent.CTRL_MASK), 1));
          newSegment.addElement(helper.createMenuItem(openMenuItemName, 'o', ExpConstants.MENU_OPEN, KeyStroke.getKeyStroke(KeyEvent.VK_O, KeyEvent.CTRL_MASK), 1));
         
         ExpMenuSegment saveSegment = menu.createNewSegment(ExpMenuSegment.ANY_POSITION);
         saveSegment.addElement(helper.createMenuItem(saveMenuItemName, 's', ExpConstants.MENU_SAVE, KeyStroke.getKeyStroke(KeyEvent.VK_S, KeyEvent.CTRL_MASK), 1));
         saveSegment.addElement(helper.createMenuItem(saveAsMenuItemName, 'a', ExpConstants.MENU_SAVEAS, KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.CTRL_MASK), 1));
         saveSegment.addElement(helper.createMenuItem(saveAllMenuItemName, 'v', ExpConstants.MENU_SAVEALL, null, 2));
         
         ExpMenuSegment closeSegment = menu.createNewSegment(ExpMenuSegment.ANY_POSITION);
         closeSegment.addElement(helper.createMenuItem(closeMenuItemName, 'c', ExpConstants.MENU_CLOSE, null, 1));
         closeSegment.addElement(helper.createMenuItem(closeAllMenuItemName, 'l', ExpConstants.MENU_CLOSEALL, null, 2));
     }
     
     /***
      * @param helper
      * @param menuFile
      * @throws Exception
      */
     public static void populateSaveAndCloseSegment(MenuHelper helper, ExpMenuSegment segment) throws Exception
     {
         segment.addElement(helper.createMenuItem(saveMenuItemName, 's', ExpConstants.MENU_SAVE, KeyStroke.getKeyStroke(KeyEvent.VK_S, KeyEvent.CTRL_MASK), 1));
         segment.addElement(helper.createMenuItem(saveAsMenuItemName, 'a', ExpConstants.MENU_SAVEAS, KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.CTRL_MASK), 1));
         segment.addElement(helper.createMenuItem(closeMenuItemName, 'c', ExpConstants.MENU_CLOSE, null, 1));
     }
 
     public String getVersion()
     {
         return "1.0";
     }
 
     public String getName()
     {
         return "File Support";
     }
 
     public String getDescription()
     {
         return "Menu and toolbar support for opening, closing and saving multiple files.";
     }
 
     public void initialiseCore(Properties properties)
     {
 
         String newName = properties.getProperty(ExpConstants.MENU_NEW);
         if (newName != null)
             newMenuItemName = newName;
 
         String openName = properties.getProperty(ExpConstants.MENU_OPEN);
         if (openName != null)
             openMenuItemName = openName;
 
         String saveName = properties.getProperty(ExpConstants.MENU_SAVE);
         if (saveName != null)
             saveMenuItemName = saveName;
 
         String saveAsName = properties.getProperty(ExpConstants.MENU_SAVEAS);
         if (saveAsName != null)
             saveAsMenuItemName = saveAsName;
 
         String saveAllName = properties.getProperty(ExpConstants.MENU_SAVEALL);
         if (saveAllName != null)
             saveAllMenuItemName = saveAllName;
 
         String closeName = properties.getProperty(ExpConstants.MENU_CLOSE);
         if (closeName != null)
             closeMenuItemName = closeName;
 
         String closeAllName = properties.getProperty(ExpConstants.MENU_CLOSEALL);
         if (closeAllName != null)
             closeAllMenuItemName = closeAllName;
     }
 
     public Vector getPreferences()
     {
         return preferences;
     }
 
     public Preference getPreference(String preferenceName)
     {
         return (Preference) preferenceHash.get(preferenceName);
     }
 
     public JPanel getPreferencesEditor()
     {
         return null;
     }
 
     public ExpActionListener getGlobalListener()
     {
         return null;
     }
 
 }