com.yworks.yfiles.graph.labelmodels

Class FreeEdgeLabelModel

java.lang.Object

com.yworks.yfiles.graph.labelmodels.FreeEdgeLabelModel

All Implemented Interfaces:

ILookup, ILabelModel, ILabelModelParameterFinder

public class FreeEdgeLabelModel
extends Object
implements ILabelModelParameterFinder, ILabelModel

An edge label model that can be used to describe any position and orientation of a label.

The position of the label is stored relative to the positions of the ports of the edge the label belongs to.

Field Summary

Fields

Modifier and Type	Field and Description
static FreeEdgeLabelModel	INSTANCE A shared unmodifiable public instance that can be used to obtain parameters.

Fields inherited from interface com.yworks.yfiles.graph.ILookup

EMPTY

Constructor Summary

Constructors

Constructor and Description
FreeEdgeLabelModel()

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILabelModelParameter	createEdgeAnchored(double ratio, double distance, double angle) Creates a parameter for the given location.
ILabelModelParameter	findBestParameter(ILabel label, ILabelModel model, IOrientedRectangle layout) Tries to find a parameter that best matches the given layout for the provided label instance.
ILookup	getContext(ILabel label, ILabelModelParameter layoutParameter) Provides a lookup context for the given combination of label and parameter.
IOrientedRectangle	getGeometry(ILabel label, ILabelModelParameter layoutParameter) Calculates the geometry of the given label using the given model parameter.
boolean	isRelativeAngleEnabled() Gets a property that indicates whether the angle used by the parameter should be interpreted relative to the edge's orientation or as an absolute angle in the coordinate system.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
void	setRelativeAngleEnabled(boolean value) Sets a property that indicates whether the angle used by the parameter should be interpreted relative to the edge's orientation or as an absolute angle in the coordinate system.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

Field Detail

INSTANCE

public static final FreeEdgeLabelModel INSTANCE

A shared unmodifiable public instance that can be used to obtain parameters.

Constructor Detail

FreeEdgeLabelModel

public FreeEdgeLabelModel()

Method Detail

createDefaultParameter

public final ILabelModelParameter createDefaultParameter()

Description copied from interface: ILabelModel

Creates a default parameter that can be used for this model.

Specified by:

createDefaultParameter in interface ILabelModel

Returns:

a parameter for this model instance

createEdgeAnchored

public final ILabelModelParameter createEdgeAnchored(double ratio,
                                                     double distance,
                                                     double angle)

Creates a parameter for the given location.

Parameters:

ratio - The ratio at which the label will be anchored between the location of the source port and the location of the target port.

distance - The distance orthogonally to the connection between the source and target point.

angle - The angle by which the label should be rotated.

Returns:

A parameter that describes the position.

See Also:

isRelativeAngleEnabled()

findBestParameter

public final ILabelModelParameter findBestParameter(ILabel label,
                                                    ILabelModel model,
                                                    IOrientedRectangle layout)

Tries to find a parameter that best matches the given layout for the provided label instance.

This implementation will match the provided layout perfectly.

Specified by:

findBestParameter in interface ILabelModelParameterFinder

Parameters:

label - The label to find a parameter for.

model - The model instance to use. This should be this instance.

layout - The anticipated layout for the label.

Returns:

A non-null parameter that can be used for the label to approximate the provided layout.

getContext

public ILookup getContext(ILabel label,
                          ILabelModelParameter layoutParameter)

Description copied from interface: ILabelModel

Provides a lookup context for the given combination of label and parameter.

Specified by:

getContext in interface ILabelModel

Parameters:

label - The label to use in the context.

layoutParameter - The parameter to use for the label in the context.

Returns:

An implementation of the ILookup interface that can be used to query additional aspects of the label/parameter combination.

See Also:

ILookup.EMPTY

getGeometry

public final IOrientedRectangle getGeometry(ILabel label,
                                            ILabelModelParameter layoutParameter)

Description copied from interface: ILabelModel

Calculates the geometry of the given label using the given model parameter.

Specified by:

getGeometry in interface ILabelModel

Parameters:

label - The label to calculate the geometry for.

layoutParameter - A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property Model returns this instance.

Returns:

An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.

isRelativeAngleEnabled

public boolean isRelativeAngleEnabled()

Gets a property that indicates whether the angle used by the parameter should be interpreted relative to the edge's orientation or as an absolute angle in the coordinate system.

By default the angle is interpreted to be relative to the world coordinates axes.

Returns:

The RelativeAngleEnabled.

See Also:

setRelativeAngleEnabled(boolean)

lookup

public <TLookup> TLookup lookup(Class<TLookup> type)

Description copied from interface: ILookup

Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.

Specified by:

lookup in interface ILookup

Parameters:

type - the type for which an instance shall be returned

Returns:

an instance that is assignable to type or null

setRelativeAngleEnabled

public void setRelativeAngleEnabled(boolean value)

Sets a property that indicates whether the angle used by the parameter should be interpreted relative to the edge's orientation or as an absolute angle in the coordinate system.

By default the angle is interpreted to be relative to the world coordinates axes.

Parameters:

value - The RelativeAngleEnabled to set.

See Also:

isRelativeAngleEnabled()