Package org.jungrapht.visualization.layout.algorithms

Class AbstractTreeLayoutAlgorithm.Builder<V,T extends AbstractTreeLayoutAlgorithm<V>,B extends AbstractTreeLayoutAlgorithm.Builder<V,T,B>>

java.lang.Object

org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm.Builder<V,T,B>

org.jungrapht.visualization.layout.algorithms.AbstractTreeLayoutAlgorithm.Builder<V,T,B>

Type Parameters:

V - the vertex type

T - the type of TreeLayoutAlgorithm that is built

B - the builder type

All Implemented Interfaces:

LayoutAlgorithm.Builder<V,T,B>

Direct Known Subclasses:

TidierTreeLayoutAlgorithm.Builder, TreeLayoutAlgorithm.Builder

Enclosing class:

AbstractTreeLayoutAlgorithm<V>

public abstract static class AbstractTreeLayoutAlgorithm.Builder<V,T extends AbstractTreeLayoutAlgorithm<V>,B extends AbstractTreeLayoutAlgorithm.Builder<V,T,B>>
extends AbstractLayoutAlgorithm.Builder<V,T,B>
implements LayoutAlgorithm.Builder<V,T,B>

A Builder to create instances of AbstractTreeLayoutAlgorithm

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	correctOverlap
protected boolean	expandLayout
protected int	horizontalVertexSpacing
protected Comparator<V>	rootComparator
protected Predicate<V>	rootPredicate
protected Function<V,Rectangle>	vertexBoundsFunction
protected int	verticalVertexSpacing

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

after

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
B	correctOverlap(boolean correctOverlap)
B	expandLayout(boolean expandLayout)
B	horizontalVertexSpacing(int horizontalVertexSpacing)
B	rootComparator(Comparator<V> rootComparator)
B	rootPredicate(Predicate<V> rootPredicate)
protected B	self()
B	vertexBoundsFunction(Function<V,Rectangle> vertexBoundsFunction)	if provided, the horizontal and vertical spacings will be replaced by the average width and height of the vertex Shapes returned by this Function
B	verticalVertexSpacing(int verticalVertexSpacing)

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

after, build

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.LayoutAlgorithm.Builder

build

Field Detail

rootPredicate

protected Predicate<V> rootPredicate

rootComparator

protected Comparator<V> rootComparator

horizontalVertexSpacing

protected int horizontalVertexSpacing

verticalVertexSpacing

protected int verticalVertexSpacing

expandLayout

protected boolean expandLayout

correctOverlap

protected boolean correctOverlap

vertexBoundsFunction

protected Function<V,Rectangle> vertexBoundsFunction

Constructor Detail

Builder

public Builder()

Method Detail

self

protected B self()

Overrides:

self in class AbstractLayoutAlgorithm.Builder<V,T extends AbstractTreeLayoutAlgorithm<V>,B extends AbstractTreeLayoutAlgorithm.Builder<V,T,B>>

Returns:

this builder cast to type B

rootPredicate

public B rootPredicate(Predicate<V> rootPredicate)

Parameters:

rootPredicate - the predicate function to determine root vertices. Default is to consider all vertices with no incoming edges as root vertices

Returns:

this Builder

rootComparator

public B rootComparator(Comparator<V> rootComparator)

Parameters:

rootComparator - used to sort the roots if an order is desired

Returns:

this Builder

horizontalVertexSpacing

public B horizontalVertexSpacing(int horizontalVertexSpacing)

Parameters:

horizontalVertexSpacing - horizontal spacing between tree elements

Returns:

this Builder

verticalVertexSpacing

public B verticalVertexSpacing(int verticalVertexSpacing)

Parameters:

verticalVertexSpacing - vertical spacing between tree elements

Returns:

this Builder

vertexBoundsFunction

public B vertexBoundsFunction(Function<V,Rectangle> vertexBoundsFunction)

if provided, the horizontal and vertical spacings will be replaced by the average width and height of the vertex Shapes returned by this Function

Parameters:

vertexBoundsFunction - source of vertex shapes

Returns:

this builder

expandLayout

public B expandLayout(boolean expandLayout)

Parameters:

expandLayout - if true expand the layout width and height to accomodate the entire tree

Returns:

the Builder

correctOverlap

public B correctOverlap(boolean correctOverlap)

Parameters:

correctOverlap - if true move vertices to correct overlap with non-incident edges.

Returns:

the Builder