Package org.jungrapht.visualization.layout.algorithms

Class AbstractTreeLayoutAlgorithm<V>

java.lang.Object

org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.AbstractTreeLayoutAlgorithm<V>

Type Parameters:

V - vertex type

All Implemented Interfaces:

Consumer<Function<V,Rectangle>>, LayoutAlgorithm<V>, TreeLayout<V>, AfterRunnable, VertexBoundsFunctionConsumer<V>

Direct Known Subclasses:

TidierTreeLayoutAlgorithm, TreeLayoutAlgorithm

public abstract class AbstractTreeLayoutAlgorithm<V>
extends AbstractLayoutAlgorithm<V>
implements LayoutAlgorithm<V>, TreeLayout<V>

A base class for tree layout algorithms.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractTreeLayoutAlgorithm.Builder<V,T extends AbstractTreeLayoutAlgorithm<V>,B extends AbstractTreeLayoutAlgorithm.Builder<V,T,B>>	A Builder to create instances of AbstractTreeLayoutAlgorithm

Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

LayoutAlgorithm.NoOp<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<V,Rectangle>	baseBounds	a {}@link Map} of vertex to a Rectangle that will contain the vertex and all of its children
protected boolean	correctOverlap	if true then move vertices that overlap non-incident edges
protected Predicate<V>	defaultRootPredicate
protected boolean	expandLayout	if true then expand the layout size to accomodate the entire tree.
protected int	horizontalVertexSpacing	The horizontal vertex spacing.
protected org.jgrapht.alg.util.NeighborCache<V,?>	neighborCache
protected Comparator<V>	rootComparator
protected Predicate<V>	rootPredicate	the {}@link Predicate} to determine root vertices
protected Function<V,Rectangle>	vertexBoundsFunction	if provided (non-null) then the horizontalVertexSpacing and verticalVertexSpacing values will be replaced by 2 times the average width and height of all vertex shapes
protected int	verticalVertexSpacing	The vertical vertex spacing.
protected Set<V>	visitedVertices

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

after

Fields inherited from interface org.jungrapht.visualization.layout.algorithms.TreeLayout

TREE_LAYOUT_HORIZONTAL_SPACING, TREE_LAYOUT_VERTICAL_SPACING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTreeLayoutAlgorithm(AbstractTreeLayoutAlgorithm.Builder<V,?,?> builder)	Create a AbstractTreeLayoutAlgorithm instance with the passed Builder

Method Summary

Modifier and Type	Method	Description
protected void	adjustToFill(int largerWidth, int largerHeight)
boolean	constrained()
protected void	expandToFill(LayoutModel<V> layoutModel)
Map<V,Rectangle>	getBaseBounds()
protected <E> int	moveVerticesThatOverlapVerticalEdges(LayoutModel<V> layoutModel, int offset)
void	setRootComparator(Comparator<V> rootComparator)
void	setRootPredicate(Predicate<V> rootPredicate)
void	setVertexBoundsFunction(Function<V,Rectangle> vertexBoundsFunction)
void	visit(LayoutModel<V> layoutModel)	visit a LayoutModel to set all of the graph vertex positions according to the LayoutAlgorithm logic.

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

computeAverageVertexDimension, computeLayoutExtent, expandToFill, runAfter, setAfter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.AfterRunnable

runAfter, setAfter

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

cancel

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.VertexBoundsFunctionConsumer

accept

Field Detail

rootPredicate

protected Predicate<V> rootPredicate

the {}@link Predicate} to determine root vertices

defaultRootPredicate

protected Predicate<V> defaultRootPredicate

rootComparator

protected Comparator<V> rootComparator

visitedVertices

protected Set<V> visitedVertices

neighborCache

protected org.jgrapht.alg.util.NeighborCache<V,?> neighborCache

baseBounds

protected Map<V,Rectangle> baseBounds

a {}@link Map} of vertex to a Rectangle that will contain the vertex and all of its children

horizontalVertexSpacing

protected int horizontalVertexSpacing

The horizontal vertex spacing. Defaults to DEFAULT_HORIZONTAL_VERTEX_SPACING.

verticalVertexSpacing

protected int verticalVertexSpacing

The vertical vertex spacing. Defaults to DEFAULT_VERTICAL_VERTEX_SPACING.

vertexBoundsFunction

protected Function<V,Rectangle> vertexBoundsFunction

if provided (non-null) then the horizontalVertexSpacing and verticalVertexSpacing values will be replaced by 2 times the average width and height of all vertex shapes

expandLayout

protected boolean expandLayout

if true then expand the layout size to accomodate the entire tree.

correctOverlap

protected boolean correctOverlap

if true then move vertices that overlap non-incident edges

Constructor Detail

AbstractTreeLayoutAlgorithm

protected AbstractTreeLayoutAlgorithm(AbstractTreeLayoutAlgorithm.Builder<V,?,?> builder)

Create a AbstractTreeLayoutAlgorithm instance with the passed Builder

Parameters:

builder - the Builder with configuration properties

Method Detail

setRootPredicate

public void setRootPredicate(Predicate<V> rootPredicate)

Specified by:

setRootPredicate in interface TreeLayout<V>

setRootComparator

public void setRootComparator(Comparator<V> rootComparator)

Specified by:

setRootComparator in interface TreeLayout<V>

setVertexBoundsFunction

public void setVertexBoundsFunction(Function<V,Rectangle> vertexBoundsFunction)

Specified by:

setVertexBoundsFunction in interface VertexBoundsFunctionConsumer<V>

visit

public void visit(LayoutModel<V> layoutModel)

visit a LayoutModel to set all of the graph vertex positions according to the LayoutAlgorithm logic.

Specified by:

visit in interface LayoutAlgorithm<V>

Parameters:

layoutModel - the mediator between the container for vertices (the Graph) and the mapping

getBaseBounds

public Map<V,Rectangle> getBaseBounds()

Specified by:

getBaseBounds in interface TreeLayout<V>

Returns:

the Map of vertex to Rectangle that will hold all of the subtree rooted at the vertex

adjustToFill

protected void adjustToFill(int largerWidth,
                            int largerHeight)

expandToFill

protected void expandToFill(LayoutModel<V> layoutModel)

Parameters:

layoutModel -

moveVerticesThatOverlapVerticalEdges

protected <E> int moveVerticesThatOverlapVerticalEdges(LayoutModel<V> layoutModel,
                                                       int offset)

constrained

public boolean constrained()

Specified by:

constrained in interface LayoutAlgorithm<V>