com.yworks.yfiles.layout

Class LabelLayoutTranslator

java.lang.Object

com.yworks.yfiles.layout.LabelLayoutTranslator

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class LabelLayoutTranslator
extends Object
implements ILayoutStage

LabelLayoutTranslator automatically translates label layout information provided by the standard label layout classes IEdgeLabelLayout and INodeLabelLayout to layout data of type LabelLayoutData that is accessible by the keys defined in class LabelLayoutKeys.

One can use this ILayoutStage as label layout algorithm of a label-aware layout algorithm like HierarchicLayout. This can be done by assigning the stage by an appropriate call to setLabelLayouter.

When writing the LabelLayoutData, the boxes are set relative. In case of a node label, the box's anchor is relative to the center of the owning node. In case of an edge label the box's anchor is relative to the center of the source node of the owning edge.

If writing back node labels and/or writing back edge labels is enabled, the LabelLayoutData is transferred back to the INodeLabelLayouts and/or IEdgeLabelLayouts.

By default, the boxes are now interpreted absolute but by activating WritingBackRelativeNodeLabelLocationEnabled and/or WritingBackRelativeEdgeLabelLocationEnabled this can be changed to interpret them relative as explained above.

Note that care must be taken on the choice of the label model that is used by the classes IEdgeLabelLayout and INodeLabelLayout. The calculated label positions must be consistent with the label positions allowed by the label model. The best label layout results are achieved by choosing FreeEdgeLabelLayoutModel for edge layouts and FreeNodeLabelLayoutModel for node layouts.

Constructor Summary

Constructors

Constructor and Description
LabelLayoutTranslator() Creates a new LabelLayoutTranslator instance with default settings.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Translates traditional ILabelLayout information to IDataProvider-based LabelLayoutData.
ILayoutAlgorithm	getCoreLayout() Gets the core layout algorithm that is wrapped by this ILayoutStage.
boolean	isAutoFlippingEnabled() Gets whether or not this stage should automatically flip edge label content depending on the label's rotation angle.
boolean	isEdgeLabelOrientationResetEnabled() Gets whether or not to reset the orientation of edge labels.
boolean	isEdgeLabelTranslationEnabled() Gets whether or not edge label information is translated.
boolean	isNodeLabelOrientationResetEnabled() Gets whether or not to reset the orientation of node labels.
boolean	isNodeLabelTranslationEnabled() Gets whether or not node label information is translated.
boolean	isWritingBackEdgeLabelsEnabled() Gets whether or not edge label information is written back to the model after core layout.
boolean	isWritingBackNodeLabelsEnabled() Gets whether or not node label information is written back to the model after the core layout.
boolean	isWritingBackRelativeEdgeLabelLocationEnabled() Gets whether or not edge label boxes are interpreted relative to the edge when writing them back to the model.
boolean	isWritingBackRelativeNodeLabelLocationEnabled() Gets whether or not node label bounds are interpreted relative to the node when writing them back to the model.
void	setAutoFlippingEnabled(boolean value) Sets whether or not this stage should automatically flip edge label content depending on the label's rotation angle.
void	setCoreLayout(ILayoutAlgorithm value) Sets the core layout algorithm that is wrapped by this ILayoutStage.
void	setEdgeLabelOrientationResetEnabled(boolean value) Sets whether or not to reset the orientation of edge labels.
void	setEdgeLabelTranslationEnabled(boolean value) Sets whether or not edge label information is translated.
void	setNodeLabelOrientationResetEnabled(boolean value) Sets whether or not to reset the orientation of node labels.
void	setNodeLabelTranslationEnabled(boolean value) Sets whether or not node label information is translated.
void	setWritingBackEdgeLabelsEnabled(boolean value) Sets whether or not edge label information is written back to the model after core layout.
void	setWritingBackNodeLabelsEnabled(boolean value) Sets whether or not node label information is written back to the model after the core layout.
void	setWritingBackRelativeEdgeLabelLocationEnabled(boolean value) Sets whether or not edge label boxes are interpreted relative to the edge when writing them back to the model.
void	setWritingBackRelativeNodeLabelLocationEnabled(boolean value) Sets whether or not node label bounds are interpreted relative to the node when writing them back to the model.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelLayoutTranslator

public LabelLayoutTranslator()

Creates a new LabelLayoutTranslator instance with default settings.

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Translates traditional ILabelLayout information to IDataProvider-based LabelLayoutData.

Afterwards, the calculated layout data will be written back to the original label layout.

Specified by:

applyLayout in interface ILayoutAlgorithm

Parameters:

graph - the input graph

getCoreLayout

public ILayoutAlgorithm getCoreLayout()

Gets the core layout algorithm that is wrapped by this ILayoutStage.

Specified by:

getCoreLayout in interface ILayoutStage

