com.yworks.yfiles.layout.tree

Class LayeredNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

com.yworks.yfiles.layout.tree.LayeredNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class LayeredNodePlacer
extends AbstractRotatableNodePlacer

A LayeredNodePlacer arranges the nodes of a subtree respecting layers.

Layout Style

Nodes that have the same depth in the tree will be placed in the same horizontal layer. They will be vertically aligned.

Changing the orientation within the LayeredNodePlacer is strongly discouraged because it causes problems with the layering.

Nested Class Summary

Nested classes/interfaces inherited from class com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

AbstractRotatableNodePlacer.Matrix, AbstractRotatableNodePlacer.RootAlignment

Field Summary

Fields inherited from class com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

createdChildren, graph, nodeShapeProvider, subtreeShapeProvider

Constructor Summary

Constructors

Constructor and Description
LayeredNodePlacer() Creates a new LayeredNodePlacer instance with the default settings.
LayeredNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix, Object id) Creates a new LayeredNodePlacer instance whose direction is specified by the given modification matrix.

Method Summary

Modifier and Type	Method and Description
IProcessor	createProcessor(TreeLayout layouter, LayoutGraph graph, Node currentRoot) Creates a IProcessor that distributes the nodes over the layers.
protected ParentConnectorDirection	determineChildConnector(Node child) Returns ParentConnectorDirection.NORTH for every given child node.
double	getBusAlignment() Gets the vertical bus alignment for orthogonally routed edges.
Object	getId() Gets the ID of this LayeredNodePlacer.
double	getLayerSpacing() Gets the distance between two adjacent layers.
AbstractRotatableNodePlacer.RootAlignment	getRootAlignment() Gets the RootAlginment that defines how the root node is aligned with its children and their shapes.
LayeredRoutingStyle	getRoutingStyle() Gets the routing style for the edges in the subtree.
double	getVerticalAlignment() Gets the relative vertical alignment of nodes within their respective layers.
boolean	isDendrogramStyleEnabled() Gets whether or not the layering is done dendrogram-like.
boolean	isPolylineLabeling() Gets whether or not straight edges are extended to avoid label overlaps.
protected RotatedSubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the children of local root in layers.
void	setBusAlignment(double value) Sets the vertical bus alignment for orthogonally routed edges.
void	setDendrogramStyleEnabled(boolean value) Sets whether or not the layering is done dendrogram-like.
void	setLayerSpacing(double value) Sets the distance between two adjacent layers.
void	setPolylineLabeling(boolean value) Sets whether or not straight edges are extended to avoid label overlaps.
void	setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value) Sets the RootAlginment that defines how the root node is aligned with its children and their shapes.
void	setRoutingStyle(LayeredRoutingStyle value) Sets the routing style for the edges in the subtree.
void	setVerticalAlignment(double value) Sets the relative vertical alignment of nodes within their respective layers.

Methods inherited from class com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

createComparator, createFromSketchComparator, determineChildConnectors, getModificationMatrix, getNodeShape, getPortConstraint, getSourcePointAbs, getSpacing, getSubtreeShape, placeSubtree, setSpacing, translateDirectionToModel, translateDirectionToReal, translatePoint

Methods inherited from class java.lang.Object

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

Constructor Detail

LayeredNodePlacer

public LayeredNodePlacer()

Creates a new LayeredNodePlacer instance with the default settings.

LayeredNodePlacer

public LayeredNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix,
                         Object id)

Creates a new LayeredNodePlacer instance whose direction is specified by the given modification matrix.

The given ID identifies different LayeredNodePlacer instances that share the same layer heights.

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

id - the LayeredNodePlacer ID

Method Detail

createProcessor

public IProcessor createProcessor(TreeLayout layouter,
                                  LayoutGraph graph,
                                  Node currentRoot)

Creates a IProcessor that distributes the nodes over the layers.

The IProcessor is chosen depending on the layout style.

Specified by:

createProcessor in interface INodePlacer

Overrides:

createProcessor in class AbstractRotatableNodePlacer

