com.yworks.yfiles.graph.labelmodels

Interface ILabelModelParameter

All Superinterfaces:

ICloneable

public interface ILabelModelParameter
extends ICloneable

Defines a state that can be used to determine the geometry of a label with a ILabelModel.

Typically, implementations of this interface are created by factory methods of the corresponding Model.

This interface extends the ICloneable interface. This allows clients to obtain a persistent copy of the current state of this parameter. Immutable parameter implementations may return themselves.

See Also:

ILabelModel, ILabel

Method Summary

Modifier and Type	Method and Description
ILabelModel	getModel() Gets the model that can be used to determine the geometry of a label given this parameter and a label instance.
boolean	supports(ILabel label) Determines whether this parameter can be used for a given label instance.

Methods inherited from interface com.yworks.yfiles.utils.ICloneable

clone

Method Detail

getModel

ILabelModel getModel()

Gets the model that can be used to determine the geometry of a label given this parameter and a label instance.

Returns:

The Model.

supports

boolean supports(ILabel label)

Determines whether this parameter can be used for a given label instance.

A parameter must not necessarily support all types of labels. This method returns whether it supports the given label. For example, a parameter might only support labels that are owned by an INode.

Parameters:

label - The label to test.

Returns:

true if this instance can be used for the given label, false otherwise.