package com.explosion.expf.menusandtools.tool;
   
   /* =============================================================================
    *       
    *     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.Dimension;
  import java.awt.Image;
  import java.util.Vector;
  
  import javax.swing.ImageIcon;
  import javax.swing.JButton;
  import javax.swing.JToolBar;
  
  import com.explosion.expf.Application;
  import com.explosion.expf.ExpConstants;
  import com.explosion.expf.ExpListener;
  import com.explosion.utilities.FileSystemUtils;
  
  /***
   *
   * @author  stephen
   */
  public class ExpToolBar extends JToolBar
  {
    private boolean firstTaken = false;
    private boolean lastTaken = false;
    private Vector segments = new Vector();
    private Vector toolBarItems = new Vector();
    private ExpListener listener = null;
    private static final int BORDER = 6;
    
    /*** Creates a new instance of ExpToolbar */
    public ExpToolBar(ExpListener listener)
    {
      super();
      try
      {
        this.listener = listener;
        
        /* Set the name of this tool bar */
        this.setName(ExpConstants.COMPNAME_EXPTOOLBAR);
      }
      catch (Exception e)
      {
        com.explosion.utilities.exception.ExceptionManagerFactory.getExceptionManager().manageException(e, "Exception caught while creating main toolbar.");
      }
    }
  
    /***
     * This mthod runs through the elements in the toolButtons vector and
     * inserts them into the actual toolbar.
     */
    public void constructToolBar()
    {
      for (int i = 0; i < toolBarItems.size(); i++)
      {
        if (toolBarItems.elementAt(i) instanceof JButton)
        {
          JButton toolButton = (JButton) toolBarItems.elementAt(i);
          this.add(toolButton);
        }
        else
        {
          this.addSeparator(new Dimension(20,20));
        }
      }
    }
  
    /***
     * This method runs through the list of menu's and their children and asks each of them to enable or diable themselves
     */
    public void checkEnabled()
    {
      try
      {
        for (int i = 0; i < toolBarItems.size(); i++)
        {
          if (toolBarItems.elementAt(i) instanceof ExpToolBarItem)
          {
            ExpToolBarItem item = (ExpToolBarItem) toolBarItems.elementAt(i);
            item.checkEnabled(Application.getActiveComponentCookies(), Application.getLocalCookies(),Application.getGlobalCookies());
          }
        }
     }
     catch (Exception e)
     {
       com.explosion.utilities.exception.ExceptionManagerFactory.getExceptionManager().manageException(e, "Exception caught while checking toolBarItems to see if they should be enabled or not.");
     }
   }
 
   /***
    * Adds a new button to the toolBar
    */
   public ExpToolBarItem createExpToolBarItem(String imageLocation, String toolTipText, String actionCommand, int enabledThreshold) throws Exception
   {
     Image ic = FileSystemUtils.loadImage(imageLocation, this);
     ExpToolBarItem toolButton = new ExpToolBarItem(actionCommand,enabledThreshold);
     ImageIcon icon = new ImageIcon(ic);
     toolButton.setIcon(icon);
     toolButton.setMaximumSize(new Dimension(icon.getIconWidth()+BORDER,icon.getIconHeight()+BORDER));
 	toolButton.setPreferredSize(new Dimension(icon.getIconWidth()+BORDER,icon.getIconHeight()+BORDER));
 	toolButton.setMinimumSize(new Dimension(icon.getIconWidth()+BORDER,icon.getIconHeight()+BORDER));
 	toolButton.setToolTipText(toolTipText);
     toolButton.setActionCommand(actionCommand);
     toolButton.addActionListener(listener);
     return toolButton;
   }
 
   /***
    * Creates a new segment in this menu
    */
   public ExpToolBarSegment createNewSegment(int relativePositionOfSegmentOnMenu) throws Exception
   {
     ExpToolBarSegment segment = null;
     if (relativePositionOfSegmentOnMenu == ExpToolBarSegment.ALWAYS_FIRST_SEGMENT)
     {
       if (firstTaken)
         throw new ToolBarException("Relative position ALWAYS_FIRST_SEGMENT is already being used on menu " + this.getName() + ".");
 
       firstTaken = true;
       segment = new ExpToolBarSegment(0, this, toolBarItems, relativePositionOfSegmentOnMenu);
       if (segments.size() == 0)
         segments.addElement(segment);
       else
         segments.insertElementAt(segment, 0);
     }
     else if (relativePositionOfSegmentOnMenu == ExpToolBarSegment.ANY_POSITION)
     {
       int segmentStartPos = 0;
 
       if (segments.size() != 0)
       {
         if (lastTaken) // use the startIndex of the last one
           segmentStartPos = ((ExpToolBarSegment) segments.elementAt(segments.size() - 1)).getStartIndex();
         else //otherwise just pop it on the end
           segmentStartPos = toolBarItems.size() - 1;
       }
 
       segment = new ExpToolBarSegment(segmentStartPos, this, toolBarItems, relativePositionOfSegmentOnMenu);
 
       if (segments.size() == 0 || !lastTaken)
         segments.addElement(segment);
       else
         segments.insertElementAt(segment, segments.size() - 1);
     }
     else if (relativePositionOfSegmentOnMenu == ExpToolBarSegment.ALWAYS_LAST_SEGMENT)
     {
       if (lastTaken)
         throw new ToolBarException("Relative position ALWAYS_LAST_SEGMENT is already being used on menu " + this.getName() + ".");
 
       lastTaken = true;
       int segmentStartPos = 0;
 
       if (segments.size() != 0)
         segmentStartPos = toolBarItems.size() - 1;
 
       segment = new ExpToolBarSegment(segmentStartPos, this, toolBarItems, relativePositionOfSegmentOnMenu);
       segments.addElement(segment); // always add it last
     }
     return segment;
   }
 
   /***
    * Updates all of the start positions after this segment
    */
   public void updateStartPositions(ExpToolBarSegment segment, int numberOfPositions)
   {
     boolean found = false;
     for (int i = 0; i < segments.size(); i++)
     {
       if (!found && segment == segments.elementAt(i))
       {
         found = true;
       }
       else
       {
         ((ExpToolBarSegment) segments.elementAt(i)).modifyStartPos(numberOfPositions);
       }
     }
   }
 
 
 }