com.yworks.yfiles.layout.tree

Class DendrogramNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.DendrogramNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class DendrogramNodePlacer
extends Object
implements IFromSketchNodePlacer

The DendrogramNodePlacer arranges subtrees as dendrograms.

Layout Style

This INodePlacer arranges nodes from top to bottom. It arranges subtrees in such a way that all subtrees of a single local root are aligned with their bottom border.

Note: This implementation does not support PortConstraints.

Constructor Summary

Constructors

Constructor and Description
DendrogramNodePlacer() Creates a new DendrogramNodePlacer instance with default settings.

Method Summary

Modifier and Type	Method and Description
Comparator<Object>	createComparator() Creates a Comparator that sorts outgoing edges according to the x-coordinate of their target nodes.
Comparator<Object>	createFromSketchComparator() Creates a Comparator for the edges which takes the initial x-coordinates of the nodes into account.
IProcessor	createProcessor(TreeLayout layouter, LayoutGraph graph, Node currentRoot) Creates an optional IProcessor for pre- and post-processing.
void	determineChildConnectors(Node localRoot, IDataMap connectorMap) Provides ParentConnectorDirection.NORTH for all children.
double	getMinimumRootDistance() Gets the minimum distance between the TreeLayout.SubtreeShape of a root node and the bus connecting to all of its children.
double	getMinimumSubtreeDistance() Gets the minimum horizontal distance between adjacent SubtreeShapes.
TreeLayout.SubtreeShape	placeSubtree(IDataProvider nodeShapeProvider, IDataProvider subtreeShapeProvider, LayoutGraph graph, Node localRoot, ParentConnectorDirection parentConnectorDirection) Arranges the SubtreeShapes of the local root and its children as a dendrogram.
void	setMinimumRootDistance(double value) Sets the minimum distance between the TreeLayout.SubtreeShape of a root node and the bus connecting to all of its children.
void	setMinimumSubtreeDistance(double value) Sets the minimum horizontal distance between adjacent SubtreeShapes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DendrogramNodePlacer

public DendrogramNodePlacer()

Creates a new DendrogramNodePlacer instance with default settings.

Method Detail

createComparator

public Comparator<Object> createComparator()

Creates a Comparator that sorts outgoing edges according to the x-coordinate of their target nodes.

This Comparator can be used for achieving a From Sketch layout.

Returns:

the Comparator

See Also:

createFromSketchComparator()

createFromSketchComparator

public Comparator<Object> createFromSketchComparator()

Creates a Comparator for the edges which takes the initial x-coordinates of the nodes into account.

This implementation delegates to createComparator().

Specified by:

createFromSketchComparator in interface IFromSketchNodePlacer

Returns:

the Comparator for the edges

See Also:

createComparator()

createProcessor

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

Creates an optional IProcessor for pre- and post-processing.

This implementation returns null. Hence, no pre- or post-processing is done.

Specified by:

createProcessor in interface INodePlacer

Parameters:

layouter - the current TreeLayout instance

graph - the input graph

currentRoot - the root node handled by this INodePlacer

Returns:

null

determineChildConnectors

public void determineChildConnectors(Node localRoot,
                                     IDataMap connectorMap)

Provides ParentConnectorDirection.NORTH for all children.

Edges will always connect to the top of the child nodes.

Specified by:

determineChildConnectors in interface INodePlacer

Parameters:

localRoot - the local root node

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

getMinimumRootDistance

public double getMinimumRootDistance()

Gets the minimum distance between the TreeLayout.SubtreeShape of a root node and the bus connecting to all of its children.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 30.

Returns:

the minimum distance between the root and the bus

See Also:

setMinimumRootDistance(double)

getMinimumSubtreeDistance

public double getMinimumSubtreeDistance()

Gets the minimum horizontal distance between adjacent SubtreeShapes.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 30.

Returns:

the minimum distance between two adjacent TreeLayout.SubtreeShapes

See Also:

setMinimumSubtreeDistance(double)

placeSubtree

public TreeLayout.SubtreeShape placeSubtree(IDataProvider nodeShapeProvider,
                                            IDataProvider subtreeShapeProvider,
                                            LayoutGraph graph,
                                            Node localRoot,
                                            ParentConnectorDirection parentConnectorDirection)

Arranges the SubtreeShapes of the local root and its children as a dendrogram.

Specified by:

placeSubtree in interface INodePlacer

Parameters:

nodeShapeProvider - the IDataProvider for obtaining an initial shape of the root node

subtreeShapeProvider - the IDataProvider for accessing the pre-calculated shapes of the subtrees

graph - the input graph

localRoot - the root of the subtree that should be arranged by this method

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

Returns:

the combined shape of the whole subtree rooted at the given local root node

setMinimumRootDistance

public void setMinimumRootDistance(double value)

Sets the minimum distance between the TreeLayout.SubtreeShape of a root node and the bus connecting to all of its children.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 30.

Parameters:

value - the minimum distance between the root and the bus

See Also:

getMinimumRootDistance()

setMinimumSubtreeDistance

public void setMinimumSubtreeDistance(double value)

Sets the minimum horizontal distance between adjacent SubtreeShapes.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 30.

Parameters:

value - the minimum distance between two adjacent TreeLayout.SubtreeShapes

See Also:

getMinimumSubtreeDistance()