Package org.jdesktop.swingx.rollover

Class RolloverController<T extends JComponent>

java.lang.Object
org.jdesktop.swingx.rollover.RolloverController<T>
All Implemented Interfaces:
PropertyChangeListener, EventListener
Direct Known Subclasses:
ListRolloverController, TableRolloverController, TreeRolloverController
public abstract class RolloverController<T extends JComponent> extends Object implements PropertyChangeListener
Controller for "live" behaviour of XXRenderers. Once installed on a component, it updates renderer's rollover state based on the component's rollover properties. Rollover client properties are Points with cell coordinates in the view coordinate system as appropriate for the concrete component (Point.x == column, Point.y == row). Repaints effected component regions. Updates link cursor. Installs a click-action bound to space-released in the target's actionMap/inputMap.
Author:
Jeanette Winzenburg, Berlin

  • Field Details

    • EXECUTE_BUTTON_ACTIONCOMMAND

      public static final String EXECUTE_BUTTON_ACTIONCOMMAND
      the key of the rollover click action which is installed in the component's actionMap.
      See Also:

    • component

      protected T extends JComponent component

  • Constructor Details

    • RolloverController

      public RolloverController()

  • Method Details

    • propertyChange

      public void propertyChange(PropertyChangeEvent evt)
      Specified by:
      propertyChange in interface PropertyChangeListener

    • install

      public void install(T table)
      Install this as controller for the given component.
      Parameters:
      table - the component which has renderers to control.

    • release

      public void release()
      Uninstall this as controller from the component, if any.

    • rollover

      protected abstract void rollover(Point oldLocation, Point newLocation)
      called on change of client property Rollover_Key.
      Parameters:
      oldLocation - the old value of the rollover location.
      newLocation - the new value of the rollover location.

    • click

      protected void click(Point location)
      called on change of client property Clicked_key.
      Parameters:
      location - the new value of the clicked location.

    • getRolloverRenderer

      protected abstract RolloverRenderer getRolloverRenderer(Point location, boolean prepare)
      Returns the rolloverRenderer at the given location.

      The result may be null if there is none or if rollover is not enabled. If the prepare flag is true, the renderer will be prepared with value and state as appropriate for the given location. Note: PRE - the location must be valid in cell coordinate space.

      Parameters:
      location - a valid location in cell coordinates, p.x == column, p.y == row.
      prepare -
      Returns:
      RolloverRenderer at the given location

    • isClickable

      protected boolean isClickable(Point location)
      Returns a boolean indicating whether or not the cell at the given location is clickable.

      This implementation returns true if the target is enabled and the cell has a rollover renderer.

      Parameters:
      location - in cell coordinates, p.x == column, p.y == row.
      Returns:
      true if the cell at the given location is clickable
      See Also:

    • hasRollover

      protected boolean hasRollover(Point location)
      Returns a boolean indicating whether the or not the cell at the given has a rollover renderer. Always returns false if the location is not valid.
      Parameters:
      location - in cell coordinates, p.x == column, p.y == row.
      Returns:
      true if the location is valid and has rollover effects, false otherwise.

    • getFocusedCell

      protected abstract Point getFocusedCell()
      The coordinates of the focused cell in view coordinates. This method is called if the click action is invoked by a keyStroke. The returned cell coordinates should be related to what is typically interpreted as "focused" in the context of the component. p.x == focused column, p.y == focused row. A null return value or any coordinate value of < 0 is interpreted as "outside".
      Returns:
      the location of the focused cell.

    • unregisterExecuteButtonAction

      protected void unregisterExecuteButtonAction()
      uninstalls and deregisters the click action from the component's actionMap/inputMap.

    • registerExecuteButtonAction

      protected void registerExecuteButtonAction()
      installs and registers the click action in the component's actionMap/inputMap.

    • createExecuteButtonAction

      protected Action createExecuteButtonAction()
      creates and returns the click action to install in the component's actionMap.