Parameters:

graph - the input graph

currentRoot - the current root node for this node placer

layouter - the current TreeLayout instance

Returns:

the IProcessor or null if the layer information is already assigned to the current root

See Also:

setDendrogramStyleEnabled(boolean)

determineChildConnector

protected ParentConnectorDirection determineChildConnector(Node child)

Returns ParentConnectorDirection.NORTH for every given child node.

Edges always connect to the top of the child nodes.

Specified by:

determineChildConnector in class AbstractRotatableNodePlacer

Parameters:

child - the child node

Returns:

ParentConnectorDirection.NORTH

getBusAlignment

public double getBusAlignment()

Gets the vertical bus alignment for orthogonally routed edges.

The bus alignment determines the relative position of an edge bus in between two subsequent layers of nodes.

Values for a valid vertical alignment are in the range [0..1], such that:

• A value of 0.0 places the bus at the top, right below the parent node.
• A value of 0.5 places the bus in the middle between parent and child nodes.
• A value of 1.0 places the bus at the bottom, right above the child nodes.

Throws:

IllegalArgumentException - if the specified alignment is outside [0..1]

Bus alignment only applies if the routing style is set to LayeredRoutingStyle.ORTHOGONAL.

Default Value:

The default value is 0.3.

Returns:

the relative bus alignment

See Also:

setBusAlignment(double)

getId

public Object getId()

Gets the ID of this LayeredNodePlacer.

The ID is used for identifying LayeredNodePlacers that share information about the layer height. Using different IDs allows aligned layouts within different subtrees.

Returns:

the ID of this node placer

getLayerSpacing

public double getLayerSpacing()

Gets the distance between two adjacent layers.

The spacing needs to be non-negative.

Throws:

IllegalArgumentException - if the specified spacing is negative

Default Value:

The default value is 40.

Returns:

the spacing between two layers

See Also:

setLayerSpacing(double)

getRootAlignment

public AbstractRotatableNodePlacer.RootAlignment getRootAlignment()

Gets the RootAlginment that defines how the root node is aligned with its children and their shapes.

Default Value:

The default value is AbstractRotatableNodePlacer.RootAlignment.CENTER

Returns:

the AbstractRotatableNodePlacer.RootAlignment instance specifying the location relative to the subtrees

See Also:

setRootAlignment(AbstractRotatableNodePlacer.RootAlignment)

getRoutingStyle

public LayeredRoutingStyle getRoutingStyle()

Gets the routing style for the edges in the subtree.

Throws:

IllegalArgumentException - if the specified routing style specifier is unknown

Default Value:

The default value is LayeredRoutingStyle.STRAIGHT

Returns:

one of the predefined edge routing styles

See Also:

setRoutingStyle(LayeredRoutingStyle)

getVerticalAlignment

public double getVerticalAlignment()

Gets the relative vertical alignment of nodes within their respective layers.

A value of 0 means that nodes are top-aligned; a value of 0.5 means that nodes are center-aligned; a value of 1 means that nodes are bottom-aligned;

Values for a valid vertical alignment are in the range [0..1].

Throws:

IllegalArgumentException - if the specified alignment is outside [0..1]

Default Value:

The default value is 0.5. Nodes are center aligned.

Returns:

the vertical alignment of nodes within their layers

See Also:

setVerticalAlignment(double)

isDendrogramStyleEnabled

public boolean isDendrogramStyleEnabled()

Gets whether or not the layering is done dendrogram-like.

When enabled, leaves are placed in the same layer and remaining tree nodes are assigned to a layer as close to their children as possible.

Default Value:

The default value is false. The nodes are assigned to the topmost layer.

Returns:

true if the graph is layered as a dendrogram, false otherwise

See Also:

setDendrogramStyleEnabled(boolean)

isPolylineLabeling

public boolean isPolylineLabeling()

Gets whether or not straight edges are extended to avoid label overlaps.

If enabled, polyline connectors between the parent and its children are added to the according subtree shape. Node or edge labels will not be crossed.

