Package org.jungrapht.visualization

Interface VisualizationViewer<V,E>

All Superinterfaces:

ChangeListener, EventListener, LayoutSizeChange.Listener, LayoutStateChange.Listener, ModelChange.Listener, RenderContextStateChange.Listener, ViewChange.Listener, VisualizationComponent, VisualizationServer<V,E>

All Known Subinterfaces:

SatelliteVisualizationViewer<V,E>

All Known Implementing Classes:

AbstractSatelliteVisualizationViewer, AbstractVisualizationViewer, DefaultSatelliteVisualizationViewer

public interface VisualizationViewer<V,E>
extends VisualizationServer<V,E>

Adds mouse behaviors and tooltips to the graph VisualizationServer base class

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	VisualizationViewer.Builder<V,E,T extends org.jungrapht.visualization.DefaultVisualizationViewer<V,E>,B extends VisualizationViewer.Builder<V,E,T,B>>	Builder for VisualizationViewer instances
static interface	VisualizationViewer.GraphMouse	a convenience type to represent a class that processes all types of mouse events for the graph

Nested classes/interfaces inherited from interface org.jungrapht.visualization.VisualizationServer

VisualizationServer.Paintable

Method Summary

Modifier and Type	Method	Description
void	addGraphMouseListener(GraphMouseListener<V> graphMouseListener)	This is the interface for adding a mouse listener.
void	addKeyListener(KeyListener l)	Override to request focus on mouse enter, if a key listener is added
static <V,E> VisualizationViewer.Builder<V,E,?,?>	builder()
static <V,E> VisualizationViewer.Builder<V,E,?,?>	builder(org.jgrapht.Graph<V,E> graph)
static <V,E> VisualizationViewer.Builder<V,E,?,?>	builder(VisualizationModel<V,E> visualizationModel)
VisualizationViewer.GraphMouse	getGraphMouse()
Supplier<MultiSelectionStrategy>	getMultiSelectionStrategySupplier()
String	getToolTipText(MouseEvent event)	called by the superclass to display tooltips
void	setEdgeToolTipFunction(Function<E,String> edgeToolTipFunction)
void	setGraphMouse(VisualizationViewer.GraphMouse graphMouse)	a setter for the GraphMouse.
void	setMouseEventToolTipFunction(Function<MouseEvent,String> mouseEventToolTipFunction)
void	setMultiSelectionStrategySupplier(Supplier<MultiSelectionStrategy> multiSelectionStrategySupplier)
void	setToolTipText(String toolTipText)
void	setVertexToolTipFunction(Function<V,String> vertexToolTipFunction)

Methods inherited from interface org.jungrapht.visualization.layout.event.LayoutSizeChange.Listener

layoutSizeChanged

Methods inherited from interface org.jungrapht.visualization.layout.event.LayoutStateChange.Listener

layoutStateChanged

Methods inherited from interface org.jungrapht.visualization.layout.event.ModelChange.Listener

modelChanged

Methods inherited from interface org.jungrapht.visualization.RenderContextStateChange.Listener

renderContextStateChanged

Methods inherited from interface org.jungrapht.visualization.layout.event.ViewChange.Listener

viewChanged

Methods inherited from interface org.jungrapht.visualization.VisualizationComponent

add, add, getBackground, getBounds, getComponent, getFont, getHeight, getPreferredSize, getSize, getToolTipText, getWidth, setBackground, setCursor, setFont, setForeground, setLayout, setPreferredSize

Methods inherited from interface org.jungrapht.visualization.VisualizationServer

addChangeListener, addPostRenderPaintable, addPreRenderPaintable, fireStateChanged, getCenter, getChangeListeners, getEdgeSpatial, getPickSupport, getRenderContext, getRenderer, getRenderingHints, getSelectedEdges, getSelectedEdgeState, getSelectedVertexState, getSelectedVertices, getTransformSupport, getVertexSpatial, getVisualizationModel, isDoubleBuffered, prependPreRenderPaintable, removeChangeListener, removePostRenderPaintable, removePreRenderPaintable, repaint, reset, resizeToLayout, scaleToLayout, scaleToLayout, scaleToLayout, scaleToLayout, setDoubleBuffered, setEdgeSpatial, setInitialDimensionFunction, setPickSupport, setRenderContext, setRenderingHints, setSelectedEdgeState, setSelectedVertexState, setTransformSupport, setVertexSpatial, setVisible, setVisualizationModel, stateChanged, viewOnLayout

Method Detail

builder

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

Type Parameters:

V - vertex type

E - edge type

Returns:

the builder

builder

static <V,E> VisualizationViewer.Builder<V,E,?,?> builder(org.jgrapht.Graph<V,E> graph)

Type Parameters:

V - the vertex type

E - the edge type

Parameters:

graph - the graph to be visualized

Returns:

the builder

builder

static <V,E> VisualizationViewer.Builder<V,E,?,?> builder(VisualizationModel<V,E> visualizationModel)

Type Parameters:

V - the vertex type

E - the edge type

Parameters:

visualizationModel - the model to hold visualization state

Returns:

the builder

setGraphMouse

void setGraphMouse(VisualizationViewer.GraphMouse graphMouse)

a setter for the GraphMouse. This will remove any previous GraphMouse (including the one that is added in the initMouseClicker method.

Parameters:

graphMouse - new value

getGraphMouse

VisualizationViewer.GraphMouse getGraphMouse()

Returns:

the current GraphMouse

addGraphMouseListener

void addGraphMouseListener(GraphMouseListener<V> graphMouseListener)

This is the interface for adding a mouse listener. The GEL will be called back with mouse clicks on vertices.

Parameters:

graphMouseListener - the mouse listener to add

addKeyListener

void addKeyListener(KeyListener l)

Override to request focus on mouse enter, if a key listener is added

See Also:

Component.addKeyListener(java.awt.event.KeyListener)

setEdgeToolTipFunction

void setEdgeToolTipFunction(Function<E,String> edgeToolTipFunction)

Parameters:

edgeToolTipFunction - the edgeToolTipFunction to set

setMouseEventToolTipFunction

void setMouseEventToolTipFunction(Function<MouseEvent,String> mouseEventToolTipFunction)

Parameters:

mouseEventToolTipFunction - the mouseEventToolTipFunction to set

setVertexToolTipFunction

void setVertexToolTipFunction(Function<V,String> vertexToolTipFunction)

Parameters:

vertexToolTipFunction - the vertexToolTipFunction to set

getToolTipText

String getToolTipText(MouseEvent event)

called by the superclass to display tooltips

setToolTipText

void setToolTipText(String toolTipText)

getMultiSelectionStrategySupplier

Supplier<MultiSelectionStrategy> getMultiSelectionStrategySupplier()

setMultiSelectionStrategySupplier

void setMultiSelectionStrategySupplier(Supplier<MultiSelectionStrategy> multiSelectionStrategySupplier)