public class TreeLayoutBuilder
extends java.lang.Object
Constructor and Description |
---|
TreeLayoutBuilder()
Initializes a new instance of the TreeLayoutBuilder class.
|
TreeLayoutBuilder(TreeLayout instance)
Initializes a new instance of the TreeLayoutBuilder class.
|
Modifier and Type | Method and Description |
---|---|
TreeLayoutBuilder |
anchoring(Anchoring value)
Sets a value indicating how links should be aligned to the anchor points of tree nodes.
|
TreeLayoutBuilder |
balance(TreeLayoutBalance value)
Sets a value indicating the ordering of the child
nodes in order to produce layouts with custom balance.
|
TreeLayoutBuilder |
compactAssistants(boolean value)
Sets a value indicating whether the "assistant" nodes on the
same side of a single parent are arranged as close enough to each other
as possible.
|
TreeLayout |
create()
Creates a new object with the attributes accumulated by this builder.
|
TreeLayoutBuilder |
direction(TreeLayoutDirection value)
Sets a value indicating in what direction child nodes
should be placed relatively to their parent nodes.
|
TreeLayoutBuilder |
enableAssistants(boolean value)
Sets a value indicating whether the "assistant" trait
is regarded when performing the layout.
|
TreeLayout |
get()
Returns an existing object passed for initialization to this builder.
|
TreeLayoutBuilder |
ignoreLinkDirection(boolean value)
Sets a value indicating whether the direction of links should be ignored.
|
TreeLayoutBuilder |
keepGroupLayout(boolean value)
Sets a value indicating whether groups of diagram nodes should be
treated as integral nodes in the tree that will be laid out.
|
TreeLayoutBuilder |
keepRootPosition(boolean value)
Sets a value indicating whether the root node should be kept
at its original position.
|
TreeLayoutBuilder |
levelDistance(float value)
Sets the desired distance between tree levels.
|
TreeLayoutBuilder |
linkStyle(TreeLayoutLinkType value)
Sets what style should be assigned to the links processed by the
layout algorithm.
|
TreeLayoutBuilder |
nodeDistance(float value)
Sets the desired distance between nodes on the same level.
|
TreeLayoutBuilder |
reversedLinks(boolean value)
Sets a value indicating which direction of links should be
considered the parent-to-child one.
|
TreeLayoutBuilder |
root(DiagramNode value)
Sets the object which will be used as root of the tree.
|
TreeLayoutBuilder |
stretchFactor(float value)
Sets a value defining the elliptic factor used with radial layouts.
|
TreeLayoutBuilder |
type(TreeLayoutType value)
Sets the layout mode.
|
TreeLayoutBuilder |
xGap(float value)
Sets a value indicating how much horizontal space to leave between
the document boundaries and the tree.
|
TreeLayoutBuilder |
yGap(float value)
Sets a value indicating how much vertical space to leave between
the document boundaries and the tree.
|
public TreeLayoutBuilder()
public TreeLayoutBuilder(TreeLayout instance)
public TreeLayoutBuilder xGap(float value)
value
- A float value specifying the horizontal offset from the
left document border.public TreeLayoutBuilder yGap(float value)
value
- A float value specifying the vertical offset from the
top document border.public TreeLayoutBuilder anchoring(Anchoring value)
value
- A member of the Anchoring
enumeration.public TreeLayoutBuilder balance(TreeLayoutBalance value)
value
- A member of the TreeLayoutBalance
enumeration.public TreeLayoutBuilder compactAssistants(boolean value)
public TreeLayoutBuilder direction(TreeLayoutDirection value)
value
- A member of the TreeLayoutDirection
enumeration.public TreeLayoutBuilder enableAssistants(boolean value)
public TreeLayoutBuilder ignoreLinkDirection(boolean value)
value
- true
if the direction of links should be
ignored when arranging a tree, otherwise false
.public TreeLayoutBuilder keepGroupLayout(boolean value)
value
- true
if the relative position of nodes within
groups should be preserved, otherwise false
.public TreeLayoutBuilder keepRootPosition(boolean value)
value
- true
if the root position should be
preserved, otherwise false
.public TreeLayoutBuilder levelDistance(float value)
value
- A float value specifying the distance between tree levels.public TreeLayoutBuilder linkStyle(TreeLayoutLinkType value)
value
- A member of the TreeLayoutLinkType
enumeration.public TreeLayoutBuilder nodeDistance(float value)
value
- A float value specifying the distance between sibling nodes.public TreeLayoutBuilder reversedLinks(boolean value)
value
- true
if the parent-to-child direction in the tree
is considered to be the one from links destination nodes to
links origin nodes, otherwise false
.public TreeLayoutBuilder root(DiagramNode value)
value
- A DiagramNode
-derived object representing the tree root node.public TreeLayoutBuilder stretchFactor(float value)
value
- A float multiplier that is applied to the horizontal distance
between nodes in a radial layout.public TreeLayoutBuilder type(TreeLayoutType value)
value
- A member of the TreeLayoutType
enumeration.public TreeLayout create()
public TreeLayout get()