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. These keys define the parent-child relationship of nodes within the hierarchy and tag nodes that act as group nodes.

Field Summary

static Object	GROUP_DPKEY This key is used to distinguish normal nodes from group nodes.
static Object	GROUP_NODE_INSETS_DPKEY This key is used to provide insets for group nodes.
static Object	NODE_ID_DPKEY This key is used to register a DataProvider instance with a graph, that associates each node instance with a unique (based on hashCode() and equals()) id.
static Object	PARENT_NODE_ID_DPKEY This key is used to actually describe the hierarchy of the nodes in the graph.

Field Detail

NODE_ID_DPKEY

public static final Object NODE_ID_DPKEY

This key is used to register a DataProvider instance with a graph, that associates each node instance with a unique (based on hashCode() and equals()) id.

PARENT_NODE_ID_DPKEY

public static final Object PARENT_NODE_ID_DPKEY

This key is used to actually describe the hierarchy of the nodes in the graph. For each node that is not at the top level of the hierarchy, the id of the containing node can be obtained through the dataprovider associated with this key.

GROUP_DPKEY

public static final Object GROUP_DPKEY

This key is used to distinguish normal nodes from group nodes. For every node the DataProvider should return true iff the node is a group node (and therefor might have children.

GROUP_NODE_INSETS_DPKEY

public static final Object GROUP_NODE_INSETS_DPKEY

This key is used to provide insets for group nodes. Insets are used to provide space around the contents of a group node. This space can then be used for labels and other visual decorations. For each group node, a Insets object can be provided using a dataprovider bound to the graph using this key.