com.yworks.yfiles.layout

Class SliderEdgeLabelLayoutModel

java.lang.Object

com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel

All Implemented Interfaces:

IEdgeLabelLayoutModel

public class SliderEdgeLabelLayoutModel
extends Object
implements IEdgeLabelLayoutModel

SliderEdgeLabelLayoutModel allows placement of labels at a set of continuous rotated positions along both sides of an edge or directly on the edge path.

It is possible to specify distance values that control the distance between label and edge and between label and nodes.

SliderMode.CENTER mode on the left, SliderMode.SIDE mode in the middle and SliderMode.SINGLE_SIDE on the right

Constructor Summary

Constructors

Constructor and Description
SliderEdgeLabelLayoutModel(SliderMode mode) Creates a new instance of SliderEdgeLabelLayoutModel with the given mode.

Method Summary

Modifier and Type	Method and Description
Object	createModelParameter(YOrientedRectangle labelBounds, IEdgeLayout edgeLayout, INodeLayout sourceNode, INodeLayout targetNode) Creates a model parameter that represents the given edge label position within this model.
double	getAngle() Gets the angle (measured in radians) of the label model.
Object	getDefaultParameter() Gets a model parameter that encodes the default position of this model's allowed edge label positions.
double	getDistance() Gets the distance between the label's box and the edge's path.
YList	getLabelCandidates(IEdgeLabelLayout labelLayout, IEdgeLayout edgeLayout, INodeLayout sourceLayout, INodeLayout targetLayout) Returns all EdgeLabelCandidates that describe valid label positions within this model.
YOrientedRectangle	getLabelPlacement(YDimension labelSize, IEdgeLayout edgeLayout, INodeLayout sourceNode, INodeLayout targetNode, Object para) Returns the oriented box of the label for the position encoded by the given model parameter.
SliderMode	getMode() Gets the model's slider mode which determines whether the label slides on the edge, along both sides of the edge or along one side of the edge.
boolean	isAutoFlipping() Gets whether or not edge labels get flipped if they would be upside down in their current position.
boolean	isAutoRotationEnabled() Gets whether or not edge labels are automatically rotated according to the angle of the corresponding reference edge segment.
boolean	isDistanceRelativeToEdge() Gets whether or not the distance to the edge is interpreted relative to the edge's path.
void	setAngle(double value) Sets the angle (measured in radians) of the label model.
void	setAutoFlipping(boolean value) Sets whether or not edge labels get flipped if they would be upside down in their current position.
void	setAutoRotationEnabled(boolean value) Sets whether or not edge labels are automatically rotated according to the angle of the corresponding reference edge segment.
void	setDistance(double value) Sets the distance between the label's box and the edge's path.
void	setDistanceRelativeToEdge(boolean value) Sets whether or not the distance to the edge is interpreted relative to the edge's path.

Methods inherited from class java.lang.Object

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

Constructor Detail

SliderEdgeLabelLayoutModel

public SliderEdgeLabelLayoutModel(SliderMode mode)

Creates a new instance of SliderEdgeLabelLayoutModel with the given mode.

Parameters:

mode - the slider mode

See Also:

getMode()

Method Detail

createModelParameter

public Object createModelParameter(YOrientedRectangle labelBounds,
                                   IEdgeLayout edgeLayout,
                                   INodeLayout sourceNode,
                                   INodeLayout targetNode)

Description copied from interface: IEdgeLabelLayoutModel

Creates a model parameter that represents the given edge label position within this model.

The created model parameter is the closest parameter representation of the given label location that can be achieved within this model.

This parameter can be passed to IEdgeLabelLayoutModel.getLabelPlacement(YDimension, IEdgeLayout, INodeLayout, INodeLayout, Object) to retrieve the current label box.

A model parameter can be an arbitrary Object. However it must contain all information to allow restoring of the encoded location with this IEdgeLabelLayoutModel.

Specified by:

createModelParameter in interface IEdgeLabelLayoutModel

Parameters:

labelBounds - the oriented box of the label, encoding the label location for which the parameter should be created

edgeLayout - the layout of the edge to which the label belongs

sourceNode - the layout of the source node of the label-owning edge

targetNode - the layout of the target node of the label-owning edge

Returns:

the model parameter representing the given label location

See Also:

IEdgeLabelLayoutModel.getLabelPlacement(YDimension, IEdgeLayout, INodeLayout, INodeLayout, Object)

getAngle

public double getAngle()

Gets the angle (measured in radians) of the label model.

The angle is applied in clockwise direction.

Default Value:

The default value is 0.

Returns:

the angle of the label model

See Also:

setAngle(double)

getDefaultParameter

public Object getDefaultParameter()

Gets a model parameter that encodes the default position of this model's allowed edge label positions.

This parameter can be passed to getLabelPlacement(YDimension, IEdgeLayout, INodeLayout, INodeLayout, Object) to retrieve the corresponding label box.

The default positions for the slider modes are relative to the first edge segment, either at the beginning of the segment (SliderMode.SIDE or SliderMode.SINGLE_SIDE) or at its middle (SliderMode.CENTER).

Specified by:

getDefaultParameter in interface IEdgeLabelLayoutModel

Returns:

the model parameter describing the default placement of the edge label

See Also:

getMode()

getDistance

public double getDistance()

