public class LayeredLayoutBuilder
extends java.lang.Object
Constructor and Description |
---|
LayeredLayoutBuilder()
Initializes a new instance of the LayeredLayoutBuilder class.
|
LayeredLayoutBuilder(LayeredLayout instance)
Initializes a new instance of the LayeredLayoutBuilder class.
|
Modifier and Type | Method and Description |
---|---|
LayeredLayoutBuilder |
anchoring(Anchoring value)
Sets how to align links to the anchor points of nodes.
|
LayeredLayout |
create()
Creates a new object with the attributes accumulated by this builder.
|
LayeredLayoutBuilder |
direction(Direction value)
Sets a value indicating in what direction the links in the arranged diagram should go.
|
LayeredLayoutBuilder |
enableCustomLayers(boolean value)
Sets a value indicating whether to indicating whether
the layered layout will honor the LayeredLayoutTraits.Layer flags.
|
LayeredLayoutBuilder |
endNode(DiagramNode value)
Sets the node that should be placed in the last layer of the arranged graph.
|
LayeredLayoutBuilder |
enforceLinkFlow(boolean value)
Sets a value indicating whether to attempt to force all links to go in
the same direction.
|
LayeredLayout |
get()
Returns an existing object passed for initialization to this builder.
|
LayeredLayoutBuilder |
growToFit(boolean value)
Sets a value indicating whether the layout should increase
the diagram bounds to fit the arranged content.
|
LayeredLayoutBuilder |
ignoreNodeSize(boolean value)
Sets a value indicating whether the distance between
adjacent nodes in the final layout should be independent of
the nodes' size.
|
LayeredLayoutBuilder |
keepGroupLayout(boolean value)
Sets a value specifying whether the relative position of nodes
within groups should be kept intact.
|
LayeredLayoutBuilder |
layerDistance(float value)
Sets the desired distance between adjacent layers.
|
LayeredLayoutBuilder |
layoutLink(LayoutLink value)
Sets an object, which is notified when the
position of a link is changed by the layout.
|
LayeredLayoutBuilder |
layoutNode(LayoutNode value)
Sets an object, which is notified when the
position of a node is changed by the layout.
|
LayeredLayoutBuilder |
linksCompactFactor(float value)
Sets a value indicating how much to compact the outermost links.
|
LayeredLayoutBuilder |
linkType(LayeredLayoutLinkType value)
Sets the appearance of the links in the final layout.
|
LayeredLayoutBuilder |
margins(XDimension2D.Double value)
Sets the distance between the top-left corner
of the smallest rectangle containing the arranged diagram
and the top-left point of the document bounds.
|
LayeredLayoutBuilder |
multipleGraphsPlacement(MultipleGraphsPlacement value)
Sets a value indicating how multiple independent graphs
in the diagram should be positioned relatively to each other.
|
LayeredLayoutBuilder |
nodeDistance(float value)
Sets the desired distance between adjacent nodes on the same layer.
|
LayeredLayoutBuilder |
orientation(com.mindfusion.common.Orientation value)
Sets a value indicating what the overall orientation of the arranged
diagram should be.
|
LayeredLayoutBuilder |
progress(LayoutProgress value)
Sets the progress callback delegate.
|
LayeredLayoutBuilder |
splitLayers(boolean value)
Sets a value indicating whether layers that are much wider than
the other layers should be split.
|
LayeredLayoutBuilder |
startNode(DiagramNode value)
Sets the node that should be placed in the first layer of the arranged graph.
|
LayeredLayoutBuilder |
straightenLongLinks(boolean value)
Sets whether the layout algorithm should strive to straighten links that cross more than one layer of the graph.
|
LayeredLayoutBuilder |
timeLimit(long value)
Sets a time-out value for the path-finding part of
the layered layout algorithm.
|
LayeredLayoutBuilder |
xGap(float value)
Sets a value indicating how much horizontal space should be left
between the document boundaries and the graph.
|
LayeredLayoutBuilder |
yGap(float value)
Sets a value indicating how much vertical space should be left
between the document boundaries and the graph.
|
public LayeredLayoutBuilder()
public LayeredLayoutBuilder(LayeredLayout instance)
public LayeredLayoutBuilder xGap(float value)
value
- A float value specifying the horizontal offset from the
left document border.public LayeredLayoutBuilder yGap(float value)
value
- A float value specifying the vertical offset from the
top document border.public LayeredLayoutBuilder anchoring(Anchoring value)
public LayeredLayoutBuilder direction(Direction value)
value
- A member of the Direction
enumeration.public LayeredLayoutBuilder enableCustomLayers(boolean value)
public LayeredLayoutBuilder endNode(DiagramNode value)
start node
is specified too.value
- A DiagramNode
object representing the end node.public LayeredLayoutBuilder enforceLinkFlow(boolean value)
public LayeredLayoutBuilder growToFit(boolean value)
public LayeredLayoutBuilder ignoreNodeSize(boolean value)
public LayeredLayoutBuilder keepGroupLayout(boolean value)
value
- true
if the relative position of nodes within
groups should be preserved, otherwise false
.public LayeredLayoutBuilder layerDistance(float value)
value
- A float value specifying the distance between adjacent layers.public LayeredLayoutBuilder layoutLink(LayoutLink value)
public LayeredLayoutBuilder layoutNode(LayoutNode value)
public LayeredLayoutBuilder linkType(LayeredLayoutLinkType value)
value
- A member of the LayeredLayoutLinkType
enumeration.public LayeredLayoutBuilder linksCompactFactor(float value)
value
- A float multiplier applied to the distance
between outermost links.public LayeredLayoutBuilder margins(XDimension2D.Double value)
public LayeredLayoutBuilder multipleGraphsPlacement(MultipleGraphsPlacement value)
public LayeredLayoutBuilder nodeDistance(float value)
value
- A float value specifying the distance between adjacent nodes.public LayeredLayoutBuilder orientation(com.mindfusion.common.Orientation value)
value
- One of the Orientation
constants.public LayeredLayoutBuilder progress(LayoutProgress value)
public LayeredLayoutBuilder splitLayers(boolean value)
value
- true
if long layers should be split,
otherwise false
.public LayeredLayoutBuilder startNode(DiagramNode value)
value
- A DiagramNode
object representing the start node.public LayeredLayoutBuilder straightenLongLinks(boolean value)
value
- true to straighten long links; otherwise false. The default value is false.public LayeredLayoutBuilder timeLimit(long value)
value
- An integer value specifying the maximum time in milliseconds
the path-finding algorithm can run.public LayeredLayout create()
public LayeredLayout get()