org.jdesktop.swingx
Class RolloverProducer

java.lang.Object
  extended by org.jdesktop.swingx.RolloverProducer
All Implemented Interfaces:
MouseListener, MouseMotionListener, EventListener

public class RolloverProducer
extends Object
implements MouseListener, MouseMotionListener

Mouse/Motion/Listener which stores mouse location as client property in the target JComponent. Note: assumes that the component it is listening to is of type JComponent!


Field Summary
static String CLICKED_KEY
           
protected  Point rollover
           
static String ROLLOVER_KEY
           
 
Constructor Summary
RolloverProducer()
           
 
Method Summary
 void mouseClicked(MouseEvent e)
          Invoked when the mouse button has been clicked (pressed and released) on a component.
 void mouseDragged(MouseEvent e)
          Invoked when a mouse button is pressed on a component and then dragged.
 void mouseEntered(MouseEvent e)
          Invoked when the mouse enters a component.
 void mouseExited(MouseEvent e)
          Invoked when the mouse exits a component.
 void mouseMoved(MouseEvent e)
          Invoked when the mouse cursor has been moved onto a component but no buttons have been pushed.
 void mousePressed(MouseEvent e)
          Invoked when a mouse button has been pressed on a component.
 void mouseReleased(MouseEvent e)
          Invoked when a mouse button has been released on a component.
protected  void updateClientProperty(JComponent component, String property)
           
protected  void updateRollover(MouseEvent e, String property)
           
protected  void updateRolloverPoint(JComponent component, Point mousePoint)
          Subclasses must override to map the given mouse coordinates into appropriate client coordinates.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLICKED_KEY

public static final String CLICKED_KEY
See Also:
Constant Field Values

ROLLOVER_KEY

public static final String ROLLOVER_KEY
See Also:
Constant Field Values

rollover

protected Point rollover
Constructor Detail

RolloverProducer

public RolloverProducer()
Method Detail

mouseClicked

public void mouseClicked(MouseEvent e)
Description copied from interface: java.awt.event.MouseListener
Invoked when the mouse button has been clicked (pressed and released) on a component.

Specified by:
mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)
Description copied from interface: java.awt.event.MouseListener
Invoked when a mouse button has been pressed on a component.

Specified by:
mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)
Description copied from interface: java.awt.event.MouseListener
Invoked when a mouse button has been released on a component.

Specified by:
mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)
Description copied from interface: java.awt.event.MouseListener
Invoked when the mouse enters a component.

Specified by:
mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)
Description copied from interface: java.awt.event.MouseListener
Invoked when the mouse exits a component.

Specified by:
mouseExited in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)
Description copied from interface: java.awt.event.MouseMotionListener
Invoked when a mouse button is pressed on a component and then dragged. MOUSE_DRAGGED events will continue to be delivered to the component where the drag originated until the mouse button is released (regardless of whether the mouse position is within the bounds of the component).

Due to platform-dependent Drag&Drop implementations, MOUSE_DRAGGED events may not be delivered during a native Drag&Drop operation.

Specified by:
mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)
Description copied from interface: java.awt.event.MouseMotionListener
Invoked when the mouse cursor has been moved onto a component but no buttons have been pushed.

Specified by:
mouseMoved in interface MouseMotionListener

updateRollover

protected void updateRollover(MouseEvent e,
                              String property)

updateClientProperty

protected void updateClientProperty(JComponent component,
                                    String property)

updateRolloverPoint

protected void updateRolloverPoint(JComponent component,
                                   Point mousePoint)
Subclasses must override to map the given mouse coordinates into appropriate client coordinates. The result must be stored in the rollover field. Here: does nothing.

Parameters:
component -
mousePoint -