Package org.jungrapht.visualization.control

Class AbstractModalGraphMouse

java.lang.Object

org.jungrapht.visualization.control.PluggableGraphMouse

org.jungrapht.visualization.control.AbstractGraphMouse

org.jungrapht.visualization.control.AbstractModalGraphMouse

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener, Modal, ModalGraphMouse, VisualizationViewer.GraphMouse

Direct Known Subclasses:

AnnotatingModalGraphMouse, DefaultModalGraphMouse, EditingModalGraphMouse

public abstract class AbstractModalGraphMouse
extends AbstractGraphMouse
implements ModalGraphMouse

AbstractModalGraphMouse is a PluggableGraphMouse class that manages a collection of plugins for picking and transforming the graph. Additionally, it carries the notion of a Mode: Picking or Translating. Switching between modes allows for a more natural choice of mouse modifiers to be used for the various plugins. The default modifiers are intended to mimick those of mainstream software applications in order to be intuitive to users.

// * *

Users must implement the loadPlugins() method to create and install the GraphMousePlugins. The order of the plugins is important, as they are evaluated against the mask parameters in the order that they are added.

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractModalGraphMouse.Builder<T extends AbstractModalGraphMouse,B extends AbstractModalGraphMouse.Builder<T,B>>	Configure an instance of an AbstractModalGraphMouse

Nested classes/interfaces inherited from interface org.jungrapht.visualization.control.modal.Modal

Modal.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected GraphMousePlugin	animatedPickingPlugin
protected EventListenerList	listenerList	listeners for mode changes
protected Modal.Mode	mode	the current mode
protected KeyListener	modeKeyListener
protected GraphMousePlugin	rotatingPlugin
protected GraphMousePlugin	shearingPlugin
protected GraphMousePlugin	translatingPlugin

Fields inherited from class org.jungrapht.visualization.control.AbstractGraphMouse

in, out, regionSelectingPlugin, scalingPlugin, selectingPlugin, vertexSelectionOnly

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractModalGraphMouse(AbstractModalGraphMouse.Builder<?,?> builder)
protected	AbstractModalGraphMouse(Modal.Mode mode, float in, float out, boolean vertexSelectionOnly)

Method Summary

Modifier and Type	Method	Description
Modal.Mode	getMode()
KeyListener	getModeKeyListener()
void	setMode(Modal.Mode mode)	setter for the Mode.
void	setModeKeyListener(KeyListener modeKeyListener)
protected void	setPickingMode()
protected void	setTransformingMode()
void	setZoomAtMouse(boolean zoomAtMouse)

Methods inherited from class org.jungrapht.visualization.control.PluggableGraphMouse

add, clear, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Methods inherited from interface org.jungrapht.visualization.VisualizationViewer.GraphMouse

isPluginsLoaded, loadPlugins, setPluginsLoaded

Field Detail

mode

protected Modal.Mode mode

the current mode

listenerList

protected EventListenerList listenerList

listeners for mode changes

translatingPlugin

protected GraphMousePlugin translatingPlugin

animatedPickingPlugin

protected GraphMousePlugin animatedPickingPlugin

rotatingPlugin

protected GraphMousePlugin rotatingPlugin

shearingPlugin

protected GraphMousePlugin shearingPlugin

modeKeyListener

protected KeyListener modeKeyListener

Constructor Detail

AbstractModalGraphMouse

protected AbstractModalGraphMouse(AbstractModalGraphMouse.Builder<?,?> builder)

AbstractModalGraphMouse

protected AbstractModalGraphMouse(Modal.Mode mode,
                                  float in,
                                  float out,
                                  boolean vertexSelectionOnly)

Method Detail

setMode

public void setMode(Modal.Mode mode)

setter for the Mode.

Specified by:

setMode in interface Modal

getMode

public Modal.Mode getMode()

Specified by:

getMode in interface Modal

setPickingMode

protected void setPickingMode()

setTransformingMode

protected void setTransformingMode()

setZoomAtMouse

public void setZoomAtMouse(boolean zoomAtMouse)

Overrides:

setZoomAtMouse in class AbstractGraphMouse

Parameters:

zoomAtMouse - The zoomAtMouse to set.

getModeKeyListener

public KeyListener getModeKeyListener()

Specified by:

getModeKeyListener in interface ModalGraphMouse

Returns:

the modeKeyListener

setModeKeyListener

public void setModeKeyListener(KeyListener modeKeyListener)

Parameters:

modeKeyListener - the modeKeyListener to set