Package org.jungrapht.visualization.layout.algorithms

Class MultiRowTreeLayoutAlgorithm<V>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MultiRowEdgeAwareTreeLayoutAlgorithm

public class MultiRowTreeLayoutAlgorithm<V>
extends TreeLayoutAlgorithm<V>
implements LayoutAlgorithm<V>

A TreeLayoutAlgorithm that adheres to either an original width or to the width of the widest subtree in the forest by creating new rows of tree roots

Author:

Tom Nelson

Nested Class Summary

Nested Classes

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

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

LayoutAlgorithm.NoOp<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	rowCount	keeps track of how many rows have been created

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

baseBounds, correctOverlap, defaultRootPredicate, expandLayout, horizontalVertexSpacing, neighborCache, rootComparator, rootPredicate, vertexBoundsFunction, verticalVertexSpacing, 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
	MultiRowTreeLayoutAlgorithm()
protected	MultiRowTreeLayoutAlgorithm(MultiRowTreeLayoutAlgorithm.Builder<V,?,?> builder)

Method Summary

Modifier and Type	Method	Description
static <V> MultiRowTreeLayoutAlgorithm.Builder<V,?,?>	builder()
protected Set<V>	buildTree(LayoutModel<V> layoutModel)	Build the entire forest, first measuring the width and height, then possibly expanding the layout area, then placing the vertices under rows of tree roots
protected int	calculateOverallHeight(LayoutModel<V> layoutModel, Collection<V> roots, int overallWidth)	Calculate the overall height of the entire forest
protected int	calculateWidth(LayoutModel<V> layoutModel, Collection<V> roots, Set<V> seen)	Calculate the width of the entire forest
boolean	constrained()

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

buildTree, calculateHeight, calculateHeight, calculateWidth, getBaseBounds, getCenter, getInitialPosition, getSpanningTree, merge, visit

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

adjustToFill, expandToFill, moveVerticesThatOverlapVerticalEdges, setRootComparator, setRootPredicate, setVertexBoundsFunction

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, visit

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

setRootComparator, setRootPredicate

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

accept, setVertexBoundsFunction

Field Detail

rowCount

protected int rowCount

keeps track of how many rows have been created

Constructor Detail

MultiRowTreeLayoutAlgorithm

public MultiRowTreeLayoutAlgorithm()

MultiRowTreeLayoutAlgorithm

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

Method Detail

builder

public static <V> MultiRowTreeLayoutAlgorithm.Builder<V,?,?> builder()

buildTree

protected Set<V> buildTree(LayoutModel<V> layoutModel)

Build the entire forest, first measuring the width and height, then possibly expanding the layout area, then placing the vertices under rows of tree roots

Overrides:

buildTree in class TreeLayoutAlgorithm<V>

Parameters:

layoutModel - the model to hold vertex positions

Returns:

the roots vertices of the tree

calculateWidth

protected int calculateWidth(LayoutModel<V> layoutModel,
                             Collection<V> roots,
                             Set<V> seen)

Calculate the width of the entire forest

Overrides:

calculateWidth in class TreeLayoutAlgorithm<V>

Parameters:

layoutModel - the source of the graph and its vertices

roots - the root vertices of the forest

seen - a set of vertices that were already placed

Returns:

calculateOverallHeight

protected int calculateOverallHeight(LayoutModel<V> layoutModel,
                                     Collection<V> roots,
                                     int overallWidth)

Calculate the overall height of the entire forest

Parameters:

layoutModel - the source of the graph and its vertices

roots - the roots of the trees in the forest

overallWidth - the previously measured overall width of the forest

Returns:

the overall height

constrained

public boolean constrained()

Specified by:

constrained in interface LayoutAlgorithm<V>

Overrides:

constrained in class TreeLayoutAlgorithm<V>