com.yworks.yfiles.layout.tree

Class DelegatingNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

com.yworks.yfiles.layout.tree.DelegatingNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class DelegatingNodePlacer
extends AbstractRotatableNodePlacer

DelegatingNodePlacer delegates the arrangement of the children to two different INodePlacers.

Layout Style

This INodePlacer can, for example, be used for creating mind maps or a playing schedule of a sports competition.

There are two subtrees that are placed above and below the root; Both subtrees consist of two subtrees that are placed left and right of their local root

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>	PRIMARY_NODES_DPKEY A DataProvider key for dividing the children into two sets If there is no IDataProvider registered with this key, half of the nodes are placed left of the root and the remaining nodes are placed right of the root.

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

createdChildren, graph, nodeShapeProvider, subtreeShapeProvider

Constructor Summary

Constructors

Constructor and Description
DelegatingNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix, INodePlacer placerUpperLeft, INodePlacer placerLowerRight) Creates a new DefaultNodePlacer instance with default settings using the given modification matrix and the given node placers as delegates.

Method Summary

Modifier and Type	Method and Description
IProcessor	createProcessor(TreeLayout layouter, LayoutGraph graph, Node currentRoot) Creates a IProcessor that partitions child nodes of the current root node into two subsets.
protected ParentConnectorDirection	determineChildConnector(Node child) Determines a connector direction for the given child node.
void	determineChildConnectors(Node localRoot, IDataMap connectorMap) Does nothing.
INodePlacer	getPrimaryPlacer() Gets the INodePlacer instance that will arrange the upper-left part of the graph.
INodePlacer	getSecondaryPlacer() Gets the INodePlacer instance that will arrange the lower-right part of the graph.
TreeLayout.SubtreeShape	placeSubtree(IDataProvider nodeShapeProvider, IDataProvider subtreeShapeProvider, LayoutGraph graph, Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the TreeLayout.SubtreeShapes of the child nodes using the two delegate node placers retrieved with PrimaryPlacer and SecondaryPlacer.
protected RotatedSubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Arranges the local root relative to the subtree shape of its children.
protected NodeList	primaryChildren(Node localRoot, LayoutGraph graph) Returns all upper-left children of the local root node.
protected NodeList	secondaryChildren(Node localRoot, LayoutGraph graph) Returns all lower-right children of the local root node.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_NODES_DPKEY

public static final NodeDpKey<Boolean> PRIMARY_NODES_DPKEY

A DataProvider key for dividing the children into two sets

If there is no IDataProvider registered with this key, half of the nodes are placed left of the root and the remaining nodes are placed right of the root.

Constructor Detail

DelegatingNodePlacer

public DelegatingNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix,
                            INodePlacer placerUpperLeft,
                            INodePlacer placerLowerRight)

Creates a new DefaultNodePlacer instance with default settings using the given modification matrix and the given node placers as delegates.

Parameters:

modificationMatrix - the transformation matrix

placerUpperLeft - the first delegate INodePlacer which places the left subtrees

placerLowerRight - the second delegate INodePlacer which places the right subtrees

See Also:

PRIMARY_NODES_DPKEY

Method Detail

createProcessor

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

Creates a IProcessor that partitions child nodes of the current root node into two subsets.

In a pre-processing step the child nodes are divided into an upper-left and a lower-right subset. The first set is arranged using the first delegate, the second set is arranged using the second delegate. To be able to delegate to different INodePlacers this IProcessor adds dummy nodes to which it assigns the according INodePlacers.

The changes to the graph are restored in the post-processing step.

Specified by:

createProcessor in interface INodePlacer

Overrides:

createProcessor in class AbstractRotatableNodePlacer

Parameters:

layouter - the current TreeLayout instance

graph - the input graph

currentRoot - the root node handled by this INodePlacer

Returns:

null

See Also:

getSecondaryPlacer(), getPrimaryPlacer()

determineChildConnector

protected ParentConnectorDirection determineChildConnector(Node child)

Determines a connector direction for the given child node.

Specified by:

determineChildConnector in class AbstractRotatableNodePlacer

Throws:

IllegalStateException - if this method is called

This method should not be called! Since the direction of the connectors is not used by determineChildConnectors(Node, IDataMap), it does not call this method.

Parameters:

child - the child node

Returns:

a direction specifier as defined in the INodePlacer interface

determineChildConnectors

public void determineChildConnectors(Node localRoot,
                                     IDataMap connectorMap)

Does nothing.

Since the DelegatingNodePlacer always places one part of the tree on one side and the remaining tree on the opposite side, it doesn't need to calculate the directions of the connectors.

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:

AbstractRotatableNodePlacer.determineChildConnector(Node)

getPrimaryPlacer

public INodePlacer getPrimaryPlacer()

Gets the INodePlacer instance that will arrange the upper-left part of the graph.

Returns:

the upper-left INodePlacer

See Also:

getSecondaryPlacer(), primaryChildren(Node, LayoutGraph)

getSecondaryPlacer

public INodePlacer getSecondaryPlacer()

Gets the INodePlacer instance that will arrange the lower-right part of the graph.

Returns:

the lower-right INodePlacer

See Also:

getPrimaryPlacer(), secondaryChildren(Node, LayoutGraph)

placeSubtree

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

Places the TreeLayout.SubtreeShapes of the child nodes using the two delegate node placers retrieved with PrimaryPlacer and SecondaryPlacer.

Specified by:

placeSubtree in interface INodePlacer

Overrides:

placeSubtree in class AbstractRotatableNodePlacer

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 merged TreeLayout.SubtreeShape for the subtree rooted at the local root node

See Also:

AbstractRotatableNodePlacer.placeSubtree(Node, ParentConnectorDirection)

placeSubtree

protected RotatedSubtreeShape placeSubtree(Node localRoot,
                                           ParentConnectorDirection parentConnectorDirection)

Arranges the local root relative to the subtree shape of its children.

Specified by:

placeSubtree in class AbstractRotatableNodePlacer

Throws:

IllegalStateException - if this method is called

This method should not be called! Placing subtrees is delegated to the upper-left and the lower-right node placer placeSubtree(IDataProvider, IDataProvider, LayoutGraph, Node, ParentConnectorDirection).

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

primaryChildren

protected NodeList primaryChildren(Node localRoot,
                                   LayoutGraph graph)

Returns all upper-left children of the local root node.

Which children belong to this list is determined using the IDataProvider registered with PRIMARY_NODES_DPKEY. If no such IDataProvider is registered, the first half of the children is returned.

These children are placed using the INodePlacer returned by PrimaryPlacer.

Parameters:

localRoot - the local root node

graph - the input graph

Returns:

the list of upper-left child Nodes

See Also:

PRIMARY_NODES_DPKEY

secondaryChildren

protected NodeList secondaryChildren(Node localRoot,
                                     LayoutGraph graph)

Returns all lower-right children of the local root node.

Which children belong to this list is determined using the IDataProvider registered with PRIMARY_NODES_DPKEY. If no such IDataProvider is registered, the second half of the children is returned.

These children are placed using the INodePlacer returned by SecondaryPlacer.

Parameters:

localRoot - the local root node

graph - the input graph

Returns:

the list of lower-right child Nodes

See Also:

PRIMARY_NODES_DPKEY