com.yworks.yfiles.layout.tree

Class GridNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractRotatableNodePlacer

com.yworks.yfiles.layout.tree.GridNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer

public class GridNodePlacer
extends AbstractRotatableNodePlacer

The GridNodePlacer arranges the shapes of the children of a local root in a grid.

Layout Style

The grid consists of a number of rows. The subtrees are assigned to the rows using a IDataProvider that is registered with the graph with ROW_INDEX_DPKEY.

Child nodes placed in a grid using three rows and four columns

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<Integer>	ROW_INDEX_DPKEY A DataProvider key for assigning nodes to the rows in the grid If no IDataProvider is registered with this key, all nodes will be placed in the same row.

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

createdChildren, graph, nodeShapeProvider, subtreeShapeProvider

Constructor Summary

Constructors

Constructor and Description
GridNodePlacer() Creates a new GridNodePlacer with default settings.
GridNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix) Creates a new GridNodePlacer instance whose direction is specified by the given modification matrix.
GridNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix, AbstractRotatableNodePlacer.RootAlignment rootAlignment) Creates a new GridNodePlacer instance with the given modification matrix and root alignment.

Method Summary

Modifier and Type	Method and Description
Comparator<Object>	createFromSketchComparator() Creates a Comparator that sorts the outgoing edges according to the rows and x-coordinates of their target nodes.
protected ParentConnectorDirection	determineChildConnector(Node child) Returns ParentConnectorDirection.NORTH for every given child node.
AbstractRotatableNodePlacer.RootAlignment	getRootAlignment() Gets the RootAlginment that defines how the root node is aligned with its children and their shapes.
protected RotatedSubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Places the children of a local root node in a grid.
void	setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value) Sets the RootAlginment that defines how the root node is aligned with its children and their shapes.

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

createComparator, 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

Field Detail

ROW_INDEX_DPKEY

public static final NodeDpKey<Integer> ROW_INDEX_DPKEY

A DataProvider key for assigning nodes to the rows in the grid

If no IDataProvider is registered with this key, all nodes will be placed in the same row.

Constructor Detail

GridNodePlacer

public GridNodePlacer()

Creates a new GridNodePlacer with default settings.

GridNodePlacer

public GridNodePlacer(AbstractRotatableNodePlacer.Matrix modificationMatrix)

Creates a new GridNodePlacer instance whose direction is specified by the given modification matrix.

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

GridNodePlacer

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

Creates a new GridNodePlacer instance with the given modification matrix and root alignment.

Parameters:

modificationMatrix - the transformation matrix for this AbstractRotatableNodePlacer

rootAlignment - the alignment of the local root with its subtrees

Method Detail

createFromSketchComparator

public Comparator<Object> createFromSketchComparator()

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

Edges that connect to nodes in different rows are ordered by the row index. If two edges connect to the same row, they are sorted by the x-coordinates of their target nodes.

Specified by:

createFromSketchComparator in interface IFromSketchNodePlacer

Overrides:

createFromSketchComparator in class AbstractRotatableNodePlacer

Returns:

a Comparator that orders edges lexicographically by row and x-coordinates of their target nodes

See Also:

ROW_INDEX_DPKEY

determineChildConnector

protected ParentConnectorDirection determineChildConnector(Node child)

Returns ParentConnectorDirection.NORTH for every given child node.

Edges always connect to the top of the child nodes.

Specified by:

determineChildConnector in class AbstractRotatableNodePlacer

Parameters:

child - the child node

Returns:

ParentConnectorDirection.NORTH

getRootAlignment

public AbstractRotatableNodePlacer.RootAlignment getRootAlignment()

Gets the RootAlginment that defines how the root node is aligned with its children and their shapes.

Default Value:

The default value is AbstractRotatableNodePlacer.RootAlignment.CENTER

Returns:

AbstractRotatableNodePlacer.RootAlignment instance specifying the location relative to the subtrees

See Also:

setRootAlignment(AbstractRotatableNodePlacer.RootAlignment)

placeSubtree

protected RotatedSubtreeShape placeSubtree(Node localRoot,
                                           ParentConnectorDirection parentConnectorDirection)

Places the children of a local root node in a grid.

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

setRootAlignment

public void setRootAlignment(AbstractRotatableNodePlacer.RootAlignment value)

Sets the RootAlginment 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 - AbstractRotatableNodePlacer.RootAlignment instance specifying the location relative to the subtrees

See Also:

getRootAlignment()