com.yworks.yfiles.layout

Class FreeEdgeLabelLayoutModel

java.lang.Object

com.yworks.yfiles.layout.FreeEdgeLabelLayoutModel

All Implemented Interfaces:

IEdgeLabelLayoutModel

public class FreeEdgeLabelLayoutModel
extends Object
implements IEdgeLabelLayoutModel

FreeEdgeLabelLayoutModel allows placing edge labels at any location.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FreeEdgeLabelLayoutModel.ModelParameter This model parameter encodes a label position within FreeEdgeLabelLayoutModel.

Constructor Summary

Constructors

Constructor and Description
FreeEdgeLabelLayoutModel() Creates a new instance of FreeEdgeLabelLayoutModel.

Method Summary

Modifier and Type	Method and Description
Object	createModelParameter(YOrientedRectangle labelBounds, IEdgeLayout edgeLayout, INodeLayout sourceLayout, INodeLayout targetLayout) Creates a model parameter that represents the given edge label position within this model.
Object	getDefaultParameter() Gets the model parameter that encodes the default position of FreeEdgeLabelLayoutModel.
YList	getLabelCandidates(IEdgeLabelLayout labelLayout, IEdgeLayout edgeLayout, INodeLayout sourceLayout, INodeLayout targetLayout) Returns the EdgeLabelCandidate that describes the current 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeEdgeLabelLayoutModel

public FreeEdgeLabelLayoutModel()

Creates a new instance of FreeEdgeLabelLayoutModel.

Method Detail

createModelParameter

public Object createModelParameter(YOrientedRectangle labelBounds,
                                   IEdgeLayout edgeLayout,
                                   INodeLayout sourceLayout,
                                   INodeLayout targetLayout)

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

The created model parameter represents the current location of the given label.

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

Specified by:

createModelParameter in interface IEdgeLabelLayoutModel

Throws:

IllegalArgumentException - if one or more of the given bounds' values are invalid, i.e., NaN

Parameters:

labelBounds - the oriented box of the label the parameter represents

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:

the model parameter representing the given label location

See Also:

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

getDefaultParameter

public Object getDefaultParameter()

Gets the model parameter that encodes the default position of FreeEdgeLabelLayoutModel.

The distance of the label to the edge's source point will be 20. The angle between the line to the center of the label and the first segment is 20 radians. The label is not rotated.

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

Specified by:

getDefaultParameter in interface IEdgeLabelLayoutModel

Returns:

the model parameter describing the default placement of the edge label

getLabelCandidates

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

Returns the EdgeLabelCandidate that describes the current label position.

Specified by:

getLabelCandidates in interface IEdgeLabelLayoutModel

The returned list contains only one candidate which describes the current location.

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 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