Package org.jungrapht.visualization.layout.model

Class AbstractLayoutModel<V>

java.lang.Object

org.jungrapht.visualization.layout.model.AbstractLayoutModel<V>

Type Parameters:

V - the vertex type

All Implemented Interfaces:

Function<V,Point>, LayoutSizeChange.Producer<V>, LayoutStateChange.Producer, LayoutVertexPositionChange.Listener<V>, LayoutVertexPositionChange.Producer<V>, ModelChange.Producer, ViewChange.Producer, LayoutModel<V>

Direct Known Subclasses:

DefaultLayoutModel

public abstract class AbstractLayoutModel<V>
extends Object
implements LayoutModel<V>

superclass for LayoutModels. Holds the required attributes for placing graph vertices in a visualization

Author:

Tom Nelson

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected int	appendageCount
protected boolean	createVisRunnable
protected org.jgrapht.Graph<V,?>	graph
protected int	height
protected Function<org.jgrapht.Graph<V,?>,Pair<Integer>>	initialDimensionFunction
protected LayoutSizeChange.Support	layoutSizeChangeSupport
protected LayoutStateChange.Support	layoutStateChangeSupport	Handles events fired when the LayoutModel is actively being modified by a LayoutAlgorithm
protected LayoutVertexPositionChange.Support	layoutVertexPositionSupport	Handles events fired when vertex locations are changed
protected boolean	locked
protected Set<V>	lockedVertices
protected ModelChange.Support	modelChangeSupport	Handles events fired when the Graph is changed
protected int	preferredHeight
protected int	preferredWidth
protected boolean	relaxing
protected ViewChange.Support	viewChangeSupport
protected VisRunnable	visRunnable
protected int	width

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLayoutModel(org.jgrapht.Graph<V,?> graph, int width, int height)
protected	AbstractLayoutModel(AbstractLayoutModel.Builder builder)
protected	AbstractLayoutModel(LayoutModel<V> other)

Method Summary

Modifier and Type	Method	Description
void	accept(LayoutAlgorithm<V> layoutAlgorithm)	accept the visit of a LayoutAlgorithm.
void	appendLayoutModel(LayoutModel<V> layoutModel)	Append the supplied layoutModel to the right of this LayoutModel by increasing the width of this layoutModel by the width of the supplied LayoutModel, and by offsetting all locations in the new layoutModel by the previous width of this layoutModel
<E> org.jgrapht.Graph<V,E>	getGraph()
int	getHeight()
LayoutSizeChange.Support	getLayoutSizeChangeSupport()
LayoutStateChange.Support	getLayoutStateChangeSupport()
LayoutVertexPositionChange.Support<V>	getLayoutVertexPositionSupport()
ModelChange.Support	getModelChangeSupport()
int	getPreferredHeight()
int	getPreferredWidth()
ViewChange.Support	getViewChangeSupport()
int	getWidth()
boolean	isLocked()
boolean	isLocked(V vertex)
boolean	isRelaxing()	indicates that there is a relaxer thread operating on this LayoutModel
void	layoutVertexPositionChanged(LayoutVertexPositionChange.Event<V> evt)
void	layoutVertexPositionChanged(LayoutVertexPositionChange.GraphEvent<V> evt)
void	lock(boolean locked)	lock the entire model (all vertices)
void	lock(V vertex, boolean locked)	set locked state for the provided vertex
protected void	offsetvertex(V vertex, double xOffset, double yOffset)
void	resizeToSurroundingRectangle()
void	set(V vertex, double x, double y)	Changes the layout coordinates of vertex to x, y.
void	set(V vertex, Point location)	Changes the layout coordinates of vertex to location.
void	setGraph(org.jgrapht.Graph<V,?> graph)
void	setInitialDimensionFunction(Function<org.jgrapht.Graph<V,?>,Pair<Integer>> initialDimensionFunction)	The initialDimensionFunction sets the layout area bounds by evaluating the Graph
void	setPreferredSize(int preferredWidth, int preferredHeight)
void	setRelaxing(boolean relaxing)	indicates that there is a relaxer thread operating on this LayoutModel
void	setSize(int width, int height)
void	setSize(int width, int height, boolean adjustLocations)
protected void	setupVisRunner(IterativeLayoutAlgorithm iterativeContext)	create and start a new VisRunner for the passed IterativeContext
void	stop()	stop any running Relaxer
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, apply, compose

