Package org.jungrapht.visualization.control

Class RegionSelectingGraphMousePlugin<V,E>

java.lang.Object

org.jungrapht.visualization.control.AbstractGraphMousePlugin

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

Type Parameters:

V - vertex type

E - edge type

All Implemented Interfaces:

MouseListener, MouseMotionListener, EventListener, GraphMousePlugin

Direct Known Subclasses:

LensRegionSelectingGraphMousePlugin

public class RegionSelectingGraphMousePlugin<V,E>
extends AbstractGraphMousePlugin
implements MouseListener, MouseMotionListener

RegionSelectingGraphMousePlugin supports the selecting of graph elements with the mouse. MouseButtonOne selects a single vertex or edge, and MouseButtonTwo adds to the set of selected Vertices or EdgeType. If a Vertex is selected and the mouse is dragged while on the selected Vertex, then that Vertex will be repositioned to follow the mouse until the button is released.

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegionSelectingGraphMousePlugin.Builder<V,E,T extends RegionSelectingGraphMousePlugin,B extends RegionSelectingGraphMousePlugin.Builder<V,E,T,B>>

Nested classes/interfaces inherited from class org.jungrapht.visualization.control.AbstractGraphMousePlugin

AbstractGraphMousePlugin.Selecting

Field Summary

Fields

Modifier and Type	Field	Description
protected int	addRegionSelectionCompleteMask
protected int	addRegionSelectionMask
protected int	addSingleSelectionMask
protected Point2D	deltaDown
protected Shape	layoutTargetShape
protected Color	lensColor	color for the picking rectangle
protected VisualizationServer.Paintable	lensPaintable	the Paintable for the lens picking rectangle
protected boolean	locked	controls whether the Vertices may be moved with the mouse
protected MultiSelectionStrategy	multiSelectionStrategy
protected int	regionSelectionCompleteMask
protected int	regionSelectionMask
protected int	singleSelectionMask
protected Shape	viewRectangle	used to draw a rectangle to contain selected vertices

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

cursor, down, modifiers

Constructor Summary

Constructors

Modifier	Constructor	Description
	RegionSelectingGraphMousePlugin()
protected	RegionSelectingGraphMousePlugin(int regionSelectionMask, int addRegionSelectionMask, int regionSelectionCompleteMask, int addRegionSelectionCompleteMask)	create an instance with overrides
	RegionSelectingGraphMousePlugin(RegionSelectingGraphMousePlugin.Builder<V,E,?,?> builder)

Method Summary

Modifier and Type	Method	Description
static <V,E> RegionSelectingGraphMousePlugin.Builder<V,E,?,?>	builder()
Color	getLensColor()
protected Point2D	inverseTransform(VisualizationViewer<V,E> vv, Point2D p)	override to consider Lens effects
boolean	isLocked()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)	If the mouse is over a selected vertex, drag all selected vertices with the mouse.
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)	For primary modifiers (default, MouseButton1): pick a single Vertex or Edge that is under the mouse pointer.
void	mouseReleased(MouseEvent e)	If the mouse is dragging a rectangle, pick the Vertices contained in that rectangle
protected Collection<V>	pickContainedVertices(VisualizationViewer<V,E> vv, Shape pickTarget, boolean clear)	pick the vertices inside the rectangle created from points 'down' and 'out' (two diagonally opposed corners of the rectangle)
void	setLensColor(Color lensColor)
void	setLocked(boolean locked)
String	toString()
protected Shape	transform(VisualizationViewer<V,E> vv, Shape shape)	override to consider Lens effects
protected void	updatePickingTargets(VisualizationViewer vv, MultiLayerTransformer multiLayerTransformer, Point2D down, Point2D out)	override to consider Lens effects

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

checkModifiers, getCursor, getModifiersEx, setCursor, setModifiers

Methods inherited from class java.lang.Object

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

Field Detail

locked

protected boolean locked

controls whether the Vertices may be moved with the mouse

viewRectangle

