KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > 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.3 2005/10/18 13:18:34 mungady 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 JavaDoc;
46 import java.awt.event.MouseEvent JavaDoc;
47
48 import javax.swing.AbstractButton JavaDoc;
49
50 /**
51  * Enables a button to have a simple floating effect. The border of the button is only visible,
52  * when the mouse pointer is floating over the button.
53  *
54  * @author Thomas Morgner
55  */
56 public final class FloatingButtonEnabler extends MouseAdapter JavaDoc {
57   
58     /** A single instance. */
59     private static FloatingButtonEnabler singleton;
60
61     /**
62      * Default constructor.
63      */
64     private FloatingButtonEnabler() {
65         // nothing required
66 }
67
68     /**
69      * Returns a default instance of this enabler.
70      *
71      * @return a shared instance of this class.
72      */
73     public static FloatingButtonEnabler getInstance() {
74         if (singleton == null) {
75             singleton = new FloatingButtonEnabler();
76         }
77         return singleton;
78     }
79
80     /**
81      * Adds a button to this enabler.
82      *
83      * @param button the button.
84      */
85     public void addButton(final AbstractButton JavaDoc button) {
86         button.addMouseListener(this);
87         button.setBorderPainted(false);
88     }
89
90     /**
91      * Removes a button from the enabler.
92      *
93      * @param button the button.
94      */
95     public void removeButton(final AbstractButton JavaDoc button) {
96         button.addMouseListener(this);
97         button.setBorderPainted(true);
98     }
99
100     /**
101      * Triggers the drawing of the border when the mouse entered the button area.
102      *
103      * @param e the mouse event.
104      */
105     public void mouseEntered(final MouseEvent JavaDoc e) {
106         if (e.getSource() instanceof AbstractButton JavaDoc) {
107             final AbstractButton JavaDoc button = (AbstractButton JavaDoc) e.getSource();
108             if (button.isEnabled()) {
109                 button.setBorderPainted(true);
110             }
111         }
112     }
113
114     /**
115      * Disables the drawing of the border when the mouse leaves the button area.
116      *
117      * @param e the mouse event.
118      */
119     public void mouseExited(final MouseEvent JavaDoc e) {
120         if (e.getSource() instanceof AbstractButton JavaDoc) {
121             final AbstractButton JavaDoc button = (AbstractButton JavaDoc) e.getSource();
122             button.setBorderPainted(false);
123             if (button.getParent() != null)
124             {
125 // button.getParent().repaint(button.getX(), button.getY(),
126 // button.getWidth(), button.getHeight());
127 button.getParent().repaint();
128             }
129         }
130     }
131
132 }
133
Popular Tags