y.layout.grouping
Interface GroupingKeys

All Known Implementing Classes:

Grouping

public interface GroupingKeys

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

There are two groups of DataProvider keys. DataProviders 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 DataProviders that add layout information to group nodes such as the insets and the minimum size respectively.

See Also:

Grouping

Field Summary

static java.lang.Object	GROUP_DPKEY A DataProvider key for distinguishing normal nodes from group nodes.
static java.lang.Object	GROUP_NODE_INSETS_DPKEY A DataProvider key for assigning insets for group nodes.
static java.lang.Object	MINIMUM_NODE_SIZE_DPKEY A DataProvider key for assigning minimum sizes for group nodes.
static java.lang.Object	NODE_ID_DPKEY A DataProvider key for assigning a unique ID for each node.
static java.lang.Object	PARENT_NODE_ID_DPKEY A DataProvider key for describing the hierarchy of nodes in the graph.

Field Detail

NODE_ID_DPKEY

static final java.lang.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

static final java.lang.Object PARENT_NODE_ID_DPKEY

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

See Also:

NODE_ID_DPKEY

GROUP_DPKEY

static final java.lang.Object GROUP_DPKEY

A DataProvider key for distinguishing normal nodes from group nodes.

GROUP_NODE_INSETS_DPKEY

static final java.lang.Object 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

static final java.lang.Object 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.