Package org.jungrapht.visualization.layout.model

Interface LayoutModel<V>

All Superinterfaces:

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

All Known Implementing Classes:

AbstractLayoutModel, AggregateLayoutModel, DefaultLayoutModel

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

two dimensional layout model. Acts as a Mediator between the Graph vertices and their locations in the Cartesian coordinate system.

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LayoutModel.Builder<V,T extends DefaultLayoutModel<V>,B extends LayoutModel.Builder<V,T,B>>	a builder for LayoutModel instances

Method Summary

Modifier and Type	Method	Description
void	accept(LayoutAlgorithm<V> layoutAlgorithm)	allow the passed LayoutAlgorithm to operate on this LayoutModel
void	appendLayoutModel(LayoutModel<V> layoutModel)
static <V> LayoutModel.Builder<V,?,?>	builder()
Point	get(V vertex)
default Point	getCenter()
<E> org.jgrapht.Graph<V,E>	getGraph()
int	getHeight()
default Map<V,Point>	getLocations()
int	getPreferredHeight()
int	getPreferredWidth()
int	getWidth()
boolean	isLocked()
boolean	isLocked(V vertex)
boolean	isRelaxing()	indicates that there is a relaxer thread operating on this LayoutModel
void	lock(boolean locked)
void	lock(V vertex, boolean locked)
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.
default void	setFireEvents(boolean fireEvents)
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	setInitializer(Function<V,Point> initializer)
void	setPreferredSize(int width, int helght)
void	setRelaxing(boolean relaxing)	indicates that there is a relaxer thread operating on this LayoutModel
void	setSize(int width, int helght)
default void	stop()	stop a relaxer Thread from continuing to operate

Methods inherited from interface java.util.function.Function

andThen, apply, compose

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

getLayoutSizeChangeSupport

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

getLayoutStateChangeSupport

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

layoutVertexPositionChanged, layoutVertexPositionChanged

Methods inherited from interface org.jungrapht.visualization.layout.event.LayoutVertexPositionChange.Producer

getLayoutVertexPositionSupport

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

getModelChangeSupport

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

getViewChangeSupport

Method Detail

builder

static <V> LayoutModel.Builder<V,?,?> builder()

getWidth

int getWidth()

Returns:

the width of the layout area

getHeight

int getHeight()

Returns:

the height of the layout area

getPreferredWidth

int getPreferredWidth()

getPreferredHeight

int getPreferredHeight()

getCenter

default Point getCenter()

accept

void accept(LayoutAlgorithm<V> layoutAlgorithm)

allow the passed LayoutAlgorithm to operate on this LayoutModel

Parameters:

layoutAlgorithm - the algorithm to apply to this model's Points

getLocations

default Map<V,Point> getLocations()

Returns:

a mapping of Vertices to Point locations

setInitialDimensionFunction

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

The initialDimensionFunction sets the layout area bounds by evaluating the Graph

Parameters:

initialDimensionFunction -

setSize

void setSize(int width,
             int helght)

Parameters:

width - to set

helght - to set

setPreferredSize

void setPreferredSize(int width,
                      int helght)

Parameters:

width - to set

helght - to set

stop

default void stop()

stop a relaxer Thread from continuing to operate

setRelaxing

void setRelaxing(boolean relaxing)

indicates that there is a relaxer thread operating on this LayoutModel

Parameters:

relaxing - whether there is a relaxer thread

isRelaxing

boolean isRelaxing()

indicates that there is a relaxer thread operating on this LayoutModel

Returns:

relaxing

isLocked

boolean isLocked(V vertex)

Parameters:

vertex - the vertex whose locked state is being queried

Returns:

true if the position of vertex v is locked

set

void set(V vertex,
         Point location)

Changes the layout coordinates of vertex to location.

Parameters:

vertex - the vertex whose location is to be specified

location - the coordinates of the specified location

set

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

Changes the layout coordinates of vertex to x, y.

Parameters:

vertex - the vertex to set location for

x - coordinate to set

y - coordinate to set

get

Point get(V vertex)

Parameters:

vertex - the vertex of interest

Returns:

the Point location for vertex

getGraph

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

Returns:

the Graph that this model is mediating

setGraph

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

Parameters:

graph - the Graph to set

lock

void lock(V vertex,
          boolean locked)

lock

void lock(boolean locked)

isLocked

boolean isLocked()

setInitializer

void setInitializer(Function<V,Point> initializer)

resizeToSurroundingRectangle

void resizeToSurroundingRectangle()

appendLayoutModel

void appendLayoutModel(LayoutModel<V> layoutModel)

setFireEvents

default void setFireEvents(boolean fireEvents)