Package org.jdesktop.swingx.rollover

Class RolloverProducer

java.lang.Object
org.jdesktop.swingx.rollover.RolloverProducer
All Implemented Interfaces:
ComponentListener, MouseListener, MouseMotionListener, EventListener
Direct Known Subclasses:
ListRolloverProducer, TableRolloverProducer, TreeRolloverProducer
public abstract class RolloverProducer extends Object implements MouseListener, MouseMotionListener, ComponentListener
Mouse/Motion/Listener which maps mouse coordinates to client coordinates and stores these as client properties in the target JComponent. The exact mapping process is left to subclasses. Typically, they will map to "cell" coordinates.

Note: this class assumes that the target component is of type JComponent.

Note: this implementation is stateful, it can't be shared across different instances of a target component.

Author:
Jeanette Winzenburg

  • Field Details

    • CLICKED_KEY

      public static final String CLICKED_KEY
      Key for client property mapped from mouse-triggered action. Note that the actual mouse-event which results in setting the property depends on the implementation of the concrete RolloverProducer.
      See Also:

    • ROLLOVER_KEY

      public static final String ROLLOVER_KEY
      Key for client property mapped from rollover events
      See Also:

    • rollover

      protected Point rollover
      Current mouse location in client coordinates.

  • Constructor Details

    • RolloverProducer

      public RolloverProducer()

  • Method Details

    • isDragging

      protected boolean isDragging()

    • install

      public void install(JComponent component)
      Installs all listeners, as required.
      Parameters:
      component - target to install required listeners on, must not be null.

    • release

      public void release(JComponent component)
      Removes all listeners.
      Parameters:
      component - target component to uninstall required listeners from, must not be null

    • mouseReleased

      public void mouseReleased(MouseEvent e)
      Implemented to map to Rollover properties as needed. This implemenation calls updateRollover with both ROLLOVER_KEY and CLICKED_KEY properties.
      Specified by:
      mouseReleased in interface MouseListener

    • isClick

      protected boolean isClick(MouseEvent e, Point oldRollover, boolean wasDragging)
      Returns a boolean indicating whether or not the given mouse event should be interpreted as a click. This method is called from mouseReleased after the cell coordiates were updated. While the ID of mouse event is not formally enforced, it is assumed to be a MOUSE_RELEASED. Calling for other types might or might not work as expected.

      This implementation returns true if the current rollover point is the same cell as the given oldRollover, that is ending a drag inside the same cell triggers the action while ending a drag somewhere does not.

      PENDING JW: open to more complex logic in case it clashes with existing code, see Issue #1387.

      Parameters:
      e - the mouseEvent which triggered calling this, assumed to be a mouseReleased, must not be null
      oldRollover - the cell before the mouseEvent was mapped, must not be null
      wasDragging - true if the release happened
      Returns:
      a boolean indicating whether or not the given mouseEvent should be interpreted as a click.

    • mouseEntered

      public void mouseEntered(MouseEvent e)
      Implemented to map to client property rollover and fire only if client coordinate changed.
      Specified by:
      mouseEntered in interface MouseListener

    • mouseExited

      public void mouseExited(MouseEvent e)
      Implemented to remove client properties rollover and clicked. if the source is a JComponent. Does nothing otherwise.
      Specified by:
      mouseExited in interface MouseListener

    • mouseClicked

      public void mouseClicked(MouseEvent e)
      Implemented to do nothing.
      Specified by:
      mouseClicked in interface MouseListener

    • mousePressed

      public void mousePressed(MouseEvent e)
      Implemented to do nothing.
      Specified by:
      mousePressed in interface MouseListener

    • mouseDragged

      public void mouseDragged(MouseEvent e)
      Implemented to set a dragging flag to true.
      Specified by:
      mouseDragged in interface MouseMotionListener

    • mouseMoved

      public void mouseMoved(MouseEvent e)
      Implemented to map to client property rollover and fire only if client coordinate changed.
      Specified by:
      mouseMoved in interface MouseMotionListener

    • componentShown

      public void componentShown(ComponentEvent e)
      Specified by:
      componentShown in interface ComponentListener

    • componentResized

      public void componentResized(ComponentEvent e)
      Specified by:
      componentResized in interface ComponentListener

    • componentMoved

      public void componentMoved(ComponentEvent e)
      Specified by:
      componentMoved in interface ComponentListener

    • componentHidden

      public void componentHidden(ComponentEvent e)
      Specified by:
      componentHidden in interface ComponentListener

    • updateRollover

      protected void updateRollover(MouseEvent e, String property, boolean fireAlways)
      Controls the mapping of the given mouse event to a client property. This implementation first calls updateRolloverPoint to convert the mouse coordinates. Then calls updateClientProperty to actually set the client property in the
      Parameters:
      e - the MouseEvent to map to client coordinates
      property - the client property to map to
      fireAlways - a flag indicating whether a client event should be fired if unchanged.
      See Also:

    • updateClientProperty

      protected void updateClientProperty(JComponent component, String property, boolean fireAlways)
      Sets the given client property to the value of current mouse location in client coordinates. If fireAlways, the property is force to fire a change.
      Parameters:
      component - the target component
      property - the client property to set
      fireAlways - a flag indicating whether a client property should be forced to fire an event.

    • updateRolloverPoint

      protected abstract void updateRolloverPoint(JComponent component, Point mousePoint)
      Subclasses must implement to map the given mouse coordinates into appropriate client coordinates. The result must be stored in the rollover field.
      Parameters:
      component - the target component which received a mouse event
      mousePoint - the mouse position of the event, coordinates are component pixels