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

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

All Implemented Interfaces:

ILookup, ILabelModel, ILabelModelParameterProvider
```
public class NinePositionsEdgeLabelModel
extends Object
implements ILabelModel, ILabelModelParameterProvider
```
An edge label model that knows nine different label positions.
The possible positions are near the source port, at the center of the edge, or near the target port, each above, below, or centered on the edge. The distance to the edge and the absolute angular orientation of the label can be specified.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NinePositionsEdgeLabelModel.Position
Determines the position of a label in the NinePositionsEdgeLabelModel.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NinePositionsEdgeLabelModel.Position` Determines the position of a label in the `NinePositionsEdgeLabelModel`.

Field Summary

Fields
Modifier and Type	Field and Description
`static ILabelModelParameter`	`CENTER_ABOVE` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`CENTER_BELOW` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`CENTER_CENTERED` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`SOURCE_ABOVE` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`SOURCE_BELOW` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`SOURCE_CENTERED` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`TARGET_ABOVE` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`TARGET_BELOW` A convenience parameter instance that can be shared between label instances.
`static ILabelModelParameter`	`TARGET_CENTERED` A convenience parameter instance that can be shared between label instances.

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

Constructor Summary

Constructors
Constructor and Description
`NinePositionsEdgeLabelModel()` Initializes a new instance of the `NinePositionsEdgeLabelModel` class with a `Distance` of 10 and an `Angle` of 0.
`NinePositionsEdgeLabelModel(double distance, double angle)` Initializes a new instance of the `NinePositionsEdgeLabelModel` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ILabelModelParameter`	`createDefaultParameter()` Creates a default parameter that can be used for this model.
`ILabelModelParameter`	`createParameter(NinePositionsEdgeLabelModel.Position position)` Create a model parameter for the specified .
`double`	`getAngle()` Gets the angle for the rotation of the labels.
`ILookup`	`getContext(ILabel label, ILabelModelParameter layoutParameter)` Provides a `lookup context` for the given combination of label and parameter.
`double`	`getDistance()` Gets the distance of the labels above or below the edge.
`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`.
`void`	`setAngle(double value)` Sets the angle for the rotation of the labels.
`void`	`setDistance(double value)` Sets the distance of the labels above or below the edge.

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

- Field Detail
  - CENTER_ABOVE
```
public static final ILabelModelParameter CENTER_ABOVE
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - CENTER_BELOW
```
public static final ILabelModelParameter CENTER_BELOW
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - CENTER_CENTERED
```
public static final ILabelModelParameter CENTER_CENTERED
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - SOURCE_ABOVE
```
public static final ILabelModelParameter SOURCE_ABOVE
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - SOURCE_BELOW
```
public static final ILabelModelParameter SOURCE_BELOW
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - SOURCE_CENTERED
```
public static final ILabelModelParameter SOURCE_CENTERED
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - TARGET_ABOVE
```
public static final ILabelModelParameter TARGET_ABOVE
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - TARGET_BELOW
```
public static final ILabelModelParameter TARGET_BELOW
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
  - TARGET_CENTERED
```
public static final ILabelModelParameter TARGET_CENTERED
```
    A convenience parameter instance that can be shared between label instances.
    Trying to change that instances' Angle or Distance properties will raise an IllegalStateException.
- Constructor Detail
  - NinePositionsEdgeLabelModel
```
public NinePositionsEdgeLabelModel()
```
    Initializes a new instance of the NinePositionsEdgeLabelModel class with a Distance of 10 and an Angle of 0.
  - NinePositionsEdgeLabelModel
```
public NinePositionsEdgeLabelModel(double distance,
                                   double angle)
```
    Initializes a new instance of the NinePositionsEdgeLabelModel class.
    
    Parameters:
    
    distance - The distance.
    
    angle - The angle.
- Method Detail
  - 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
  - createParameter
```
public ILabelModelParameter createParameter(NinePositionsEdgeLabelModel.Position position)
```
    Create a model parameter for the specified .position
    
    Parameters:
    
    position - The position for this parameter
    
    Returns:
    
    a model parameter for the specified position
  - getAngle
```
public double getAngle()
```
    Gets the angle for the rotation of the labels.
    A value of 0 makes the label appear horizontally aligned.
    
    Returns:
    
    The angle in radians.
    
    See Also:
    
    setAngle(double)
  - 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
  - getDistance
```
public double getDistance()
```
    Gets the distance of the labels above or below the edge.
    
    Returns:
    
    The distance to the edge.
    
    See Also:
    
    setDistance(double)
  - 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 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
  - setAngle
```
public void setAngle(double value)
```
    Sets the angle for the rotation of the labels.
    A value of 0 makes the label appear horizontally aligned.
    
    Parameters:
    
    value - The angle in radians.
    
    See Also:
    
    getAngle()
  - setDistance
```
public void setDistance(double value)
```
    Sets the distance of the labels above or below the edge.
    
    Parameters:
    
    value - The distance to the edge.
    
    See Also:
    
    getDistance()

Class NinePositionsEdgeLabelModel

Nested Class Summary

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

Field Detail

CENTER_ABOVE

CENTER_BELOW

CENTER_CENTERED

SOURCE_ABOVE

SOURCE_BELOW

SOURCE_CENTERED

TARGET_ABOVE

TARGET_BELOW

TARGET_CENTERED

Constructor Detail

NinePositionsEdgeLabelModel

NinePositionsEdgeLabelModel

Method Detail

createDefaultParameter

createParameter

getAngle

getContext

getDistance

getGeometry

getParameters

lookup

setAngle

setDistance