com.yworks.yfiles.layout.tree

Class DoubleLineNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

com.yworks.yfiles.layout.tree.DoubleLineNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class DoubleLineNodePlacer
extends AbstractRotatableNodePlacer

The DoubleLineNodePlacer arranges the children of a local root alternating in two lines.

Layout Style

This INodePlacer arranges nodes from top to bottom. It places the subtrees in two horizontal lines below the root. They are distributed in an alternating fashion, i.e., adjacent subtrees are in different lines.

This node placer is especially useful for leaves with a large width.

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
DoubleLineNodePlacer() Creates a new DoubleLineNodePlacer instance with the default settings.
DoubleLineNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix) Creates a new DoubleLineNodePlacer instance whose direction is specified by the given modification matrix.

Method Summary

Modifier and Type	Method and Description
protected ParentConnectorDirection	determineChildConnector(Node child) Returns ParentConnectorDirection.NORTH for every given child node.
double	getDoubleLineSpacingRatio() Gets the ratio of the spacing between the root and the children in the upper line and the spacing between the two lines of subtrees.
AbstractRotatableNodePlacer.RootAlignment	getRootAlignment() Gets the RootAlginment that defines how the root node is aligned with its children and their shapes.
protected RotatedSubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the children of the given local root alternating in two horizontal lines.
void	setDoubleLineSpacingRatio(double value) Sets the ratio of the spacing between the root and the children in the upper line and the spacing between the two lines of subtrees.
void	setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value) Sets the RootAlginment that defines how the root node is aligned with its children and their shapes.

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

createComparator, createFromSketchComparator, createProcessor, 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

DoubleLineNodePlacer

public DoubleLineNodePlacer()

Creates a new DoubleLineNodePlacer instance with the default settings.

DoubleLineNodePlacer

public DoubleLineNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix)

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

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

Method Detail

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

getDoubleLineSpacingRatio

public double getDoubleLineSpacingRatio()

Gets the ratio of the spacing between the root and the children in the upper line and the spacing between the two lines of subtrees.

Negative ratios will lead to node overlaps.

Default Value:

The default value is 0.33. The distance between the two lines of subtrees is a third of the distance between the root and the upper line.

Returns:

the ratio to determine the spacing between the two lines of subtrees

See Also:

setDoubleLineSpacingRatio(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)

placeSubtree

protected RotatedSubtreeShape placeSubtree(Node localRoot,
                                           ParentConnectorDirection parentConnectorDirection)

Places the children of the given local root alternating in two horizontal lines.

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

setDoubleLineSpacingRatio

public void setDoubleLineSpacingRatio(double value)

Sets the ratio of the spacing between the root and the children in the upper line and the spacing between the two lines of subtrees.

Negative ratios will lead to node overlaps.

Default Value:

The default value is 0.33. The distance between the two lines of subtrees is a third of the distance between the root and the upper line.

Parameters:

value - the ratio to determine the spacing between the two lines of subtrees

See Also:

getDoubleLineSpacingRatio()

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()