com.yworks.yfiles.graph.labelmodels

Class DescriptorWrapperLabelModel

java.lang.Object

com.yworks.yfiles.graph.labelmodels.DescriptorWrapperLabelModel

All Implemented Interfaces:

ILookup, ILabelCandidateDescriptorProvider, ILabelModel, ILabelModelParameterProvider

public class DescriptorWrapperLabelModel
extends Object
implements ILabelModel, ILabelCandidateDescriptorProvider, ILabelModelParameterProvider

A label model that wraps an existing label model and decorates it with a descriptor.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
DescriptorWrapperLabelModel() Creates a new instance that uses FreeLabelModel.INSTANCE as inner model.
DescriptorWrapperLabelModel(ILabelModel innerModel) Initializes a new instance of the DescriptorWrapperLabelModel class.

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILookup	getContext(ILabel label, ILabelModelParameter layoutParameter) Provides a lookup context for the given combination of label and parameter.
ILabelCandidateDescriptor	getDescriptor() Gets the descriptor.
ILabelCandidateDescriptor	getDescriptor(ILabel label, ILabelModelParameter layoutParameter) Gets the descriptor for a given pair of a label and a ILabelModelParameter.
IOrientedRectangle	getGeometry(ILabel label, ILabelModelParameter layoutParameter) Calculates the geometry of the given label using the given model parameter.
ILabelModel	getInnerModel() Gets the inner label model.
IEnumerable<ILabelModelParameter>	getParameters(ILabel label, ILabelModel model) Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
void	setDescriptor(ILabelCandidateDescriptor value) Sets the descriptor.
void	setInnerModel(ILabelModel value) Sets the inner label model.

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

Constructor Detail

DescriptorWrapperLabelModel

public DescriptorWrapperLabelModel()

Creates a new instance that uses FreeLabelModel.INSTANCE as inner model.

DescriptorWrapperLabelModel

public DescriptorWrapperLabelModel(ILabelModel innerModel)

Initializes a new instance of the DescriptorWrapperLabelModel class.

Parameters:

innerModel - The wrapped label model.

Method Detail

createDefaultParameter

public final ILabelModelParameter createDefaultParameter()

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

Specified by:

createDefaultParameter in interface ILabelModel

Returns:

The default parameter from InnerModel

getContext

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

getDescriptor

public final ILabelCandidateDescriptor getDescriptor()

Gets the descriptor.

Returns:

The Descriptor.

See Also:

setDescriptor(ILabelCandidateDescriptor)

getDescriptor

public final ILabelCandidateDescriptor getDescriptor(ILabel label,
                                                     ILabelModelParameter layoutParameter)

Description copied from interface: ILabelCandidateDescriptorProvider

Gets the descriptor for a given pair of a label and a ILabelModelParameter.

Specified by:

getDescriptor in interface ILabelCandidateDescriptorProvider

Parameters:

label - The label to possibly assign the layoutParameter.

layoutParameter - The parameter to provide a descriptor for if applied to the given label.

Returns:

A descriptor or null.

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.

getInnerModel

public final ILabelModel getInnerModel()

Gets the inner label model.

Returns:

The InnerModel.

See Also:

setInnerModel(ILabelModel)

getParameters

public final IEnumerable<ILabelModelParameter> getParameters(ILabel label,
                                                             ILabelModel model)

Description copied from interface: ILabelModelParameterProvider

Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.

Specified by:

getParameters in interface ILabelModelParameterProvider

Parameters:

label - The label instance to use.

model - The model to provide parameters for.

Returns:

A possibly empty enumerator over a set of label model parameters.

lookup

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

setDescriptor

public final void setDescriptor(ILabelCandidateDescriptor value)

Sets the descriptor.

Parameters:

value - The Descriptor to set.

See Also:

getDescriptor()

setInnerModel

public final void setInnerModel(ILabelModel value)

Sets the inner label model.

Parameters:

value - The InnerModel to set.

See Also:

getInnerModel()