com.yworks.yfiles.layout.tree

Class GroupedNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.GroupedNodePlacer

All Implemented Interfaces:

INodePlacer

public class GroupedNodePlacer
extends Object
implements INodePlacer

This INodePlacer places the children of a local root in groups.

The groups are determined by the grouping of the edges that connect the children to its root. The placement of the groups is specified by a INodePlacer which will consider grouped children as one child. The children within a group are placed by another INodePlacer.

There are three edge groups whose target nodes are placed above each other

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

Constructor Summary

Constructors

Constructor and Description
GroupedNodePlacer(INodePlacer groupPlacer, INodePlacer childPlacer) Creates a new GroupedNodePlacer instance.

Method Summary

Modifier and Type	Method and Description
IProcessor	createProcessor(TreeLayout layouter, LayoutGraph graph, Node currentRoot) Creates a IProcessor that prepares the graph for edge grouping.
void	determineChildConnectors(Node localRoot, IDataMap connectorMap) Delegates to the INodePlacer responsible for arranging the nodes in one group.
TreeLayout.SubtreeShape	placeSubtree(IDataProvider nodeShapeProvider, IDataProvider subtreeShapeProvider, LayoutGraph graph, Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the groups of TreeLayout.SubtreeShapes according to their group IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupedNodePlacer

public GroupedNodePlacer(INodePlacer groupPlacer,
                         INodePlacer childPlacer)

Creates a new GroupedNodePlacer instance.

Parameters:

groupPlacer - the INodePlacer which places the child groups

childPlacer - the INodePlacer which places the children within their group

Method Detail

createProcessor

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

Creates a IProcessor that prepares the graph for edge grouping.

In a pre-processing step, the IProcessor inserts a dummy node for each edge group and connects it to the local root and the edges of the according group. The child node placer is assigned to those dummy nodes and will arrange them during the layout calculation.

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

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:

the IProcessor responsible for preparing the graph

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

determineChildConnectors

public void determineChildConnectors(Node localRoot,
                                     IDataMap connectorMap)

Delegates to the INodePlacer responsible for arranging the nodes in one group.

Specified by:

determineChildConnectors in interface INodePlacer

Parameters:

localRoot - the local root node

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

placeSubtree

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

Places the groups of TreeLayout.SubtreeShapes according to their group IDs.

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 merged TreeLayout.SubtreeShapes of the local root and its children

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY