com.yworks.yfiles.layout

Class DiscreteEdgeLabelLayoutModel

java.lang.Object

com.yworks.yfiles.layout.DiscreteEdgeLabelLayoutModel

All Implemented Interfaces:

IEdgeLabelLayoutModel

public class DiscreteEdgeLabelLayoutModel
extends Object
implements IEdgeLabelLayoutModel

DiscreteEdgeLabelLayoutModel describes the placement of rotated labels at some predefined positions along the edge.

The predefined positions in this model

It's possible to specify a distance value that controls the distance between label and edge.

Furthermore, there's the possibility to mask out arbitrary edge label candidates. This can either be done by specifying predefined candidate masks or combining several label positions with a logical or-operation to a user-defined mask.

Constructor Summary

Constructors

Constructor and Description
DiscreteEdgeLabelLayoutModel() Creates a new instance of DiscreteEdgeLabelLayoutModel with default settings.
DiscreteEdgeLabelLayoutModel(DiscreteEdgeLabelPositions candidateMask) Creates a new instance of DiscreteEdgeLabelLayoutModel using the given candidate mask.

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.
static Object	createPositionParameter(int position) Returns a model parameter that encodes the specified position.
double	getAngle() Gets the angle (measured in radians) of the label model.
DiscreteEdgeLabelPositions	getCandidateMask() Gets the candidate mask which specifies the valid positions for edge labels.
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 bounding box and the edge path.
YList	getLabelCandidates(IEdgeLabelLayout label, IEdgeLayout edgeLayout, INodeLayout sourceNode, INodeLayout targetNode) Returns all EdgeLabelCandidates that describe valid label positions within this model.
protected YOrientedRectangle	getLabelPlacement(YDimension labelSize, IEdgeLayout edgeLayout, INodeLayout sourceLayout, INodeLayout targetLayout, DiscreteEdgeLabelPositions position) Returns the oriented box of the label for the given label position.
YOrientedRectangle	getLabelPlacement(YDimension labelSize, IEdgeLayout edgeLayout, INodeLayout sourceNode, INodeLayout targetNode, Object param) Returns the oriented box of the label for the position encoded by the given model parameter.
static int	getPosition(Object parameter) Returns the position specifier that is encoded by the given model parameter.
boolean	isAutoFlippingEnabled() 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	isParameterValid(Object parameter) Checks whether or not the given model parameter encodes a valid edge label position for this model.
boolean	isPositionRelativeToSegment() Gets whether or not the label position mask should be interpreted relative to the edge segment.
void	setAngle(double value) Sets the angle (measured in radians) of the label model.
void	setAutoFlippingEnabled(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 bounding box and the edge path.
void	setPositionRelativeToSegment(boolean value) Sets whether or not the label position mask should be interpreted relative to the edge segment.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscreteEdgeLabelLayoutModel

public DiscreteEdgeLabelLayoutModel()

Creates a new instance of DiscreteEdgeLabelLayoutModel with default settings.

DiscreteEdgeLabelLayoutModel

public DiscreteEdgeLabelLayoutModel(DiscreteEdgeLabelPositions candidateMask)

Creates a new instance of DiscreteEdgeLabelLayoutModel using the given candidate mask.

The candidates mask can either describe multiple or single valid positions.

Parameters:

candidateMask - the position mask that defines the allowed positions for an edge label

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)

createPositionParameter

public static final Object createPositionParameter(int position)

Returns a model parameter that encodes the specified position.

This model parameter can be passed to getLabelPlacement(YDimension, IEdgeLayout, INodeLayout, INodeLayout, Object) to determine the label's position.

Throws:

IllegalArgumentException - if the specified position is unknown

Parameters:

position - one of the valid positions

Returns:

a model parameter that encodes the specified position

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)

getCandidateMask

public DiscreteEdgeLabelPositions getCandidateMask()

Gets the candidate mask which specifies the valid positions for edge labels.

Default Value:

The default value is DiscreteEdgeLabelPositions.SIX_POS

Returns:

the position mask that defines the allowed positions for an edge label

getDefaultParameter

public Object getDefaultParameter()

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

Default positions are (in descending order):

