Package org.jungrapht.visualization.control

Class EditingGraphMousePlugin<V,E>

java.lang.Object

org.jungrapht.visualization.control.AbstractGraphMousePlugin

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

Type Parameters:

V - vertex type

E - edge type

All Implemented Interfaces:

MouseListener, MouseMotionListener, EventListener, GraphMousePlugin

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

A plugin that can create vertices, undirected edges, and directed edges using mouse gestures.

vertexSupport and edgeSupport member classes are responsible for actually creating the new graph elements, and for repainting the view when changes were made.

Author:

Tom Nelson

Nested Class Summary

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

AbstractGraphMousePlugin.Selecting

Field Summary

Fields

Modifier and Type	Field	Description
protected EdgeSupport<V,E>	edgeSupport
protected int	modifiers
protected VertexSupport<V,E>	vertexSupport

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

cursor, down

Constructor Summary

Constructors

Constructor	Description
EditingGraphMousePlugin(int modifiers, Supplier<V> vertexFactory, Supplier<E> edgeFactory)	Creates an instance and prepares shapes for visual effects.
EditingGraphMousePlugin(Supplier<V> vertexFactory, Supplier<E> edgeFactory)	Creates an instance and prepares shapes for visual effects, using the default modifiers of BUTTON1_DOWN_MASK.

Method Summary

Modifier and Type	Method	Description
boolean	checkModifiers(MouseEvent e)	Overridden to be more flexible, and pass events with key combinations.
EdgeSupport<V,E>	edgesupport()
VertexSupport<V,E>	getVertexSupport()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)	If startVertex is non-null, stretch an edge shape between startVertex and the mouse pointer to simulate edge creation
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)	If the mouse is pressed in an empty area, create a new vertex there.
void	mouseReleased(MouseEvent e)	If startVertex is non-null, and the mouse is released over an existing vertex, create an edge from startVertex to the vertex under the mouse pointer.
void	setEdgeSupport(EdgeSupport<V,E> edgeSupport)
void	setVertexSupport(VertexSupport<V,E> vertexSupport)

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

getCursor, getModifiersEx, setCursor, setModifiers

Methods inherited from class java.lang.Object

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

Field Detail

vertexSupport

protected VertexSupport<V,E> vertexSupport

edgeSupport

protected EdgeSupport<V,E> edgeSupport

modifiers

protected int modifiers

Constructor Detail

EditingGraphMousePlugin

public EditingGraphMousePlugin(Supplier<V> vertexFactory,
                               Supplier<E> edgeFactory)

Creates an instance and prepares shapes for visual effects, using the default modifiers of BUTTON1_DOWN_MASK.

Parameters:

vertexFactory - for creating vertices

edgeFactory - for creating edges

EditingGraphMousePlugin

public EditingGraphMousePlugin(int modifiers,
                               Supplier<V> vertexFactory,
                               Supplier<E> edgeFactory)

Creates an instance and prepares shapes for visual effects.

Parameters:

modifiers - the mouse event modifiers to use

vertexFactory - for creating vertices

edgeFactory - for creating edges

Method Detail

checkModifiers

public boolean checkModifiers(MouseEvent e)

Overridden to be more flexible, and pass events with key combinations. The default responds to both ButtonOne and ButtonOne+Shift

Specified by:

checkModifiers in interface GraphMousePlugin

Overrides:

checkModifiers in class AbstractGraphMousePlugin

Parameters:

e - an event to compare to

Returns:

whether the member modifiers match the event modifiers

mousePressed

public void mousePressed(MouseEvent e)

If the mouse is pressed in an empty area, create a new vertex there. If the mouse is pressed on an existing vertex, prepare to create an edge from that vertex to another

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

If startVertex is non-null, and the mouse is released over an existing vertex, create an edge from startVertex to the vertex under the mouse pointer.

Specified by:

mouseReleased in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

If startVertex is non-null, stretch an edge shape between startVertex and the mouse pointer to simulate edge creation

Specified by:

mouseDragged in interface MouseMotionListener

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

getVertexSupport

public VertexSupport<V,E> getVertexSupport()

setVertexSupport

public void setVertexSupport(VertexSupport<V,E> vertexSupport)

edgesupport

public EdgeSupport<V,E> edgesupport()

setEdgeSupport

public void setEdgeSupport(EdgeSupport<V,E> edgeSupport)