com.yworks.yfiles.layout.tree

Class LeftRightNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

com.yworks.yfiles.layout.tree.LeftRightNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class LeftRightNodePlacer
extends AbstractRotatableNodePlacer

The LeftRightNodePlacer arranges the children in a subtree on the left and the right of a vertical bus.

Layout Style

Nested Class Summary

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

AbstractRotatableNodePlacer.Matrix, AbstractRotatableNodePlacer.RootAlignment

Field Summary

Fields

Modifier and Type	Field and Description
static NodeDpKey<Boolean>	LEFT_RIGHT_DPKEY A DataProvider key for assigning nodes to the left or the right side of the bus If no IDataProvider is specified using this key, the nodes will be placed alternating from left to right.

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

createdChildren, graph, nodeShapeProvider, subtreeShapeProvider

Constructor Summary

Constructors

Constructor and Description
LeftRightNodePlacer() Creates a new LeftRightNodePlacer instance with default settings.
LeftRightNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix) Creates a new LeftRightNodePlacer instance using the given modification matrix.

Method Summary

Modifier and Type	Method and Description
Comparator<Object>	createComparator() Returns a Comparator for outgoing edges that considers the locations of the target nodes.
static IDataProvider	createLeftRightDataProvider(IDataProvider nodePlacerMap) Creates a special IDataProvider that determines whether a given node is placed left or right of the parent node.
protected ParentConnectorDirection	determineChildConnector(Node child) Determines a connector direction for the given child node.
void	determineChildConnectors(Node localRoot, IDataMap connectorMap) Determines the direction of the child connectors according to which side of the bus the child is assigned.
double	getHorizontalDistance() Gets the horizontal distance between nodes or subtrees.
double	getVerticalDistance() Gets the vertical distance between nodes or subtrees.
boolean	isLastOnBottomPlacementEnabled() Gets whether or not the last child is placed centered, aligned with the bus and below the other child nodes.
protected RotatedSubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the subtree shapes of the children left and right of a common vertical bus.
void	setHorizontalDistance(double value) Sets the horizontal distance between nodes or subtrees.
void	setLastOnBottomPlacementEnabled(boolean value) Sets whether or not the last child is placed centered, aligned with the bus and below the other child nodes.
void	setSpacing(double value) Sets a uniform horizontal and vertical spacing between subtrees.
void	setVerticalDistance(double value) Sets the vertical distance between nodes or subtrees.

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

createFromSketchComparator, createProcessor, getModificationMatrix, getNodeShape, getPortConstraint, getSourcePointAbs, getSpacing, getSubtreeShape, placeSubtree, translateDirectionToModel, translateDirectionToReal, translatePoint

Methods inherited from class java.lang.Object

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

Field Detail

LEFT_RIGHT_DPKEY

public static final NodeDpKey<Boolean> LEFT_RIGHT_DPKEY

A DataProvider key for assigning nodes to the left or the right side of the bus

If no IDataProvider is specified using this key, the nodes will be placed alternating from left to right.

Constructor Detail

LeftRightNodePlacer

public LeftRightNodePlacer()

Creates a new LeftRightNodePlacer instance with default settings.

LeftRightNodePlacer

public LeftRightNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix)

Creates a new LeftRightNodePlacer instance using the given modification matrix.

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

Method Detail

createComparator

public Comparator<Object> createComparator()

Returns a Comparator for outgoing edges that considers the locations of the target nodes.

The Comparator applies the modification matrix of this LeftRightNodePlacer and then compares the y-coordinates of the target nodes.

Overrides:

createComparator in class AbstractRotatableNodePlacer

Returns:

the Comparator that compares outgoing edges according to the locations of their target nodes

createLeftRightDataProvider

public static final IDataProvider createLeftRightDataProvider(IDataProvider nodePlacerMap)

Creates a special IDataProvider that determines whether a given node is placed left or right of the parent node.

This IDataProvider can be registered with the graph with key LEFT_RIGHT_DPKEY. It calculates the side with respect to the initial coordinates of the nodes in the graph, considering the orientation of the subtree.

