Package org.jungrapht.visualization.control

Class DefaultModalGraphMouse<V,E>

java.lang.Object

org.jungrapht.visualization.control.PluggableGraphMouse

org.jungrapht.visualization.control.AbstractGraphMouse

org.jungrapht.visualization.control.AbstractModalGraphMouse

org.jungrapht.visualization.control.DefaultModalGraphMouse<V,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

ModalLensGraphMouse, ModalSatelliteGraphMouse

public class DefaultModalGraphMouse<V,E>
extends AbstractModalGraphMouse
implements ModalGraphMouse

DefaultModalGraphMouse is a GraphMouse class that pre-installs a large 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.

To change between modes, two different controls are offered, a combo box and a menu system. These controls are lazily created in their respective 'getter' methods so they don't impact code that does not intend to use them. The menu control can be placed in an unused corner of the VisualizationScrollPane, which is a common location for mouse mode selection menus in mainstream applications.

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultModalGraphMouse.Builder<V,E,T extends DefaultModalGraphMouse,B extends DefaultModalGraphMouse.Builder<V,E,T,B>>	Build an instance of a DefaultGraphMouse
static class	DefaultModalGraphMouse.ModeKeyAdapter

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

Modal.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected int	addRegionSelectionCompleteMask
protected int	addRegionSelectionMask
protected int	addSingleSelectionMask
protected int	regionSelectionCompleteMask
protected int	regionSelectionMask
protected int	scalingMask
protected int	singleSelectionMask
protected int	translatingMask
protected int	xAxisScalingMask
protected int	yAxisScalingMask

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

animatedPickingPlugin, listenerList, mode, modeKeyListener, rotatingPlugin, shearingPlugin, translatingPlugin

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

in, out, regionSelectingPlugin, scalingPlugin, selectingPlugin, vertexSelectionOnly

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultModalGraphMouse()	create an instance with default values
protected	DefaultModalGraphMouse(DefaultModalGraphMouse.Builder<V,E,?,?> builder)	create an instance with default values
	DefaultModalGraphMouse(Modal.Mode mode, float in, float out, boolean vertexSelectionOnly, int singleSelectionMask, int addSingleSelectionMask, int regionSelectionMask, int addRegionSelectionMask, int regionSelectionCompleteMask, int addRegionSelectionCompleteMask, int translatingMask, int scalingMask, int xAxisScalingMask, int yAxisScalingMask)

Method Summary

Modifier and Type	Method	Description
static <V,E> DefaultModalGraphMouse.Builder<V,E,?,?>	builder()
void	loadPlugins()	create the plugins, and load the plugins for set mode

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

getMode, getModeKeyListener, setMode, setModeKeyListener, setPickingMode, setTransformingMode, setZoomAtMouse

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 org.jungrapht.visualization.control.modal.Modal

getMode, setMode

Methods inherited from interface org.jungrapht.visualization.control.ModalGraphMouse

getModeKeyListener

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, setPluginsLoaded

Field Detail

singleSelectionMask

protected int singleSelectionMask

addSingleSelectionMask

protected int addSingleSelectionMask

regionSelectionMask

protected int regionSelectionMask

addRegionSelectionMask

protected int addRegionSelectionMask

regionSelectionCompleteMask

protected int regionSelectionCompleteMask

addRegionSelectionCompleteMask

protected int addRegionSelectionCompleteMask

translatingMask

protected int translatingMask

scalingMask

protected int scalingMask

xAxisScalingMask

protected int xAxisScalingMask

yAxisScalingMask

protected int yAxisScalingMask

Constructor Detail

DefaultModalGraphMouse

public DefaultModalGraphMouse()

create an instance with default values

DefaultModalGraphMouse

protected DefaultModalGraphMouse(DefaultModalGraphMouse.Builder<V,E,?,?> builder)

create an instance with default values

DefaultModalGraphMouse

public DefaultModalGraphMouse(Modal.Mode mode,
                              float in,
                              float out,
                              boolean vertexSelectionOnly,
                              int singleSelectionMask,
                              int addSingleSelectionMask,
                              int regionSelectionMask,
                              int addRegionSelectionMask,
                              int regionSelectionCompleteMask,
                              int addRegionSelectionCompleteMask,
                              int translatingMask,
                              int scalingMask,
                              int xAxisScalingMask,
                              int yAxisScalingMask)

Method Detail

builder

public static <V,E> DefaultModalGraphMouse.Builder<V,E,?,?> builder()

loadPlugins

public void loadPlugins()

create the plugins, and load the plugins for set mode

Specified by:

loadPlugins in interface VisualizationViewer.GraphMouse