Methods inherited from interface org.jungrapht.visualization.layout.model.LayoutModel

get, getCenter, getLocations, setFireEvents, setInitializer

Field Detail

lockedVertices

protected Set<V> lockedVertices

locked

protected boolean locked

width

protected int width

height

protected int height

preferredWidth

protected int preferredWidth

preferredHeight

protected int preferredHeight

createVisRunnable

protected boolean createVisRunnable

graph

protected org.jgrapht.Graph<V,?> graph

visRunnable

protected VisRunnable visRunnable

relaxing

protected boolean relaxing

layoutVertexPositionSupport

protected LayoutVertexPositionChange.Support layoutVertexPositionSupport

Handles events fired when vertex locations are changed

layoutStateChangeSupport

protected LayoutStateChange.Support layoutStateChangeSupport

Handles events fired when the LayoutModel is actively being modified by a LayoutAlgorithm

modelChangeSupport

protected ModelChange.Support modelChangeSupport

Handles events fired when the Graph is changed

viewChangeSupport

protected ViewChange.Support viewChangeSupport

layoutSizeChangeSupport

protected LayoutSizeChange.Support layoutSizeChangeSupport

appendageCount

protected int appendageCount

initialDimensionFunction

protected Function<org.jgrapht.Graph<V,?>,Pair<Integer>> initialDimensionFunction

Constructor Detail

AbstractLayoutModel

protected AbstractLayoutModel(AbstractLayoutModel.Builder builder)

AbstractLayoutModel

protected AbstractLayoutModel(LayoutModel<V> other)

AbstractLayoutModel

protected AbstractLayoutModel(org.jgrapht.Graph<V,?> graph,
                              int width,
                              int height)

Method Detail

setInitialDimensionFunction

public void setInitialDimensionFunction(Function<org.jgrapht.Graph<V,?>,Pair<Integer>> initialDimensionFunction)

Description copied from interface: LayoutModel

The initialDimensionFunction sets the layout area bounds by evaluating the Graph

Specified by:

setInitialDimensionFunction in interface LayoutModel<V>

stop

public void stop()

stop any running Relaxer

Specified by:

stop in interface LayoutModel<V>

accept

public void accept(LayoutAlgorithm<V> layoutAlgorithm)

accept the visit of a LayoutAlgorithm. If it is an IterativeContext, create a VisRunner to run its relaxer in a new Thread. If there is a current VisRunner, stop it first.

• set size to preferred width/height
• fire LayoutStateChanged event
• enable LayoutVertexPosition event firing
• fire ModelChanged event
• call the LayoutAlgorithm visit method to initiate the algorithm

Specified by:

accept in interface LayoutModel<V>

Parameters:

layoutAlgorithm - the algorithm to apply to the model vertex locations

getLayoutStateChangeSupport

public LayoutStateChange.Support getLayoutStateChangeSupport()

Specified by:

getLayoutStateChangeSupport in interface LayoutStateChange.Producer

getModelChangeSupport

public ModelChange.Support getModelChangeSupport()

Specified by:

getModelChangeSupport in interface ModelChange.Producer

getViewChangeSupport

public ViewChange.Support getViewChangeSupport()

Specified by:

getViewChangeSupport in interface ViewChange.Producer

setupVisRunner

protected void setupVisRunner(IterativeLayoutAlgorithm iterativeContext)

create and start a new VisRunner for the passed IterativeContext

Parameters:

iterativeContext - the algorithm to run in a thread

getGraph

public <E> org.jgrapht.Graph<V,E> getGraph()

Specified by:

getGraph in interface LayoutModel<V>

Returns:

the graph

setGraph

public void setGraph(org.jgrapht.Graph<V,?> graph)

Specified by:

setGraph in interface LayoutModel<V>

Parameters:

graph - the Graph to set

lock

public void lock(V vertex,
                 boolean locked)

set locked state for the provided vertex

Specified by:

lock in interface LayoutModel<V>

Parameters:

vertex - the vertex to affect

locked - to lock or not

isLocked

public boolean isLocked(V vertex)

Specified by:

isLocked in interface LayoutModel<V>

Parameters:

vertex - the vertex whose locked state is being queried

Returns:

