prefuse.controls

Class PanControl

java.lang.Object

prefuse.controls.ControlAdapter

prefuse.controls.PanControl

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener, Control

public class PanControl
extends ControlAdapter

Pans the display, changing the viewable region of the visualization. By default, panning is accomplished by clicking on the background of a visualization with the left mouse button and then dragging.

Field Summary

Fields inherited from interface prefuse.controls.Control

LEFT_MOUSE_BUTTON, MIDDLE_MOUSE_BUTTON, RIGHT_MOUSE_BUTTON

Constructor Summary

Constructors

Constructor and Description
PanControl() Create a new PanControl.
PanControl(boolean panOverItem) Create a new PanControl.
PanControl(int mouseButton) Create a new PanControl.
PanControl(int mouseButton, boolean panOverItem) Create a new PanControl

Method Summary

Methods

Modifier and Type	Method and Description
void	itemDragged(VisualItem item, java.awt.event.MouseEvent e) Invoked when a mouse button is pressed on a VisualItem and then dragged.
void	itemPressed(VisualItem item, java.awt.event.MouseEvent e) Invoked when a mouse button has been pressed on a VisualItem.
void	itemReleased(VisualItem item, java.awt.event.MouseEvent e) Invoked when a mouse button has been released on a VisualItem.
void	mouseDragged(java.awt.event.MouseEvent e) Invoked when a mouse button is pressed on the Display (but NOT a VisualItem) and then dragged.
void	mousePressed(java.awt.event.MouseEvent e) Invoked when a mouse button has been pressed on the Display but NOT on a VisualItem.
void	mouseReleased(java.awt.event.MouseEvent e) Invoked when a mouse button has been released on the Display but NOT on a VisualItem.

Methods inherited from class prefuse.controls.ControlAdapter

isEnabled, itemClicked, itemEntered, itemExited, itemKeyPressed, itemKeyReleased, itemKeyTyped, itemMoved, itemWheelMoved, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mouseMoved, mouseWheelMoved, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PanControl

public PanControl()

Create a new PanControl.

PanControl

public PanControl(boolean panOverItem)

Create a new PanControl.

Parameters:

panOverItem - if true, the panning control will work even while the mouse is over a visual item.

PanControl

public PanControl(int mouseButton)

Create a new PanControl.

Parameters:

mouseButton - the mouse button that should initiate a pan. One of Control.LEFT_MOUSE_BUTTON, Control.MIDDLE_MOUSE_BUTTON, or Control.RIGHT_MOUSE_BUTTON.

PanControl

public PanControl(int mouseButton,
          boolean panOverItem)

Create a new PanControl

Parameters:

mouseButton - the mouse button that should initiate a pan. One of Control.LEFT_MOUSE_BUTTON, Control.MIDDLE_MOUSE_BUTTON, or Control.RIGHT_MOUSE_BUTTON.

panOverItem - if true, the panning control will work even while the mouse is over a visual item.

Method Detail

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Description copied from interface: Control

Invoked when a mouse button has been pressed on the Display but NOT on a VisualItem.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Specified by:

mousePressed in interface Control

Overrides:

mousePressed in class ControlAdapter

See Also:

MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Description copied from interface: Control

Invoked when a mouse button is pressed on the Display (but NOT a VisualItem) and then dragged.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Specified by:

mouseDragged in interface Control

Overrides:

mouseDragged in class ControlAdapter

See Also:

MouseMotionListener.mouseDragged(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Description copied from interface: Control

Invoked when a mouse button has been released on the Display but NOT on a VisualItem.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Specified by:

mouseReleased in interface Control

Overrides:

mouseReleased in class ControlAdapter

See Also:

MouseListener.mouseReleased(java.awt.event.MouseEvent)

itemPressed

public void itemPressed(VisualItem item,
               java.awt.event.MouseEvent e)

Description copied from interface: Control

Invoked when a mouse button has been pressed on a VisualItem.

Specified by:

itemPressed in interface Control

Overrides:

itemPressed in class ControlAdapter

See Also:

Control.itemPressed(prefuse.visual.VisualItem, java.awt.event.MouseEvent)

itemDragged

public void itemDragged(VisualItem item,
               java.awt.event.MouseEvent e)

Description copied from interface: Control

Invoked when a mouse button is pressed on a VisualItem and then dragged.

Specified by:

itemDragged in interface Control

Overrides:

itemDragged in class ControlAdapter

See Also:

Control.itemDragged(prefuse.visual.VisualItem, java.awt.event.MouseEvent)

itemReleased

public void itemReleased(VisualItem item,
                java.awt.event.MouseEvent e)

Description copied from interface: Control

Invoked when a mouse button has been released on a VisualItem.

Specified by:

itemReleased in interface Control

Overrides:

itemReleased in class ControlAdapter

See Also:

Control.itemReleased(prefuse.visual.VisualItem, java.awt.event.MouseEvent)