Gets the distance between the label's box and the edge's path.

The interpretation of positive/negative values depends on property DistanceRelativeToEdge.

Default Value:

The default value is 5.

Returns:

the distance between the label's box and the edge's path

See Also:

setDistanceRelativeToEdge(boolean), setDistance(double)

getLabelCandidates

public YList getLabelCandidates(IEdgeLabelLayout labelLayout,
                                IEdgeLayout edgeLayout,
                                INodeLayout sourceLayout,
                                INodeLayout targetLayout)

Returns all EdgeLabelCandidates that describe valid label positions within this model.

The number of candidates and their respective locations are computed depending on the geometries of both label and edge.

Specified by:

getLabelCandidates in interface IEdgeLabelLayoutModel

Parameters:

labelLayout - the label for which candidates should be generated

edgeLayout - the layout of the edge to which the label belongs

sourceLayout - the layout of the source node of the label-owning edge

targetLayout - the layout of the target node of the label-owning edge

Returns:

a list of EdgeLabelCandidate instances

getLabelPlacement

public YOrientedRectangle getLabelPlacement(YDimension labelSize,
                                            IEdgeLayout edgeLayout,
                                            INodeLayout sourceNode,
                                            INodeLayout targetNode,
                                            Object para)

Description copied from interface: IEdgeLabelLayoutModel

Returns the oriented box of the label for the position encoded by the given model parameter.

Specified by:

getLabelPlacement in interface IEdgeLabelLayoutModel

Parameters:

labelSize - the width and height of the label

edgeLayout - the layout of the edge to which the label belongs

sourceNode - the layout of the source node of the label-owning edge

targetNode - the layout of the target node of the label-owning edge

para - the model parameter that describes the abstract position of the label within this model

Returns:

the oriented bounds of the label

getMode

public SliderMode getMode()

Gets the model's slider mode which determines whether the label slides on the edge, along both sides of the edge or along one side of the edge.

Returns:

the model's slider mode

isAutoFlipping

public boolean isAutoFlipping()

Gets whether or not edge labels get flipped if they would be upside down in their current position.

Default Value:

The default value is false. Edge labels keep their orientation.

Returns:

true if edge labels get flipped if they would be upside down in their current position, false otherwise

See Also:

setAutoFlipping(boolean)

isAutoRotationEnabled

public boolean isAutoRotationEnabled()

Gets whether or not edge labels are automatically rotated according to the angle of the corresponding reference edge segment.

Default Value:

The default value is true. Labels are rotated with their edge segment.

Returns:

true if edge labels are automatically rotated according to the angle of the corresponding reference edge segment, false otherwise

See Also:

setAutoRotationEnabled(boolean)

isDistanceRelativeToEdge

public boolean isDistanceRelativeToEdge()

Gets whether or not the distance to the edge is interpreted relative to the edge's path.

If enabled, the label is placed to the left of the edge segment (relative to the segment direction) if the given distance is less than 0 and to the right of the edge segment if the given distance is greater than 0.

If disabled, the label is placed below the edge segment (in geometric sense) if the distance is less than 0 and above the edge segment if the distance is greater than 0.

Default Value:

The default value is true. The distance to the edge is interpreted relative to the edge's path.

Returns:

true if the distance is described relative to the edge, false otherwise

See Also:

setDistance(double), setDistanceRelativeToEdge(boolean)

setAngle

public void setAngle(double value)

Sets the angle (measured in radians) of the label model.

The angle is applied in clockwise direction.

Default Value:

The default value is 0.

Parameters:

value - the angle of the label model

See Also:

getAngle()

setAutoFlipping

public void setAutoFlipping(boolean value)

Sets whether or not edge labels get flipped if they would be upside down in their current position.

Default Value:

The default value is false. Edge labels keep their orientation.

Parameters:

value - true if edge labels get flipped if they would be upside down in their current position, false otherwise

See Also:

isAutoFlipping()

setAutoRotationEnabled

public void setAutoRotationEnabled(boolean value)

Sets whether or not edge labels are automatically rotated according to the angle of the corresponding reference edge segment.

Default Value:

The default value is true. Labels are rotated with their edge segment.

Parameters:

value - true if edge labels are automatically rotated according to the angle of the corresponding reference edge segment, false otherwise

See Also:

isAutoRotationEnabled()

setDistance

public void setDistance(double value)

Sets the distance between the label's box and the edge's path.

The interpretation of positive/negative values depends on property DistanceRelativeToEdge.

Default Value:

The default value is 5.

Parameters:

value - the distance between the label's box and the edge's path

See Also:

setDistanceRelativeToEdge(boolean), getDistance()

setDistanceRelativeToEdge

public void setDistanceRelativeToEdge(boolean value)

Sets whether or not the distance to the edge is interpreted relative to the edge's path.

If enabled, the label is placed to the left of the edge segment (relative to the segment direction) if the given distance is less than 0 and to the right of the edge segment if the given distance is greater than 0.

If disabled, the label is placed below the edge segment (in geometric sense) if the distance is less than 0 and above the edge segment if the distance is greater than 0.

Default Value:

The default value is true. The distance to the edge is interpreted relative to the edge's path.

Parameters:

value - true if the distance is described relative to the edge, false otherwise

See Also:

setDistance(double), isDistanceRelativeToEdge()