com.yworks.yfiles.layout.labeling

Class LabelingData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.labeling.LabelingData

public class LabelingData
extends LayoutData

Specifies custom data for the GenericLabeling.

Constructor Summary

Constructors

Constructor and Description
LabelingData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
AbortHandler	getAbortHandler() Gets the AbortHandler used during the layout.
DpKeyItemCollection<ILabel>	getAffectedLabels() Gets the collection of labels that shall be placed by the algorithm.
ItemMapping<ILabel,IEdgeLabelLayoutModel>	getEdgeLabelModels() Gets the mapping from edge labels to an IEdgeLabelLayoutModel used by the labeling algorithm instead of the original label model.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
ItemMapping<ILabel,INodeLabelLayoutModel>	getNodeLabelModels() Gets the mapping from node labels to an INodeLabelLayoutModel used by the labeling algorithm instead of the original label model.
ItemMapping<IEdge,Object>	getSourceGroupIds() Gets a mapping from edges to an object representing their source edge group.
ItemMapping<IEdge,Object>	getTargetGroupIds() Gets a mapping from edges to an object representing their target edge group.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setAffectedLabels(DpKeyItemCollection<ILabel> value) Sets the collection of labels that shall be placed by the algorithm.
void	setEdgeLabelModels(ItemMapping<ILabel,IEdgeLabelLayoutModel> value) Sets the mapping from edge labels to an IEdgeLabelLayoutModel used by the labeling algorithm instead of the original label model.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.
void	setNodeLabelModels(ItemMapping<ILabel,INodeLabelLayoutModel> value) Sets the mapping from node labels to an INodeLabelLayoutModel used by the labeling algorithm instead of the original label model.
void	setSourceGroupIds(ItemMapping<IEdge,Object> value) Sets a mapping from edges to an object representing their source edge group.
void	setTargetGroupIds(ItemMapping<IEdge,Object> value) Sets a mapping from edges to an object representing their target edge group.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelingData

public LabelingData()

Method Detail

apply

public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)

Description copied from class: LayoutData

Applies this layout data to the specified layoutGraphAdapter.

Specified by:

apply in class LayoutData

Parameters:

adapter - The adapter to add the layout data to.

layout - The layout that shall use this layout data.

layoutGraph - The layout graph used for the layout calculation.

getAbortHandler

public final AbortHandler getAbortHandler()

Gets the AbortHandler used during the layout.

Returns:

The AbortHandler.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)

getAffectedLabels

public final DpKeyItemCollection<ILabel> getAffectedLabels()

Gets the collection of labels that shall be placed by the algorithm.

Note that the DpKey has to be set to the key assigned to AffectedLabelsDpKey.

Returns:

The AffectedLabels.

See Also:

AbstractLabeling.getAffectedLabelsDpKey(), setAffectedLabels(DpKeyItemCollection)

getEdgeLabelModels

public final ItemMapping<ILabel,IEdgeLabelLayoutModel> getEdgeLabelModels()

Gets the mapping from edge labels to an IEdgeLabelLayoutModel used by the labeling algorithm instead of the original label model.

If a label has no mapping, the original model is used as normal.

Returns:

The EdgeLabelModels.

See Also:

AbstractLabeling.LABEL_MODEL_DPKEY, setEdgeLabelModels(ItemMapping)

getNodeHalos

public final ItemMapping<INode,NodeHalo> getNodeHalos()

Gets the mapping from nodes to their NodeHalo.

Returns:

The NodeHalos.

See Also:

NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)

getNodeLabelModels

public final ItemMapping<ILabel,INodeLabelLayoutModel> getNodeLabelModels()

Gets the mapping from node labels to an INodeLabelLayoutModel used by the labeling algorithm instead of the original label model.

If a label has no mapping, the original model is used as normal.

Returns:

The NodeLabelModels.

See Also:

AbstractLabeling.LABEL_MODEL_DPKEY, setNodeLabelModels(ItemMapping)

getSourceGroupIds

public final ItemMapping<IEdge,Object> getSourceGroupIds()

Gets a mapping from edges to an object representing their source edge group.

Returns:

The SourceGroupIds.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, setSourceGroupIds(ItemMapping)

getTargetGroupIds

public final ItemMapping<IEdge,Object> getTargetGroupIds()

Gets a mapping from edges to an object representing their target edge group.

Returns:

The TargetGroupIds.

See Also:

PortConstraintKeys.TARGET_GROUP_ID_DPKEY, setTargetGroupIds(ItemMapping)

setAbortHandler

public final void setAbortHandler(AbortHandler value)

Sets the AbortHandler used during the layout.

Parameters:

value - The AbortHandler to set.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()

setAffectedLabels

public final void setAffectedLabels(DpKeyItemCollection<ILabel> value)

Sets the collection of labels that shall be placed by the algorithm.

Note that the DpKey has to be set to the key assigned to AffectedLabelsDpKey.

Parameters:

value - The AffectedLabels to set.

See Also:

AbstractLabeling.getAffectedLabelsDpKey(), getAffectedLabels()

setEdgeLabelModels

public final void setEdgeLabelModels(ItemMapping<ILabel,IEdgeLabelLayoutModel> value)

Sets the mapping from edge labels to an IEdgeLabelLayoutModel used by the labeling algorithm instead of the original label model.

If a label has no mapping, the original model is used as normal.

Parameters:

value - The EdgeLabelModels to set.

See Also:

AbstractLabeling.LABEL_MODEL_DPKEY, getEdgeLabelModels()

setNodeHalos

public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)

Sets the mapping from nodes to their NodeHalo.

Parameters:

value - The NodeHalos to set.

See Also:

NodeHalo.NODE_HALO_DPKEY, getNodeHalos()

setNodeLabelModels

public final void setNodeLabelModels(ItemMapping<ILabel,INodeLabelLayoutModel> value)

Sets the mapping from node labels to an INodeLabelLayoutModel used by the labeling algorithm instead of the original label model.

If a label has no mapping, the original model is used as normal.

Parameters:

value - The NodeLabelModels to set.

See Also:

AbstractLabeling.LABEL_MODEL_DPKEY, getNodeLabelModels()

setSourceGroupIds

public final void setSourceGroupIds(ItemMapping<IEdge,Object> value)

Sets a mapping from edges to an object representing their source edge group.

Parameters:

value - The SourceGroupIds to set.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, getSourceGroupIds()

setTargetGroupIds

public final void setTargetGroupIds(ItemMapping<IEdge,Object> value)

Sets a mapping from edges to an object representing their target edge group.

Parameters:

value - The TargetGroupIds to set.

See Also:

PortConstraintKeys.TARGET_GROUP_ID_DPKEY, getTargetGroupIds()