FloatingButtonEnabler (JCommon Class Library (version 1.0.24))

java.lang.Object

java.awt.event.MouseAdapter

org.jfree.ui.FloatingButtonEnabler

All Implemented Interfaces:: MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public final class FloatingButtonEnabler extends MouseAdapter

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

Method Summary

Modifier and Type

Method

Description

void

addButton(AbstractButton button)

Adds a button to this enabler.

static FloatingButtonEnabler

getInstance()

Returns a default instance of this enabler.

void

mouseEntered(MouseEvent e)

Triggers the drawing of the border when the mouse entered the button area.

void

mouseExited(MouseEvent e)

Disables the drawing of the border when the mouse leaves the button area.

void

removeButton(AbstractButton button)

Removes a button from the enabler.

Methods inherited from class java.awt.event.MouseAdapter
mouseClicked, mouseDragged, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getInstance
  
  public static FloatingButtonEnabler getInstance()
  
  Returns a default instance of this enabler.
  
  Returns:
  
  a shared instance of this class.
- addButton
  
  public void addButton(AbstractButton button)
  
  Adds a button to this enabler.
  
  Parameters:
  
  button - the button.
- removeButton
  
  public void removeButton(AbstractButton button)
  
  Removes a button from the enabler.
  
  Parameters:
  
  button - the button.
- mouseEntered
  
  public void mouseEntered(MouseEvent e)
  
  Triggers the drawing of the border when the mouse entered the button area.
  
  Specified by:
  
  mouseEntered in interface MouseListener
  
  Overrides:
  
  mouseEntered in class MouseAdapter
  
  Parameters:
  
  e - the mouse event.
- mouseExited
  
  public void mouseExited(MouseEvent e)
  
  Disables the drawing of the border when the mouse leaves the button area.
  
  Specified by:
  
  mouseExited in interface MouseListener
  
  Overrides:
  
  mouseExited in class MouseAdapter
  
  Parameters:
  
  e - the mouse event.