If a node is assigned to the left side, this IDataProvider will return true. For the right side, it will return false.

LeftRightDataProvider provides a convenient way to determine the side of a node from the initial graph.

Since the side of a node depends on the rotation of the associated INodePlacer, LeftRightDataProvider demands a IDataProvider containing the INodePlacer instances that are used for the layout calculation.

Parameters:

nodePlacerMap - a IDataProvider containing the corresponding INodePlacers for the node

determineChildConnector

protected ParentConnectorDirection determineChildConnector(Node child)

Determines a connector direction for the given child node.

Since the connector directions are already determined by determineChildConnectors(Node, IDataMap), this method doesn't need to be called.

Specified by:

determineChildConnector in class AbstractRotatableNodePlacer

Throws:

IllegalStateException - if this method is called

Parameters:

child - the child node

Returns:

a direction specifier as defined in the INodePlacer interface

determineChildConnectors

public void determineChildConnectors(Node localRoot,
                                     IDataMap connectorMap)

Determines the direction of the child connectors according to which side of the bus the child is assigned.

Children on the left will get a connector to the ParentConnectorDirection.EAST. Children on the right will get one to the ParentConnectorDirection.WEST. A connector to the ParentConnectorDirection.NORTH is assigned for the bottom child.

Specified by:

determineChildConnectors in interface INodePlacer

Overrides:

determineChildConnectors in class AbstractRotatableNodePlacer

Parameters:

localRoot - the local root node

connectorMap - the map that must be used for storing the direction specifiers of the child nodes

See Also:

setLastOnBottomPlacementEnabled(boolean)

getHorizontalDistance

public double getHorizontalDistance()

Gets the horizontal distance between nodes or subtrees.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 20.

Returns:

the non-negative horizontal distance

See Also:

setHorizontalDistance(double)

getVerticalDistance

public double getVerticalDistance()

Gets the vertical distance between nodes or subtrees.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 20.

Returns:

the non-negative vertical distance

See Also:

setVerticalDistance(double)

isLastOnBottomPlacementEnabled

public boolean isLastOnBottomPlacementEnabled()

Gets whether or not the last child is placed centered, aligned with the bus and below the other child nodes.

When enabled, the last child will always be centered independent of the number of siblings.

Default Value:

The default value is true. The last child is centered below its siblings

Returns:

true if the last child is separated, false otherwise

See Also:

setLastOnBottomPlacementEnabled(boolean)

placeSubtree

protected RotatedSubtreeShape placeSubtree(Node localRoot,
                                           ParentConnectorDirection parentConnectorDirection)

Places the subtree shapes of the children left and right of a common vertical bus.

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

setHorizontalDistance

public void setHorizontalDistance(double value)

Sets the horizontal distance between nodes or subtrees.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 20.

Parameters:

value - the non-negative horizontal distance

See Also:

getHorizontalDistance()

setLastOnBottomPlacementEnabled

public void setLastOnBottomPlacementEnabled(boolean value)

Sets whether or not the last child is placed centered, aligned with the bus and below the other child nodes.

When enabled, the last child will always be centered independent of the number of siblings.

Default Value:

The default value is true. The last child is centered below its siblings

Parameters:

value - true if the last child is separated, false otherwise

See Also:

isLastOnBottomPlacementEnabled()

setSpacing

public void setSpacing(double value)

Sets a uniform horizontal and vertical spacing between subtrees.

This method sets the given distance value for the horizontal spacing and for the vertical spacing.

Overrides:

setSpacing in class AbstractRotatableNodePlacer

Throws:

IllegalArgumentException - if the specified spacing value is negative

Parameters:

value - The Spacing to set.

See Also:

setHorizontalDistance(double), setVerticalDistance(double)

setVerticalDistance

public void setVerticalDistance(double value)

Sets the vertical distance between nodes or subtrees.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 20.

Parameters:

value - the non-negative vertical distance

See Also:

getVerticalDistance()