com.yworks.yfiles.graph.labelmodels

Class ConstantLabelCandidateDescriptorProvider

java.lang.Object

com.yworks.yfiles.graph.labelmodels.ConstantLabelCandidateDescriptorProvider

All Implemented Interfaces:

ILabelCandidateDescriptorProvider

public final class ConstantLabelCandidateDescriptorProvider
extends Object
implements ILabelCandidateDescriptorProvider

An implementation of the ILabelCandidateDescriptorProvider interface that always yields a constant ILabelCandidateDescriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static ILabelCandidateDescriptorProvider	EXTERNAL_DESCRIPTOR_PROVIDER A sharable implementation of the ILabelCandidateDescriptorProvider interface that always yields LabelCandidateDescriptor.EXTERNAL_DESCRIPTOR.
static ILabelCandidateDescriptorProvider	INTERNAL_DESCRIPTOR_PROVIDER A sharable implementation of the ILabelCandidateDescriptorProvider interface that always yields LabelCandidateDescriptor.INTERNAL_DESCRIPTOR.

Constructor Summary

Constructors

Constructor and Description
ConstantLabelCandidateDescriptorProvider(ILabelCandidateDescriptor descriptor) Initializes a new instance of the ConstantLabelCandidateDescriptorProvider class that always yields descriptor in getDescriptor(ILabel, ILabelModelParameter).

Method Summary

Modifier and Type	Method and Description
ILabelCandidateDescriptor	getDescriptor(ILabel label, ILabelModelParameter layoutParameter) Always yields the parameter that has been passed to the constructor.

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNAL_DESCRIPTOR_PROVIDER

public static final ILabelCandidateDescriptorProvider EXTERNAL_DESCRIPTOR_PROVIDER

A sharable implementation of the ILabelCandidateDescriptorProvider interface that always yields LabelCandidateDescriptor.EXTERNAL_DESCRIPTOR.

INTERNAL_DESCRIPTOR_PROVIDER

public static final ILabelCandidateDescriptorProvider INTERNAL_DESCRIPTOR_PROVIDER

A sharable implementation of the ILabelCandidateDescriptorProvider interface that always yields LabelCandidateDescriptor.INTERNAL_DESCRIPTOR.

Constructor Detail

ConstantLabelCandidateDescriptorProvider

public ConstantLabelCandidateDescriptorProvider(ILabelCandidateDescriptor descriptor)

Initializes a new instance of the ConstantLabelCandidateDescriptorProvider class that always yields descriptor in getDescriptor(ILabel, ILabelModelParameter).

Parameters:

descriptor - The descriptor to yield in getDescriptor(ILabel, ILabelModelParameter).

Method Detail

getDescriptor

public final ILabelCandidateDescriptor getDescriptor(ILabel label,
                                                     ILabelModelParameter layoutParameter)

Always yields the parameter that has been passed to the constructor.

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.