com.yworks.yfiles.layout.tree

Class SimpleNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

com.yworks.yfiles.layout.tree.SimpleNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class SimpleNodePlacer
extends AbstractRotatableNodePlacer

The SimpleNodePlacer arranges all children of a local root in a single row.

Layout Style

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
SimpleNodePlacer() Creates a new SimpleNodePlacer instance with default settings.
SimpleNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix) Creates a new SimpleNodePlacer instance that uses the given modification matrix.
SimpleNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix, AbstractRotatableNodePlacer.RootAlignment rootAlignment) Creates a new SimpleNodePlacer instance that uses the given modification matrix and root alignment.

Method Summary

Modifier and Type	Method and Description
protected ParentConnectorDirection	determineChildConnector(Node child) Provides ParentConnectorDirection.NORTH as connector direction for the child nodes.
AbstractRotatableNodePlacer.RootAlignment	getRootAlignment() Gets the RootAlignment that defines how the root node is aligned with its children and their shapes.
double	getVerticalAlignment() Gets the relative vertical alignment of nodes with the same parent.
boolean	isBusCreationEnabled() Gets whether or not a bus is created in the space between the parent and its children.
protected RotatedSubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the children of the local root node in a single row.
void	setBusCreationEnabled(boolean value) Sets whether or not a bus is created in the space between the parent and its children.
void	setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value) Sets the RootAlignment that defines how the root node is aligned with its children and their shapes.
void	setVerticalAlignment(double value) Sets the relative vertical alignment of nodes with the same parent.

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

SimpleNodePlacer

public SimpleNodePlacer()

Creates a new SimpleNodePlacer instance with default settings.

SimpleNodePlacer

public SimpleNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix)

Creates a new SimpleNodePlacer instance that uses the given modification matrix.

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

SimpleNodePlacer

public SimpleNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix,
                        AbstractRotatableNodePlacer.RootAlignment rootAlignment)

Creates a new SimpleNodePlacer instance that uses the given modification matrix and root alignment.

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

rootAlignment - the alignment for the local root in relation to its subtrees

Method Detail

determineChildConnector

protected ParentConnectorDirection determineChildConnector(Node child)

Provides ParentConnectorDirection.NORTH as connector direction for the child nodes.

Specified by:

determineChildConnector in class AbstractRotatableNodePlacer

Parameters:

child - the child node

Returns:

ParentConnectorDirection.NORTH

getRootAlignment

public AbstractRotatableNodePlacer.RootAlignment getRootAlignment()

Gets the RootAlignment 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)

getVerticalAlignment

public double getVerticalAlignment()

Gets the relative vertical alignment of nodes with the same parent.

All values between 0 and 1 result in a valid alignment.

• 0 - nodes are top-aligned
• 0.5 - nodes are center-aligned
• 1 - nodes are bottom-aligned

Values outside the interval [0,1] may result in a more compact node placement with unaligned nodes, especially when labels are considered.

Default Value:

The default value is -1. Nodes are not aligned.

Returns:

the relative vertical alignment of nodes that have the same parent node

See Also:

setVerticalAlignment(double)

isBusCreationEnabled

public boolean isBusCreationEnabled()

Gets whether or not a bus is created in the space between the parent and its children.

Default Value:

The default value is false. The edges leave the local root on the left or right side.

Returns:

true if the bus is created, false otherwise

See Also:

setBusCreationEnabled(boolean)

placeSubtree

protected RotatedSubtreeShape placeSubtree(Node localRoot,
                                           ParentConnectorDirection parentConnectorDirection)

Places the children of the local root node in a single row.

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 containing the local root node and all its children

setBusCreationEnabled

public void setBusCreationEnabled(boolean value)

Sets whether or not a bus is created in the space between the parent and its children.

Default Value:

The default value is false. The edges leave the local root on the left or right side.

Parameters:

value - true if the bus is created, false otherwise

See Also:

isBusCreationEnabled()

setRootAlignment

public void setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value)

Sets the RootAlignment 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()

setVerticalAlignment

public void setVerticalAlignment(double value)

Sets the relative vertical alignment of nodes with the same parent.

All values between 0 and 1 result in a valid alignment.

• 0 - nodes are top-aligned
• 0.5 - nodes are center-aligned
• 1 - nodes are bottom-aligned

Values outside the interval [0,1] may result in a more compact node placement with unaligned nodes, especially when labels are considered.

Default Value:

The default value is -1. Nodes are not aligned.

Parameters:

value - the relative vertical alignment of nodes that have the same parent node

See Also:

getVerticalAlignment()