whether the passed vertex is locked

lock

public void lock(boolean locked)

lock the entire model (all vertices)

Specified by:

lock in interface LayoutModel<V>

Parameters:

locked - will prevent the vertices from being moved

isLocked

public boolean isLocked()

Specified by:

isLocked in interface LayoutModel<V>

Returns:

whether this LayoutModel is locked for all vertices

setSize

public void setSize(int width,
                    int height)

Specified by:

setSize in interface LayoutModel<V>

Parameters:

width - to set

height - to set

setPreferredSize

public void setPreferredSize(int preferredWidth,
                             int preferredHeight)

Specified by:

setPreferredSize in interface LayoutModel<V>

Parameters:

preferredWidth - to set

preferredHeight - to set

setSize

public void setSize(int width,
                    int height,
                    boolean adjustLocations)

getWidth

public int getWidth()

Specified by:

getWidth in interface LayoutModel<V>

Returns:

the width of the layout domain

getHeight

public int getHeight()

Specified by:

getHeight in interface LayoutModel<V>

Returns:

the height of the layout domain

getPreferredWidth

public int getPreferredWidth()

Specified by:

getPreferredWidth in interface LayoutModel<V>

Returns:

the width of the layout domain

getPreferredHeight

public int getPreferredHeight()

Specified by:

getPreferredHeight in interface LayoutModel<V>

Returns:

the height of the layout domain

set

public void set(V vertex,
                double x,
                double y)

Description copied from interface: LayoutModel

Changes the layout coordinates of vertex to x, y.

Specified by:

set in interface LayoutModel<V>

Parameters:

vertex - the vertex to set location for

x - coordinate to set

y - coordinate to set

set

public void set(V vertex,
                Point location)

Description copied from interface: LayoutModel

Changes the layout coordinates of vertex to location.

Specified by:

set in interface LayoutModel<V>

Parameters:

vertex - the vertex whose location is to be specified

location - the coordinates of the specified location

offsetvertex

protected void offsetvertex(V vertex,
                            double xOffset,
                            double yOffset)

Parameters:

vertex - the vertex whose coordinates are to be offset

xOffset - the change to apply to this vertex's x coordinate

yOffset - the change to apply to this vertex's y coordinate

getLayoutVertexPositionSupport

public LayoutVertexPositionChange.Support<V> getLayoutVertexPositionSupport()

Specified by:

getLayoutVertexPositionSupport in interface LayoutVertexPositionChange.Producer<V>

getLayoutSizeChangeSupport

public LayoutSizeChange.Support getLayoutSizeChangeSupport()

Specified by:

getLayoutSizeChangeSupport in interface LayoutSizeChange.Producer<V>

isRelaxing

public boolean isRelaxing()

Description copied from interface: LayoutModel

indicates that there is a relaxer thread operating on this LayoutModel

Specified by:

isRelaxing in interface LayoutModel<V>

Returns:

relaxing

setRelaxing

public void setRelaxing(boolean relaxing)

Description copied from interface: LayoutModel

indicates that there is a relaxer thread operating on this LayoutModel

Specified by:

setRelaxing in interface LayoutModel<V>

Parameters:

relaxing - whether there is a relaxer thread

layoutVertexPositionChanged

public void layoutVertexPositionChanged(LayoutVertexPositionChange.Event<V> evt)

Specified by:

layoutVertexPositionChanged in interface LayoutVertexPositionChange.Listener<V>

layoutVertexPositionChanged

public void layoutVertexPositionChanged(LayoutVertexPositionChange.GraphEvent<V> evt)

Specified by:

layoutVertexPositionChanged in interface LayoutVertexPositionChange.Listener<V>

resizeToSurroundingRectangle

public void resizeToSurroundingRectangle()

Specified by:

resizeToSurroundingRectangle in interface LayoutModel<V>

toString

public String toString()

Overrides:

toString in class Object

appendLayoutModel

public void appendLayoutModel(LayoutModel<V> layoutModel)

Append the supplied layoutModel to the right of this LayoutModel by increasing the width of this layoutModel by the width of the supplied LayoutModel, and by offsetting all locations in the new layoutModel by the previous width of this layoutModel

Specified by:

appendLayoutModel in interface LayoutModel<V>

Parameters:

layoutModel - contains width and vertex locations to place