/*
 *  $Source: $
 *  $Name:  $
 *  $Revision: 567 $
 *  $Date: 2012-11-03 20:36:02 -0700 (Sat, 03 Nov 2012) $
 *  $Locker: $
 */
/*
 *  JToggleButton -- A simple two state toggle button.
 *
 *  Copyright (C) 2003 WebARTS Design, North Vancouver Canada
 *  http://www.webarts.bc.ca
 *
 *  This program is free software; you can redistribute it and/ormodify
 *  it under the terms of Version 2 of the GNU General Public Licenseas
 *  published by the Free Software Foundation.
 *
 *  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 java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionAdapter;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.File;
import javax.swing.BorderFactory;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JWindow;
import javax.swing.border.BevelBorder;
import javax.swing.border.EmptyBorder;

import kiwi.ui.KButton;
import kiwi.util.KiwiUtils;


/**
 *  This is a simple implementation of a single button that performslike a
 *  Toggle button. It when pressed it "remembers" its state and remainsin that
 *  switched state until pressed again. Note that this is different thana normal
 *  button that stays pressed only while you are pressing it downwith your
 *  mouse.<p>
 *
 *  It performs like a Checkbox, except it does NOT havethat pesky little check
 *  and box.</p>
 *
 * @author    tgutwin
 */
public class JToggleButton extends KButton implements ActionListener
{

  /**  The dir where the images are located.  */
  final static String IMAGE_DIR = "." + File.separator +
      "images" + File.separator;
  /**  A Class holder for its name (could be used in Logging).  */
  private static String className_ = "JToggleButton";

  /**
   *  The ActionListener handles the state changing when the button is pressed.
   */
  ActionListener myButtonActionListener =
    new ActionListener()
    {
      public void actionPerformed(ActionEvent e)
      {
        JToggleButton but = (JToggleButton) e.getSource();
        if (but.getState() == true)
        {
          currentState_ = false;
          but.setToolTipText("Off");
          if (!flatStyle_)
          {
            but.setBorder(BorderFactory.createBevelBorder(
                BevelBorder.RAISED));
          }
          but.setIcon(iconOff_);
        }
        else
        {
          currentState_ = true;
          but.setToolTipText("On");
          if (!flatStyle_)
          {
            but.setBorder(BorderFactory.createBevelBorder(
                BevelBorder.LOWERED));
          }
          but.setIcon(iconOn_);
        }
      }
    };

  /**
   *  An Mose Listener Adapter to listen for mouse events and handles the border
   *  changes.
   */
  MouseAdapter myButtonMouseAdapter =
    new MouseAdapter()
    {
      public void mouseEntered(MouseEvent e)
      {
        JToggleButton but = (JToggleButton) e.getSource();
        if (but.isEnabled())
        {
          but.setBorderPainted(true);
          but.validate();
        }
      }


      public void mouseExited(MouseEvent e)
      {
        JButton but = (JButton) e.getSource();
        if (but.isEnabled())
        {
          but.setBorderPainted(false);
          but.validate();
        }
      }


      public void mousePressed(MouseEvent e)
      {
        JButton but = (JButton) e.getSource();
        if (but.isEnabled())
        {
          but.setBorder(BorderFactory.createBevelBorder(
              BevelBorder.LOWERED));
          but.validate();
        }
      }


      public void mouseReleased(MouseEvent e)
      {
        JButton but = (JButton) e.getSource();
        if (but.isEnabled())
        {
          but.setBorder(BorderFactory.createBevelBorder(
              BevelBorder.RAISED));
          but.validate();
        }
      }
    };

  /**  currentState_ remembers the On/OFF state of the button * */
  private boolean currentState_ = true;

  /**
   *  flatStyle_ controls if the look of this button will have a borderor not.
   *  DEFAULT = false.
   */
  private boolean flatStyle_ = false;

  /**  The filename for the ON image icon. */
  private String onImage_ =
      "/images/org/javalobby/icons/20x20/BulbOn.gif";
  /**  The filename for the ON image icon. */
  private String offImage_ =
      "/images/org/javalobby/icons/20x20/BulbOff.gif";

  /**  The Image Icon used when this button is in its ON state.  */
  private ImageIcon iconOn_ = null;

  /**  The Image Icon used when this button is in its OFF state.  */
  private ImageIcon iconOff_ = null;


  /**  Basic constructor for this Object.  */
  public JToggleButton()
  {
    super("");
    //    System.out.println("Constructor1");
    final String methodName = className_ + ": Constructor()";
    initUI();
    currentState_ = true;
    setToolTipText("On");
    if (!flatStyle_)
    {
      setBorder(BorderFactory.createBevelBorder(BevelBorder.LOWERED));
    }
    setIcon(iconOn_);
    addActionListener(myButtonActionListener);
  }


  /**
   *  The main test program for this class
   *
   * @param  args  The command line arguments
   */
  public static void main(String[] args)
  {
    JFrame appFrame = new JFrame();
    appFrame.getContentPane().setLayout(new BorderLayout());
    appFrame.setTitle("JToggleButton TEST Window.");
    final JToggleButton myTestButton = new JToggleButton();
    appFrame.addWindowListener(
      new WindowAdapter()
      {
        public void windowClosing(WindowEvent e)
        {
          //myTestButton.getLog().close();
          System.exit(0);
        }
      });
    appFrame.getContentPane().add(myTestButton);

    appFrame.pack();
    KiwiUtils.centerWindow(appFrame);
    appFrame.toFront();
    appFrame.setVisible(true);
    appFrame.repaint();
  }


  /**
   *  Gets the state attribute of the JToggleButton object
   *
   * @return    The state value
   */
  public boolean getState()
  {
    return currentState_;
  }


  /**
   *  Handles all the Actions originating from the Control Buttons. *
   *
   * @param  e  Description of Parameter
   */
  public void actionPerformed(ActionEvent e)
  {
    final String methodName = className_ + ": actionPerformed()";
  }


  /**  Description of the Method */
  private void initUI()
  {
    iconOn_ = new ImageIcon(Util.loadImage(onImage_), "On");
    iconOff_ = new ImageIcon(Util.loadImage(offImage_), "Off");
    if (!flatStyle_)
    {
      this.setBorder(BorderFactory.createBevelBorder(
          BevelBorder.LOWERED));
    }
    this.setPreferredSize(
        new Dimension(iconOn_.getIconWidth() + 2, iconOn_.getIconHeight() + 2));
  }

}