com.yworks.yfiles.layout

Class LayoutKeys

java.lang.Object

com.yworks.yfiles.layout.LayoutKeys

public final class LayoutKeys
extends Object

Helper class that provides unique identifiers for some general purpose data providers.

Field Summary

Fields

Modifier and Type	Field and Description
static EdgeDpKey<Boolean>	AFFECTED_EDGES_DPKEY A DataProvider key for looking up the selected state of the edges in the graph A layout algorithm can retrieve a IDataProvider registered with this key to apply a special handling to the selected edges.
static NodeDpKey<Boolean>	AFFECTED_NODES_DPKEY A DataProvider key for looking up the selected state of the nodes in the graph A layout algorithm can retrieve a IDataProvider registered with this key to apply a special handling to the selected nodes.
static EdgeDpKey<Object>	EDGE_ID_DPKEY A DataProvider key for looking up a unique identifier for each edge in a graph Layout algorithms may use this information to provide consistent layouts for multiple runs.
static NodeDpKey<Object>	NODE_ID_DPKEY A DataProvider key for looking up a unique identifier for each node in a graph Layout algorithms may use this information to provide consistent layouts for multiple runs.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

AFFECTED_EDGES_DPKEY

public static final EdgeDpKey<Boolean> AFFECTED_EDGES_DPKEY

A DataProvider key for looking up the selected state of the edges in the graph

A layout algorithm can retrieve a IDataProvider registered with this key to apply a special handling to the selected edges. For example, the layout algorithm may restrict its scope, i.e., it only routes the selected edges.

However, it is often more convenient to use a specific IDataProvider key for this purpose, e.g., if you want to combine two layout algorithms of the same kind which have to operate on different subsets of the graph. Thus, these algorithms may provide a method like setSubgraphEdgesDpKey(Object) that customizes the IDataProvider key allowing to specify different sets of selected edges for nested layout algorithms.

AFFECTED_NODES_DPKEY

public static final NodeDpKey<Boolean> AFFECTED_NODES_DPKEY

A DataProvider key for looking up the selected state of the nodes in the graph

A layout algorithm can retrieve a IDataProvider registered with this key to apply a special handling to the selected nodes. For example, the layout algorithm may restrict its scope, i.e., it only arranges the selected nodes.

However, it is often more convenient to use a specific IDataProvider key for this purpose, e.g., if you want to combine two layout algorithms of the same kind which have to operate on different subsets of the graph. Thus, these algorithms may provide a method like setSubgraphNodesDpKey(Object) that customizes the IDataProvider key allowing to specify different sets of selected nodes for nested layout algorithms.

EDGE_ID_DPKEY

public static final EdgeDpKey<Object> EDGE_ID_DPKEY

A DataProvider key for looking up a unique identifier for each edge in a graph

Layout algorithms may use this information to provide consistent layouts for multiple runs.

NODE_ID_DPKEY

public static final NodeDpKey<Object> NODE_ID_DPKEY

A DataProvider key for looking up a unique identifier for each node in a graph

Layout algorithms may use this information to provide consistent layouts for multiple runs.