com.yworks.yfiles.layout

Class GroupingKeys

java.lang.Object

com.yworks.yfiles.layout.GroupingKeys

public final class GroupingKeys
extends Object

This interface defines IDataProvider keys for those layout algorithms that can handle hierarchically grouped graphs.

There are two groups of IDataProvider keys. IDataProviders registered with NODE_ID_DPKEY, GROUP_DPKEY and PARENT_NODE_ID_DPKEY define the relationship of nodes within the hierarchy. A parent node is defined for each node in the graph. This parent is the containing group node. For top-level nodes, this parent is null.

GROUP_NODE_INSETS_DPKEY and MINIMUM_NODE_SIZE_DPKEY are used for registering IDataProviders that add layout information to group nodes such as the insets and the minimum size respectively.

See Also:

GroupingSupport

Field Summary

Fields

Modifier and Type	Field and Description
static NodeDpKey<Boolean>	GROUP_DPKEY A DataProvider key for distinguishing normal nodes from group nodes.
static NodeDpKey<YInsets>	GROUP_NODE_INSETS_DPKEY A DataProvider key for assigning insets for group nodes.
static NodeDpKey<YDimension>	MINIMUM_NODE_SIZE_DPKEY A DataProvider key for assigning minimum sizes for group nodes.
static NodeDpKey<Object>	NODE_ID_DPKEY A DataProvider key for assigning a unique ID for each node.
static NodeDpKey<Object>	PARENT_NODE_ID_DPKEY A DataProvider key for describing the hierarchy of nodes in the graph.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_DPKEY

public static final NodeDpKey<Boolean> GROUP_DPKEY

A DataProvider key for distinguishing normal nodes from group nodes.

GROUP_NODE_INSETS_DPKEY

public static final NodeDpKey<YInsets> GROUP_NODE_INSETS_DPKEY

A DataProvider key for assigning insets for group nodes.

Insets reserve space around the contents of a group node. Labels and other visual decorations may be placed inside this space.

MINIMUM_NODE_SIZE_DPKEY

public static final NodeDpKey<YDimension> MINIMUM_NODE_SIZE_DPKEY

A DataProvider key for assigning minimum sizes for group nodes.

Most common layout algorithms ignore the minimum size for an empty group node, i.e., a node that is marked as group but has no children assigned to it.

NODE_ID_DPKEY

public static final NodeDpKey<Object> NODE_ID_DPKEY

A DataProvider key for assigning a unique ID for each node.

The IDs of the nodes need to differ based on Object.hashCode() and Object.equals(Object).

PARENT_NODE_ID_DPKEY

public static final NodeDpKey<Object> PARENT_NODE_ID_DPKEY

A DataProvider key for describing the hierarchy of nodes in the graph.

See Also:

NODE_ID_DPKEY