com.yworks.yfiles.graph.labelmodels

Interface ILabelModelParameterFinder

All Known Implementing Classes:

CompositeLabelModel, DefaultLabelModelParameterFinder, EdgePathLabelModel, EdgeSegmentLabelModel, FreeEdgeLabelModel, FreeLabelModel, FreeNodeLabelModel, SmartEdgeLabelModel

public interface ILabelModelParameterFinder

Utility interface used by ILabelModel implementations to find the best ILabelModelParameter to approximate a given layout.

Implementations of this class may be retrieved from ILabelModel implementations using their ILookup.lookup(java.lang.Class) method. Note that implementations are not required to return an instance if queried for this interface.

See Also:

DefaultLabelModelParameterFinder

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	findBestParameter(ILabel label, ILabelModel model, IOrientedRectangle layout) Tries to find a parameter that best matches the given layout for the provided label instance.

Method Detail

findBestParameter

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

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.