protected Shape viewRectangle

used to draw a rectangle to contain selected vertices

layoutTargetShape

protected Shape layoutTargetShape

lensPaintable

protected VisualizationServer.Paintable lensPaintable

the Paintable for the lens picking rectangle

lensColor

protected Color lensColor

color for the picking rectangle

deltaDown

protected Point2D deltaDown

multiSelectionStrategy

protected MultiSelectionStrategy multiSelectionStrategy

singleSelectionMask

protected int singleSelectionMask

addSingleSelectionMask

protected int addSingleSelectionMask

regionSelectionMask

protected int regionSelectionMask

addRegionSelectionMask

protected int addRegionSelectionMask

regionSelectionCompleteMask

protected int regionSelectionCompleteMask

addRegionSelectionCompleteMask

protected int addRegionSelectionCompleteMask

Constructor Detail

RegionSelectingGraphMousePlugin

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

RegionSelectingGraphMousePlugin

public RegionSelectingGraphMousePlugin()

RegionSelectingGraphMousePlugin

protected RegionSelectingGraphMousePlugin(int regionSelectionMask,
                                          int addRegionSelectionMask,
                                          int regionSelectionCompleteMask,
                                          int addRegionSelectionCompleteMask)

create an instance with overrides

// * @param selectionModifiers for primary selection // * @param addToSelectionModifiers for additional selection

Method Detail

builder

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

getLensColor

public Color getLensColor()

Returns:

Returns the lensColor.

setLensColor

public void setLensColor(Color lensColor)

Parameters:

lensColor - The lensColor to set.

mousePressed

public void mousePressed(MouseEvent e)

For primary modifiers (default, MouseButton1): pick a single Vertex or Edge that is under the mouse pointer. If no Vertex or edge is under the pointer, unselect all selected Vertices and edges, and set up to draw a rectangle for multiple selection of contained Vertices. For additional selection (default Shift+MouseButton1): Add to the selection, a single Vertex or Edge that is under the mouse pointer. If a previously selected Vertex or Edge is under the pointer, it is un-selected. If no vertex or Edge is under the pointer, set up to draw a multiple selection rectangle (as above) but do not unpick previously selected elements.

Specified by:

mousePressed in interface MouseListener

Parameters:

e - the event

mouseReleased

public void mouseReleased(MouseEvent e)

If the mouse is dragging a rectangle, pick the Vertices contained in that rectangle

clean up settings from mousePressed

Specified by:

mouseReleased in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

If the mouse is over a selected vertex, drag all selected vertices with the mouse. If the mouse is not over a Vertex, draw the rectangle to select multiple Vertices

Specified by:

mouseDragged in interface MouseMotionListener

inverseTransform

protected Point2D inverseTransform(VisualizationViewer<V,E> vv,
                                   Point2D p)

override to consider Lens effects

Parameters:

vv -

p -

Returns:

transform

protected Shape transform(VisualizationViewer<V,E> vv,
                          Shape shape)

override to consider Lens effects

Parameters:

vv -

shape -

Returns:

updatePickingTargets

protected void updatePickingTargets(VisualizationViewer vv,
                                    MultiLayerTransformer multiLayerTransformer,
                                    Point2D down,
                                    Point2D out)

override to consider Lens effects

Parameters:

vv -

multiLayerTransformer -

down -

out -

pickContainedVertices

protected Collection<V> pickContainedVertices(VisualizationViewer<V,E> vv,
                                              Shape pickTarget,
                                              boolean clear)

pick the vertices inside the rectangle created from points 'down' and 'out' (two diagonally opposed corners of the rectangle)

Parameters:

vv - the viewer containing the layout and selected state

pickTarget - - the shape to pick vertices in (layout coordinate system)

clear - whether to reset existing selected state

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

isLocked

public boolean isLocked()

Returns:

Returns the locked.

setLocked

public void setLocked(boolean locked)

Parameters:

locked - The locked to set.

toString

public String toString()

Overrides:

toString in class Object