• DiscreteEdgeLabelPositions.CENTER
• DiscreteEdgeLabelPositions.SOURCE_CENTER
• DiscreteEdgeLabelPositions.TAIL
• DiscreteEdgeLabelPositions.SOURCE_TAIL

Descending order means that whenever two or more of the above default positions are part of the allowed positions, then the model parameter encodes the one that is listed first.

Specified by:

getDefaultParameter in interface IEdgeLabelLayoutModel

The model parameter encodes DiscreteEdgeLabelPositions.CENTER when none of the above default positions is part of the allowed positions.

Returns:

the model parameter describing the default placement of the edge label

getDistance

public double getDistance()

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

The distance must be a non-negative value.

Default Value:

The default value is 2.

Returns:

the distance between the edge and the associated label

See Also:

setDistance(double)

getLabelCandidates

public YList getLabelCandidates(IEdgeLabelLayout label,
                                IEdgeLayout edgeLayout,
                                INodeLayout sourceNode,
                                INodeLayout targetNode)

Description copied from interface: IEdgeLabelLayoutModel

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

In case the implementing IEdgeLabelLayoutModel allows every possible location, this method always returns the current location as a LabelCandidate.

Specified by:

getLabelCandidates in interface IEdgeLabelLayoutModel

Parameters:

label - the label for which candidates should be generated

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:

a list of EdgeLabelCandidate instances

getLabelPlacement

protected YOrientedRectangle getLabelPlacement(YDimension labelSize,
                                               IEdgeLayout edgeLayout,
                                               INodeLayout sourceLayout,
                                               INodeLayout targetLayout,
                                               DiscreteEdgeLabelPositions position)

Returns the oriented box of the label for the given label position.

This method is called by getLabelPlacement(YDimension, IEdgeLayout, INodeLayout, INodeLayout, Object) and getLabelCandidates(IEdgeLabelLayout, IEdgeLayout, INodeLayout, INodeLayout) to retrieve a valid position.

Parameters:

labelSize - the size of the label that should be placed

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

position - the label position that is valid in this model

Returns:

the oriented box of the label

getLabelPlacement

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

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

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

Returns:

the oriented bounds of the label

getPosition

public static final int getPosition(Object parameter)

Returns the position specifier that is encoded by the given model parameter.

Throws:

IllegalArgumentException - if the specified model parameter is not valid for this model

Parameters:

parameter - the model parameter

Returns:

the position specifier

isAutoFlippingEnabled

public boolean isAutoFlippingEnabled()

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:

setAutoFlippingEnabled(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)

isParameterValid

public boolean isParameterValid(Object parameter)

Checks whether or not the given model parameter encodes a valid edge label position for this model.

If the model parameter describes a position that is accepted by the candidate mask, this is a valid parameter.

In order to be valid, the parameter should be created by this label model.

Parameters:

parameter - the model parameter

Returns:

true if the label position described by the given model parameter is allowed, false otherwise

isPositionRelativeToSegment

public boolean isPositionRelativeToSegment()

Gets whether or not the label position mask should be interpreted relative to the edge segment.

If this option is disabled, the position mask is interpreted in a geometric sense.

This option is only relevant for non-center positions.

Default Value:

The default value is false. Positions are interpreted geometrically.

Returns:

true if the position mask is interpreted relative to the edge segment, false otherwise

See Also:

setPositionRelativeToSegment(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()

setAutoFlippingEnabled

public void setAutoFlippingEnabled(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:

isAutoFlippingEnabled()

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 bounding box and the edge path.

The distance must be a non-negative value.

Default Value:

The default value is 2.

Parameters:

value - the distance between the edge and the associated label

See Also:

getDistance()

setPositionRelativeToSegment

public void setPositionRelativeToSegment(boolean value)

Sets whether or not the label position mask should be interpreted relative to the edge segment.

If this option is disabled, the position mask is interpreted in a geometric sense.

This option is only relevant for non-center positions.

Default Value:

The default value is false. Positions are interpreted geometrically.

Parameters:

value - true if the position mask is interpreted relative to the edge segment, false otherwise

See Also:

isPositionRelativeToSegment()