/*
 *  $Source: /cvsroot2/open/projects/WebARTS/ca/bc/webarts/widgets/AutoButtonBar.java,v $
 *  $Name:  $
 *  Current File Status:   $Revision: 567 $
 *  $Date: 2012-11-03 20:36:02 -0700 (Sat, 03 Nov 2012) $
 *  $Locker:  $
 *  Copyright (C) 2001-2004 WebARTS Design, North Vancouver Canada
 */
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package ca.bc.webarts.widgets;

import ca.bc.webarts.widgets.StatusBar;

import java.awt.FlowLayout;
import java.awt.Insets;
import java.awt.Dimension;
import java.awt.event.ActionListener;
import java.net.URL;
import javax.swing.*;
import java.lang.Class;

/**
 *  A Tool Bar with multiple Icon Rollover enabled Buttons.
 *  All creation is done automatically based on the String Arrays
 *  <code>buttonIconName</code> and <code>buttonToolTip</code>
 *  which hold the icon filenames and tooltip text repecively for each Button.
 *
 * @author     <A HREF="http://www.webarts.bc.ca/~tgutwin">Tom Gutwin</A>
 * @created    November 17, 2000
 */
public class AutoButtonBar extends JToolBar
{

  /**
   *  An array of strings that hold the names of the image files that will
   *  be used for the button icons.  The order of the entries in this array
   *  represents the order they will be added to the JToolBar.
   *  <P><B><I>SPECIAL NOTE</I></B><BR>To get the names of the 'pressed' and
   * 'hoverover' icon filenames, this class looks for a file with
   *  the prepended words 'Pressed' and 'Over' to the Strings supplied in
   *  the buttonIconName array.
   *  <P>Example... <BR>icon filename = "Print.gif"<BR>hoverover icon
   *  filename = "OverPrint.gif"<BR>pressed icon filename = "PressedPrint.gif"
   *
   */
  public String [] buttonIconName;


  /**
   *  An array of Strings for the botton tool tip text.
   */
  public String [] buttonToolTip;


  /**
   *  The Codes Base URL.
   */
  private URL codeBase;


  /**
   *  A URL to hold the images for the buttons.
   */
  URL tempURL;
  /**
   *  A holder for the the users filesystem separator.
   */
  String fileSeperator = new String(System.getProperty("file.separator"));
  /**
   *  Description of the Field
   */
  private JButton [] toolButton;
  /**
   *  Description of the Field
   */
  private int numberOfFiles, i, debug = 3;
  /**
   *  Description of the Field
   */
  private StatusBar statusBar;
  /**
   * The relative resource locator to find the image files, relative to
   * the baseURL.
   **/
  private String relImageLocator = "";

  /**
   * The Class Object representing the controller class that will be called to
   * deal with this buttonBars action events.
   **/
  private static ActionListener controller = null;


  /**
   *  CONSTRUCTOR Creates a new AutoButtonBar but DOES NOT init its buttons.
   */
   public AutoButtonBar(    URL cb,
                       String[] iconNames,
                       String[] iconToolTips,
                        Object  handler)
   {

    debugOutput(2, "Auto Creating the Tool Button Bar....");
    buttonIconName = iconNames;
    buttonToolTip = iconToolTips;
    codeBase = cb ;

    if (cb == null)
    {
      try
      {
        codeBase = new URL("FILE:/./");
      }
      catch (java.net.MalformedURLException t)
      {
        System.out.println("caught exception: " + t );
        t.printStackTrace();
      }
    }
    else
      codeBase = cb;

    setIcons(buttonIconName,buttonToolTip);
    /* Set out the layout manager */
    setLayout(new FlowLayout(FlowLayout.LEFT));
    getInsets(new Insets(0, 0, 0, 0));
    setMargin(new Insets(0, 0, 0, 0));

    setController(handler);

    if (iconNames.length == 0 )
    {
      debugOutput(1, "ERROR Creating the Tool Button Bar....");
    }
    else
      createButtons();
   }

  /**
   *  CONSTRUCTOR Creates a new AutoButtonBar but DOES NOT init its buttons.
   */
   public AutoButtonBar(URL cb)
   {
    debugOutput(2, "Auto Creating the Tool Button Bar....");
    codeBase = cb ;

    if (cb == null)
      try
      {
        codeBase = new URL("FILE:/./");
      }
      catch (java.net.MalformedURLException t)
      {
        System.out.println("caught exception: " + t );
        t.printStackTrace();
      }
    else
      codeBase = cb;

    /* Set out the layout manager */
    setLayout(new FlowLayout(FlowLayout.LEFT));
    getInsets(new Insets(0, 0, 0, 0));
    setMargin(new Insets(0, 0, 0, 0));

   }