Default Value:

The default value is null.

Returns:

the core layout routine

See Also:

setCoreLayout(ILayoutAlgorithm)

isAutoFlippingEnabled

public boolean isAutoFlippingEnabled()

Gets whether or not this stage should automatically flip edge label content depending on the label's rotation angle.

More precisely, if this option is enabled and the up vector of the YOrientedRectangle associated with an IEdgeLabelLayout points downwards (upY > 0), this ILayoutStage automatically flips the label. It rotates the label by 180 degrees without changing the label's center.

Default Value:

The default value is true. Labels are automatically flipped if they are upside down.

Returns:

true if this ILayoutStage automatically flips edge label content depending on the label's rotation angle, false otherwise

See Also:

LayoutGraphUtilities.autoFlipBox(YOrientedRectangle), ILabelLayout.getOrientedBox(), setAutoFlippingEnabled(boolean)

isEdgeLabelOrientationResetEnabled

public boolean isEdgeLabelOrientationResetEnabled()

Gets whether or not to reset the orientation of edge labels.

If this option is enabled, the up vector of the corresponding oriented box is set to (0,-1) before adding it to the IDataProvider.

If a layout algorithm just considers edge labels, LabelLayoutTranslator should not reset their orientation. When it performs integrated edge labeling, this option should be enabled.

Default Value:

The default value is true. The orientation of edge labels is reset.

Returns:

true if the orientation of edge labels is reset, false otherwise

See Also:

setEdgeLabelOrientationResetEnabled(boolean)

isEdgeLabelTranslationEnabled

public boolean isEdgeLabelTranslationEnabled()

Gets whether or not edge label information is translated.

Default Value:

The default value is false. The label information is not translated for edge labels.

Returns:

true if edge label information is translated, false otherwise

See Also:

setEdgeLabelTranslationEnabled(boolean)

isNodeLabelOrientationResetEnabled

public boolean isNodeLabelOrientationResetEnabled()

Gets whether or not to reset the orientation of node labels.

If this option is enabled, the up vector of the corresponding oriented box is set to (0,-1) before adding it to the IDataProvider.

If a layout algorithm just considers node labels, LabelLayoutTranslator should not reset their orientation. When it performs integrated node labeling, this option should be enabled.

Default Value:

The default value is false. The orientation of node labels is kept.

Returns:

true if the orientation of node labels is reset, false otherwise

See Also:

setNodeLabelOrientationResetEnabled(boolean)

isNodeLabelTranslationEnabled

public boolean isNodeLabelTranslationEnabled()

Gets whether or not node label information is translated.

Default Value:

The default value is false. The label information is not translated for node labels.

Returns:

true if node label information is translated, false otherwise

See Also:

setNodeLabelTranslationEnabled(boolean)

isWritingBackEdgeLabelsEnabled

public boolean isWritingBackEdgeLabelsEnabled()

Gets whether or not edge label information is written back to the model after core layout.

This option should only be enabled if the core layout algorithm performs integrated edge labeling.

Default Value:

The default value is true. Edge label information is transferred back to the label model.

Returns:

true if edge label information is written back, false otherwise

See Also:

setWritingBackEdgeLabelsEnabled(boolean)

isWritingBackNodeLabelsEnabled

public boolean isWritingBackNodeLabelsEnabled()

Gets whether or not node label information is written back to the model after the core layout.

This option should only be enabled if the core layout algorithm performs integrated node labeling.

Default Value:

The default value is true. Node label information is transferred back to the label model.

Returns:

true if node label information is written back, false otherwise

See Also:

setWritingBackNodeLabelsEnabled(boolean)

isWritingBackRelativeEdgeLabelLocationEnabled

public boolean isWritingBackRelativeEdgeLabelLocationEnabled()

Gets whether or not edge label boxes are interpreted relative to the edge when writing them back to the model.

This option is only considered if WritingBackEdgeLabelsEnabled is enabled.

Default Value:

The default value is false. Edge label boxes are interpreted absolute.

Returns:

true if the bounds are interpreted relative, false for absolute interpretation

See Also:

setWritingBackRelativeEdgeLabelLocationEnabled(boolean)

isWritingBackRelativeNodeLabelLocationEnabled

public boolean isWritingBackRelativeNodeLabelLocationEnabled()

Gets whether or not node label bounds are interpreted relative to the node when writing them back to the model.

This option is only considered if WritingBackNodeLabelsEnabled is enabled.

Default Value:

The default value is false. Node label boxes are interpreted absolute.

Returns:

true if the bounds are interpreted relative, false for absolute interpretation

See Also:

setWritingBackRelativeNodeLabelLocationEnabled(boolean)

setAutoFlippingEnabled

public void setAutoFlippingEnabled(boolean value)

