com.yworks.yfiles.layout

Class LabelLayoutKeys

java.lang.Object

com.yworks.yfiles.layout.LabelLayoutKeys

public final class LabelLayoutKeys
extends Object

LabelLayoutKeys are used for associating IDataProviders that contain label-specific information for edge and node labels.

Label-aware layout algorithms like HierarchicLayout may look for such IDataProviders that contain LabelLayoutData for each edge.

Instead of setting up LabelLayoutData and IDataProviders one can also use LabelLayoutTranslator to automatically translate information provided by the standard label layout classes IEdgeLabelLayout and INodeLabelLayout to layout data accessible through the keys defined below.

Field Summary

Fields

Modifier and Type	Field and Description
static EdgeDpKey<LabelLayoutData>	EDGE_LABEL_LAYOUT_DPKEY A DataProvider key for accessing label information of each edge in the input graph
static ILabelLayoutDpKey<Boolean>	IGNORED_LABELS_DPKEY A DataProvider key for marking labels that should be ignored by the layout algorithm A label is ignored if there is a IDataProvider registered with this key which returns true for the given ILabelLayout.
static NodeDpKey<LabelLayoutData>	NODE_LABEL_LAYOUT_DPKEY A DataProvider key for accessing label information of each node in the input graph

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

EDGE_LABEL_LAYOUT_DPKEY

public static final EdgeDpKey<LabelLayoutData> EDGE_LABEL_LAYOUT_DPKEY

A DataProvider key for accessing label information of each edge in the input graph

IGNORED_LABELS_DPKEY

public static final ILabelLayoutDpKey<Boolean> IGNORED_LABELS_DPKEY

A DataProvider key for marking labels that should be ignored by the layout algorithm

A label is ignored if there is a IDataProvider registered with this key which returns true for the given ILabelLayout.

The LabelLayoutTranslator only translates labels that should not be ignored.

NODE_LABEL_LAYOUT_DPKEY

public static final NodeDpKey<LabelLayoutData> NODE_LABEL_LAYOUT_DPKEY

A DataProvider key for accessing label information of each node in the input graph