  /**
   *  CONSTRUCTOR Creates a new AutoButtonBar that is assciated with the
   *  passed in JInternalFrame components.
   *
   * @param  sb          The StatusBar that the functions of the buttons in
   *                     this JToolBar will be associated with.
   * @param  codeBase    The URL that all references to files will be
   *                     appended to.
   * @param  mdiPanel  Description of Parameter
   */
  public AutoButtonBar(JPanel mdiPanel, StatusBar sb, URL cBase) {
    debugOutput(2, "Auto Creating the Tool Button Bar....");
    statusBar = sb;
    controller = null;
    codeBase = cBase;
    /* Set out the layout manager */
    setLayout(new FlowLayout(FlowLayout.LEFT));
    getInsets(new Insets(0, 0, 0, 0));
    setMargin(new Insets(0, 0, 0, 0));
    createButtons();
  }

   public void setIcons( String[] iconNames,
                         String[] iconToolTips)
   {
    if (iconNames == null)
      buttonIconName = new String[0];
    else
    {
      buttonIconName = iconNames;
      debugOutput(2,buttonIconName[0] );
    }
    if (iconToolTips == null)
      buttonToolTip = new String[0];
    else
      buttonToolTip = iconToolTips;

    toolButton = new JButton[buttonIconName.length];
}

   public boolean setController(Object handler)
   {
    Class [] interf = handler.getClass().getInterfaces();
    boolean isAListener = false;
    try
    {
      Class AListener = Class.forName("java.awt.event.ActionListener");

      debugOutput(2, "Checking for a Listener....");
      for (int i=0; i < interf.length;i++)
      {
        if (interf[i] == AListener)
        {
          isAListener = true;
          continue;
        }
      }
    }
    catch (ClassNotFoundException ex)
    {
      debugOutput(2, "ClassNotFoundException....");
    }

    if (isAListener)
    {
      debugOutput(2, "      Got A Listener....");
      controller = (ActionListener) handler;
    }
    return isAListener;
   }


  /**
   * Create the buttons based on the initialized arrays of information.
   **/
   public void createButtons()
   {
    for (i = 0; i < buttonIconName.length; i++)
    {
      if (!buttonIconName[i].equals("---"))
      {
        try
        {
          /* create button  and set images */
//System.out.println("ButtonIcon "  + (new Integer(i)).toString() +
//                   " URL=" + codeBase + relImageLocator+"/"+ buttonIconName[i]);

          tempURL = new URL(codeBase + relImageLocator+"/"+ buttonIconName[i]);
//System.out.println("ButtonIconURL "  + (new Integer(i)).toString() +
//                   " URL=" + tempURL.toString());
          toolButton[i] = new JButton(buttonIconName[i], new ImageIcon(tempURL));
          tempURL = new URL(codeBase,  relImageLocator+"/Pressed" + buttonIconName[i]);
          toolButton[i].setPressedIcon(new ImageIcon(tempURL));
          tempURL = new URL(codeBase,  relImageLocator+"/Over" + buttonIconName[i]);
          toolButton[i].setRolloverIcon(new ImageIcon(tempURL));
          toolButton[i].setBorderPainted(false);
          toolButton[i].setToolTipText(buttonToolTip[i]);
        }
        catch (java.net.MalformedURLException t)
        {
          System.out.println("caught exception: " + t +
                             "Cannot retrieve images");
          t.printStackTrace();
        }

        /* set the buttons margins */
        toolButton[i].setMargin(new Insets(1, 1, 1, 1));

        /* add the listeners to the buttons */
        if (controller != null)
          toolButton[i].addActionListener(controller);

        /* add the buttons to the toolBar */
        add(toolButton[i]);
      }
      else
      {
        addSeparator(new Dimension(3, 3));
      }
      add(Box.createHorizontalGlue());
    }
   }


   /**
    * Sets the relative pathe field that is used ad a relative path the
    * iconnames.
    **/
    public void setRelImageLocator(String s ) { relImageLocator = s;}


   /**
    * Sets the buttonIconName field.
    */
    public void setButtonIconName(String[] s) { buttonIconName = s;}


   /**
    * Sets the buttonToolTip field.
    */
    public void setButtonToolTip(String[] s) { buttonToolTip = s;}


   /**
   *  Sets the Debug attribute of the AutoButtonBar object
   *
   * @param  l  The new Debug value
   */
  public void setDebug(int l) {
    debug = l;
  }


  /**
   *  Gets the Debug attribute of the AutoButtonBar object
   *
   * @return    The Debug value
   */
  public int getDebug() {
    return debug;
  }


  /**
   *  Description of the Method
   *
   * @param  s  Description of Parameter
   * @return    Description of the Returned Value
   */
  private int indexOf(String s) {
    int i;
    int retVal = 0;
    for (i = 0; i < buttonIconName.length; i++)
      if (s.equals(buttonToolTip[i])) {
        retVal = i;
        i = buttonIconName.length;
      }
    return retVal;
  }


  /**
   *  Handles the debug messages by comparing the app debug level to the
   *  message level. <P>If the message level is less or == then the message
   *  gets output to System.out.
   *
   * @param  l       Description of Parameter
   * @param  output  Description of Parameter
   */
  private void debugOutput(int l, String output) {
    if (l <= debug)
      System.out.println(output);
  }


}