Sets whether or not this stage should automatically flip edge label content depending on the label's rotation angle.

More precisely, if this option is enabled and the up vector of the YOrientedRectangle associated with an IEdgeLabelLayout points downwards (upY > 0), this ILayoutStage automatically flips the label. It rotates the label by 180 degrees without changing the label's center.

Default Value:

The default value is true. Labels are automatically flipped if they are upside down.

Parameters:

value - true if this ILayoutStage automatically flips edge label content depending on the label's rotation angle, false otherwise

See Also:

LayoutGraphUtilities.autoFlipBox(YOrientedRectangle), ILabelLayout.getOrientedBox(), isAutoFlippingEnabled()

setCoreLayout

public void setCoreLayout(ILayoutAlgorithm value)

Sets the core layout algorithm that is wrapped by this ILayoutStage.

Specified by:

setCoreLayout in interface ILayoutStage

Default Value:

The default value is null.

Parameters:

value - the core layout routine

See Also:

getCoreLayout()

setEdgeLabelOrientationResetEnabled

public void setEdgeLabelOrientationResetEnabled(boolean value)

Sets whether or not to reset the orientation of edge labels.

If this option is enabled, the up vector of the corresponding oriented box is set to (0,-1) before adding it to the IDataProvider.

If a layout algorithm just considers edge labels, LabelLayoutTranslator should not reset their orientation. When it performs integrated edge labeling, this option should be enabled.

Default Value:

The default value is true. The orientation of edge labels is reset.

Parameters:

value - true if the orientation of edge labels is reset, false otherwise

See Also:

isEdgeLabelOrientationResetEnabled()

setEdgeLabelTranslationEnabled

public void setEdgeLabelTranslationEnabled(boolean value)

Sets whether or not edge label information is translated.

Default Value:

The default value is false. The label information is not translated for edge labels.

Parameters:

value - true if edge label information is translated, false otherwise

See Also:

isEdgeLabelTranslationEnabled()

setNodeLabelOrientationResetEnabled

public void setNodeLabelOrientationResetEnabled(boolean value)

Sets whether or not to reset the orientation of node labels.

If this option is enabled, the up vector of the corresponding oriented box is set to (0,-1) before adding it to the IDataProvider.

If a layout algorithm just considers node labels, LabelLayoutTranslator should not reset their orientation. When it performs integrated node labeling, this option should be enabled.

Default Value:

The default value is false. The orientation of node labels is kept.

Parameters:

value - true if the orientation of node labels is reset, false otherwise

See Also:

isNodeLabelOrientationResetEnabled()

setNodeLabelTranslationEnabled

public void setNodeLabelTranslationEnabled(boolean value)

Sets whether or not node label information is translated.

Default Value:

The default value is false. The label information is not translated for node labels.

Parameters:

value - true if node label information is translated, false otherwise

See Also:

isNodeLabelTranslationEnabled()

setWritingBackEdgeLabelsEnabled

public void setWritingBackEdgeLabelsEnabled(boolean value)

Sets whether or not edge label information is written back to the model after core layout.

This option should only be enabled if the core layout algorithm performs integrated edge labeling.

Default Value:

The default value is true. Edge label information is transferred back to the label model.

Parameters:

value - true if edge label information is written back, false otherwise

See Also:

isWritingBackEdgeLabelsEnabled()

setWritingBackNodeLabelsEnabled

public void setWritingBackNodeLabelsEnabled(boolean value)

Sets whether or not node label information is written back to the model after the core layout.

This option should only be enabled if the core layout algorithm performs integrated node labeling.

Default Value:

The default value is true. Node label information is transferred back to the label model.

Parameters:

value - true if node label information is written back, false otherwise

See Also:

isWritingBackNodeLabelsEnabled()

setWritingBackRelativeEdgeLabelLocationEnabled

public void setWritingBackRelativeEdgeLabelLocationEnabled(boolean value)

Sets whether or not edge label boxes are interpreted relative to the edge when writing them back to the model.

This option is only considered if WritingBackEdgeLabelsEnabled is enabled.

Default Value:

The default value is false. Edge label boxes are interpreted absolute.

Parameters:

value - true if the bounds are interpreted relative, false for absolute interpretation

See Also:

isWritingBackRelativeEdgeLabelLocationEnabled()

setWritingBackRelativeNodeLabelLocationEnabled

public void setWritingBackRelativeNodeLabelLocationEnabled(boolean value)

Sets whether or not node label bounds are interpreted relative to the node when writing them back to the model.

This option is only considered if WritingBackNodeLabelsEnabled is enabled.

Default Value:

The default value is false. Node label boxes are interpreted absolute.

Parameters:

value - true if the bounds are interpreted relative, false for absolute interpretation

See Also:

isWritingBackRelativeNodeLabelLocationEnabled()