com.yworks.yfiles.graph.labelmodels

Class FreeLabelModel

java.lang.Object

com.yworks.yfiles.graph.labelmodels.FreeLabelModel

All Implemented Interfaces:

ILookup, ILabelModel, ILabelModelParameterFinder

public class FreeLabelModel
extends Object
implements ILabelModelParameterFinder, ILabelModel

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

The position of the label is stored absolutely and is not influenced by the layout or position of the owner of the label. In fact the owner is not even queried during a call to getGeometry(ILabel, ILabelModelParameter).

Field Summary

Fields

Modifier and Type	Field and Description
static FreeLabelModel	INSTANCE A shared 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
FreeLabelModel()

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	createAbsolute(PointD anchorLocation, double angle) Creates a new label model parameter that places the label at the given absolute position using the provided angle.
ILabelModelParameter	createAnchored(IPoint location, double angle) Creates a new label at the given dynamic location using the provided angle.
ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILabelModelParameter	createDynamic(IOrientedRectangle layout) Creates a new label model parameter that dynamically reads the label layout from the provided instance.
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.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.

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

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

Constructor Detail

FreeLabelModel

public FreeLabelModel()

Method Detail

createAbsolute

public final ILabelModelParameter createAbsolute(PointD anchorLocation,
                                                 double angle)

Creates a new label model parameter that places the label at the given absolute position using the provided angle.

Parameters:

anchorLocation - The location for the parameter.

angle - The angle of rotation.

Returns:

A new parameter that is associated with this instance.

createAnchored

public final ILabelModelParameter createAnchored(IPoint location,
                                                 double angle)

Creates a new label at the given dynamic location using the provided angle.

Parameters:

location - The location to place the parameter at. That instance is stored by reference.

angle - The angle of rotation.

Returns:

A new parameter that is associated with this instance.

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

createDynamic

public final ILabelModelParameter createDynamic(IOrientedRectangle layout)

Creates a new label model parameter that dynamically reads the label layout from the provided instance.

Parameters:

layout - The oriented rectangle to dynamically retrieve the values from.

Returns:

A new parameter that is associated with this instance.

findBestParameter

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

Description copied from interface: ILabelModelParameterFinder

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

This method may not necessarily find a parameter that matches the provided layout exactly. Implementations may choose to simply return the model's default parameter but may never return null.

Specified by:

findBestParameter in interface ILabelModelParameterFinder

Parameters:

label - The label to find a parameter for.

model - The model instance to use. This should be the instance this instance has been obtained from.

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.

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