Source for org.jfree.ui.FloatingButtonEnabler

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * -----------------
  28:  * DetailEditor.java
  29:  * -----------------
  30:  * (C) Copyright 2004, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: FloatingButtonEnabler.java,v 1.4 2007/11/02 17:50:36 taqua Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 07-Jun-2004 : Added JCommon header (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.ui;
  44: 
  45: import java.awt.event.MouseAdapter;
  46: import java.awt.event.MouseEvent;
  47: import javax.swing.AbstractButton;
  48: 
  49: /**
  50:  * Enables a button to have a simple floating effect. The border of the button is only visible,
  51:  * when the mouse pointer is floating over the button.
  52:  *
  53:  * @author Thomas Morgner
  54:  */
  55: public final class FloatingButtonEnabler extends MouseAdapter {
  56:   
  57:     /** A single instance. */
  58:     private static FloatingButtonEnabler singleton;
  59: 
  60:     /**
  61:      * Default constructor.
  62:      */
  63:     private FloatingButtonEnabler() {
  64:         // nothing required
  65:     }
  66: 
  67:     /**
  68:      * Returns a default instance of this enabler.
  69:      *
  70:      * @return a shared instance of this class.
  71:      */
  72:     public static FloatingButtonEnabler getInstance() {
  73:         if (singleton == null) {
  74:             singleton = new FloatingButtonEnabler();
  75:         }
  76:         return singleton;
  77:     }
  78: 
  79:     /**
  80:      * Adds a button to this enabler.
  81:      *
  82:      * @param button  the button.
  83:      */
  84:     public void addButton(final AbstractButton button) {
  85:         button.addMouseListener(this);
  86:         button.setBorderPainted(false);
  87:     }
  88: 
  89:     /**
  90:      * Removes a button from the enabler.
  91:      *
  92:      * @param button  the button.
  93:      */
  94:     public void removeButton(final AbstractButton button) {
  95:         button.addMouseListener(this);
  96:         button.setBorderPainted(true);
  97:     }
  98: 
  99:     /**
 100:      * Triggers the drawing of the border when the mouse entered the button area.
 101:      *
 102:      * @param e  the mouse event.
 103:      */
 104:     public void mouseEntered(final MouseEvent e) {
 105:         if (e.getSource() instanceof AbstractButton) {
 106:             final AbstractButton button = (AbstractButton) e.getSource();
 107:             if (button.isEnabled()) {
 108:                 button.setBorderPainted(true);
 109:             }
 110:         }
 111:     }
 112: 
 113:     /**
 114:      * Disables the drawing of the border when the mouse leaves the button area.
 115:      *
 116:      * @param e  the mouse event.
 117:      */
 118:     public void mouseExited(final MouseEvent e) {
 119:         if (e.getSource() instanceof AbstractButton) {
 120:             final AbstractButton button = (AbstractButton) e.getSource();
 121:             button.setBorderPainted(false);
 122:             if (button.getParent() != null)
 123:             {
 124: //                button.getParent().repaint(button.getX(), button.getY(),
 125: //                    button.getWidth(), button.getHeight());
 126:                 button.getParent().repaint();
 127:             }
 128:         }
 129:     }
 130: 
 131: }