GenericLabelModel (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.graph.labelmodels.GenericLabelModel

All Implemented Interfaces:

ILookup, ILabelCandidateDescriptorProvider, ILabelModel, ILabelModelParameterProvider, IMarkupExtensionConverter
```
public class GenericLabelModel
extends Object
implements ILabelModel, ILabelModelParameterProvider, ILabelCandidateDescriptorProvider, IMarkupExtensionConverter
```
An implementation of ILabelModel that can be used to create custom label models out of existing ILabelModelParameter instances.
This class holds a number of parameters and serves as a container for these parameters. Custom models can easily be created that way:

Field Summary
- Fields inherited from interface com.yworks.yfiles.graph.ILookup
  EMPTY

Constructor Summary

Constructors
Constructor and Description
`GenericLabelModel(ILabelModelParameter defaultLayoutParameter)` Create a new generic label model using the provided parameter as the `default parameter.`.
`GenericLabelModel(ILabelModelParameter defaultLayoutParameter, ILabelCandidateDescriptor descriptor)` Create a new generic label model using the provided parameter as the `default parameter.`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ILabelModelParameter`	`addParameter(ILabelModelParameter layoutParameter)` Adds another parameter to this models collection of parameters.
`ILabelModelParameter`	`addParameter(ILabelModelParameter layoutParameter, ILabelCandidateDescriptor descriptor)` Adds another parameter to this models collection of parameters.
`boolean`	`canConvert(IWriteContext context, Object value)` Returns if the converter can convert the `value` to a `MarkupExtension` in the current write context.
`MarkupExtension`	`convert(IWriteContext context, Object value)` Converts the `value` to a `MarkupExtension` using the current write context.
`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(ILabel label, ILabelModelParameter layoutParameter)` Yields the `ILabelCandidateDescriptor` that has been associated with the instance during `addParameter(ILabelModelParameter, ILabelCandidateDescriptor)`.
`IOrientedRectangle`	`getGeometry(ILabel label, ILabelModelParameter layoutParameter)` Calculates the `geometry` of the given label using the given model parameter.
`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`.

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
  - GenericLabelModel
```
public GenericLabelModel(ILabelModelParameter defaultLayoutParameter)
```
    Create a new generic label model using the provided parameter as the default parameter..
    The parameter is stored by reference.
    
    Throws:
    
    NullPointerException - defaultParameter is null.
    
    Parameters:
    
    defaultLayoutParameter - The parameter to use as the default.
    
    See Also:
    
    getDescriptor(ILabel, ILabelModelParameter)
  - GenericLabelModel
```
public GenericLabelModel(ILabelModelParameter defaultLayoutParameter,
                         ILabelCandidateDescriptor descriptor)
```
    Create a new generic label model using the provided parameter as the default parameter..
    The parameter is stored by reference.
    
    Throws:
    
    NullPointerException - defaultParameter is null.
    
    Parameters:
    
    defaultLayoutParameter - The parameter to use as the default.
    
    descriptor - The descriptor to associate with the parameter.
    
    See Also:
    
    getDescriptor(ILabel, ILabelModelParameter)
- Method Detail
  - addParameter
```
public final ILabelModelParameter addParameter(ILabelModelParameter layoutParameter)
```
    Adds another parameter to this models collection of parameters.
    Note that the parameter will be wrapped by this class and the resulting parameter which will use this model instance as its Model will be returned. The parameter is stored by reference and subsequent modification of the parameter or its associated model will be reflected by this instance. Also the methods allows for associating a ILabelCandidateDescriptor with each parameter that can later be retrieved via the getDescriptor(ILabel, ILabelModelParameter) method.
    
    Parameters:
    
    layoutParameter - The parameter to add to this instance.
    
    Returns:
    
    A new parameter that wraps the provided parameter and uses this instance as its model.
  - addParameter
```
public final ILabelModelParameter addParameter(ILabelModelParameter layoutParameter,
                                               ILabelCandidateDescriptor descriptor)
```
    Adds another parameter to this models collection of parameters.
    Note that the parameter will be wrapped by this class and the resulting parameter which will use this model instance as its Model will be returned. The parameter is stored by reference and subsequent modification of the parameter or its associated model will be reflected by this instance. Also the methods allows for associating a ILabelCandidateDescriptor with each parameter that can later be retrieved via the getDescriptor(ILabel, ILabelModelParameter) method.
    
    Parameters:
    
    layoutParameter - The parameter to add to this instance.
    
    descriptor - The descriptor to associate with the parameter.
    
    Returns:
    
    A new parameter that wraps the provided parameter and uses this instance as its model.
  - canConvert
```
public final boolean canConvert(IWriteContext context,
                                Object value)
```
    Description copied from interface: IMarkupExtensionConverter
    
    Returns if the converter can convert the value to a MarkupExtension in the current write context.
    
    Specified by:
    
    canConvert in interface IMarkupExtensionConverter
    
    Parameters:
    
    context - The current write context.
    
    value - The object to convert.
    
    Returns:
    
    Whether the converter can convert the passed value.
  - convert
```
public final MarkupExtension convert(IWriteContext context,
                                     Object value)
```
    Description copied from interface: IMarkupExtensionConverter
    
    Converts the value to a MarkupExtension using the current write context.
    
    Specified by:
    
    convert in interface IMarkupExtensionConverter
    
    Parameters:
    
    context - The current write context.
    
    value - The object to convert.
    
    Returns:
    
    The MarkupExtension the value was converted to.
  - 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
  - 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
  - getDescriptor
```
public ILabelCandidateDescriptor getDescriptor(ILabel label,
                                               ILabelModelParameter layoutParameter)
```
    Yields the ILabelCandidateDescriptor that has been associated with the instance during addParameter(ILabelModelParameter, ILabelCandidateDescriptor).
    
    Specified by:
    
    getDescriptor in interface ILabelCandidateDescriptorProvider
    
    Parameters:
    
    label - The label instance to use.
    
    layoutParameter - The parameter to get the descriptor for.
    
    Returns:
    
    The descriptor instance that had been added to this instance during addParameter(ILabelModelParameter, ILabelCandidateDescriptor).
  - 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.
  - 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 <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

Class GenericLabelModel

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericLabelModel

GenericLabelModel

Method Detail

addParameter

addParameter

canConvert

convert

createDefaultParameter

getContext

getDescriptor

getGeometry

getParameters

lookup