Polyline labeling only has an effect if the routing style is LayeredRoutingStyle.STRAIGHT.

Default Value:

The default value is false. Edges are only routed straight.

Returns:

true if polyline connectors are added, false otherwise

See Also:

setPolylineLabeling(boolean)

placeSubtree

protected RotatedSubtreeShape placeSubtree(Node localRoot,
                                           ParentConnectorDirection parentConnectorDirection)

Places the children of local root in layers.

Specified by:

placeSubtree in class AbstractRotatableNodePlacer

Parameters:

localRoot - the local root node

parentConnectorDirection - the direction specifier for the connector of the local root node to its parent node

Returns:

the merged subtree shape that contains the local root node and all its children

setBusAlignment

public void setBusAlignment(double value)

Sets the vertical bus alignment for orthogonally routed edges.

The bus alignment determines the relative position of an edge bus in between two subsequent layers of nodes.

Values for a valid vertical alignment are in the range [0..1], such that:

• A value of 0.0 places the bus at the top, right below the parent node.
• A value of 0.5 places the bus in the middle between parent and child nodes.
• A value of 1.0 places the bus at the bottom, right above the child nodes.

Throws:

IllegalArgumentException - if the specified alignment is outside [0..1]

Bus alignment only applies if the routing style is set to LayeredRoutingStyle.ORTHOGONAL.

Default Value:

The default value is 0.3.

Parameters:

value - the relative bus alignment

See Also:

getBusAlignment()

setDendrogramStyleEnabled

public void setDendrogramStyleEnabled(boolean value)

Sets whether or not the layering is done dendrogram-like.

When enabled, leaves are placed in the same layer and remaining tree nodes are assigned to a layer as close to their children as possible.

Default Value:

The default value is false. The nodes are assigned to the topmost layer.

Parameters:

value - true if the graph is layered as a dendrogram, false otherwise

See Also:

isDendrogramStyleEnabled()

setLayerSpacing

public void setLayerSpacing(double value)

Sets the distance between two adjacent layers.

The spacing needs to be non-negative.

Throws:

IllegalArgumentException - if the specified spacing is negative

Default Value:

The default value is 40.

Parameters:

value - the spacing between two layers

See Also:

getLayerSpacing()

setPolylineLabeling

public void setPolylineLabeling(boolean value)

Sets whether or not straight edges are extended to avoid label overlaps.

If enabled, polyline connectors between the parent and its children are added to the according subtree shape. Node or edge labels will not be crossed.

Polyline labeling only has an effect if the routing style is LayeredRoutingStyle.STRAIGHT.

Default Value:

The default value is false. Edges are only routed straight.

Parameters:

value - true if polyline connectors are added, false otherwise

See Also:

isPolylineLabeling()

setRootAlignment

public void setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value)

Sets the RootAlginment that defines how the root node is aligned with its children and their shapes.

Default Value:

The default value is AbstractRotatableNodePlacer.RootAlignment.CENTER

Parameters:

value - the AbstractRotatableNodePlacer.RootAlignment instance specifying the location relative to the subtrees

See Also:

getRootAlignment()

setRoutingStyle

public void setRoutingStyle(LayeredRoutingStyle value)

Sets the routing style for the edges in the subtree.

Throws:

IllegalArgumentException - if the specified routing style specifier is unknown

Default Value:

The default value is LayeredRoutingStyle.STRAIGHT

Parameters:

value - one of the predefined edge routing styles

See Also:

getRoutingStyle()

setVerticalAlignment

public void setVerticalAlignment(double value)

Sets the relative vertical alignment of nodes within their respective layers.

A value of 0 means that nodes are top-aligned; a value of 0.5 means that nodes are center-aligned; a value of 1 means that nodes are bottom-aligned;

Values for a valid vertical alignment are in the range [0..1].

Throws:

IllegalArgumentException - if the specified alignment is outside [0..1]

Default Value:

The default value is 0.5. Nodes are center aligned.

Parameters:

value - the vertical alignment of nodes within their layers

See Also:

getVerticalAlignment()