floatingbuttonenabler.java

Java的Web报表库

/**
 * ========================================
 * JFreeReport : a free Java report library
 * ========================================
 *
 * Project Info:  http://www.jfree.org/jfreereport/index.html
 * Project Lead:  Thomas Morgner;
 *
 * (C) Copyright 2000-2002, by Simba Management Limited and Contributors.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * --------------------------
 * FloatingButtonEnabler.java
 * --------------------------
 * (C)opyright 2002, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: FloatingButtonEnabler.java,v 1.13.2.1 2003/08/24 14:18:14 taqua Exp $
 *
 */
package com.jrefinery.report.util;

import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import javax.swing.AbstractButton;

/**
 * Enables a button to have a simple floating effect. The border of the button is only visible,
 * when the mouse pointer is floating over the button.
 *
 * @author Thomas Morgner
 */
public class FloatingButtonEnabler extends MouseAdapter
{
  /** A single instance. */
  private static FloatingButtonEnabler singleton;

  /**
   * Default constructor.
   */
  private FloatingButtonEnabler()
  {
  }

  /**
   * Returns a default instance of this enabler.
   *
   * @return a shared instance of this class.
   */
  public static FloatingButtonEnabler getInstance()
  {
    if (singleton == null)
    {
      singleton = new FloatingButtonEnabler();
    }
    return singleton;
  }

  /**
   * Adds a button to this enabler.
   *
   * @param button  the button.
   */
  public void addButton(final AbstractButton button)
  {
    button.addMouseListener(this);
    button.setBorderPainted(false);
  }

  /**
   * Removes a button from the enabler.
   *
   * @param button  the button.
   */
  public void removeButton(final AbstractButton button)
  {
    button.addMouseListener(this);
    button.setBorderPainted(true);
  }

  /**
   * Triggers the drawing of the border when the mouse entered the button area.
   *
   * @param e  the mouse event.
   */
  public void mouseEntered(final MouseEvent e)
  {
    if (e.getSource() instanceof AbstractButton)
    {
      final AbstractButton button = (AbstractButton) e.getSource();
      if (button.isEnabled())
      {
        button.setBorderPainted(true);
      }
    }
  }

  /**
   * Disables the drawing of the border when the mouse leaves the button area.
   *
   * @param e  the mouse event.
   */
  public void mouseExited(final MouseEvent e)
  {
    if (e.getSource() instanceof AbstractButton)
    {
      final AbstractButton button = (AbstractButton) e.getSource();
      button.setBorderPainted(false);
    }
  }

}