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

java.lang.Object
- com.yworks.yfiles.layout.DiscreteNodeLabelLayoutModel

All Implemented Interfaces:

INodeLabelLayoutModel
```
public class DiscreteNodeLabelLayoutModel
extends Object
implements INodeLabelLayoutModel
```
DiscreteNodeLabelLayoutModel allows placing labels at eight positions around a node and at nine positions inside the node.

The predefined positions in this model

It's possible to specify an insets value that controls the distance between label and node.

Furthermore, there's the possibility to mask out arbitrary node label candidates. This can either be done by specifying predefined candidate masks or a combination of valid positions of this model using a logical or-operation.

Constructor Summary

Constructors
Constructor and Description
`DiscreteNodeLabelLayoutModel()` Creates a new instance of `DiscreteNodeLabelLayoutModel` with default settings.
`DiscreteNodeLabelLayoutModel(DiscreteNodeLabelPositions candidateMask)` Creates a new instance of `DiscreteNodeLabelLayoutModel` using the given candidate mask and insets.
`DiscreteNodeLabelLayoutModel(DiscreteNodeLabelPositions candidateMask, double inset)` Creates a new instance of `DiscreteNodeLabelLayoutModel` using the given candidate mask and insets.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`createModelParameter(YOrientedRectangle labelBounds, INodeLayout nodeLayout)` Creates a model parameter that represents the given node label position within this model.
`DiscreteNodeLabelPositions`	`getCandidateMask()` Gets the candidate mask which specifies the valid positions for node labels.
`Object`	`getDefaultParameter()` Gets a model parameter that encodes the default position of this model's allowed node label positions.
`double`	`getDistance()` Gets the distance between the label's bounding box and the node.
`YList`	`getLabelCandidates(INodeLabelLayout labelLayout, INodeLayout nodeLayout)` Returns all `NodeLabelCandidate`s that describe valid label positions within this model.
`protected YOrientedRectangle`	`getLabelPlacement(YDimension labelSize, INodeLayout nodeLayout, DiscreteNodeLabelPositions position)` Returns the oriented box of the label for the given label position.
`YOrientedRectangle`	`getLabelPlacement(YDimension labelSize, INodeLayout nodeLayout, Object parameter)` Returns the bounds of the label for the position encoded by the given model parameter.
`boolean`	`isParameterValid(Object parameter)` Checks whether or not the given model parameter encodes a valid node label position for this model.
`void`	`setDistance(double value)` Sets the distance between the label's bounding box and the node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DiscreteNodeLabelLayoutModel
```
public DiscreteNodeLabelLayoutModel()
```
    Creates a new instance of DiscreteNodeLabelLayoutModel with default settings.
  - DiscreteNodeLabelLayoutModel
```
public DiscreteNodeLabelLayoutModel(DiscreteNodeLabelPositions candidateMask)
```
    Creates a new instance of DiscreteNodeLabelLayoutModel using the given candidate mask and insets.
    The specified mask can also describe a single position.
    
    Parameters:
    
    candidateMask - the position mask that defines the allowed positions for a node label
  - DiscreteNodeLabelLayoutModel
```
public DiscreteNodeLabelLayoutModel(DiscreteNodeLabelPositions candidateMask,
                                    double inset)
```
    Creates a new instance of DiscreteNodeLabelLayoutModel using the given candidate mask and insets.
    The specified mask can also describe a single position.
    
    Parameters:
    
    candidateMask - the position mask that defines the allowed positions for a node label
    
    inset - the inset value that defines the internal label distance to the node's border
- Method Detail
  - createModelParameter
```
public Object createModelParameter(YOrientedRectangle labelBounds,
                                   INodeLayout nodeLayout)
```
    Description copied from interface: INodeLabelLayoutModel
    
    Creates a model parameter that represents the given node label position within this model.
    The created model parameter is the closest parameter representation of the given label location that can be achieved within this model.
    
    This parameter can be passed to INodeLabelLayoutModel.getLabelPlacement(YDimension, INodeLayout, Object) to retrieve the current label box.
    
    A model parameter can be an arbitrary Object. However it must contain all information to allow restoring of the encoded location with this INodeLabelLayoutModel.
    
    Specified by:
    
    createModelParameter in interface INodeLabelLayoutModel
    
    Parameters:
    
    labelBounds - the box of the label, encoding the label location for which the parameter should be created
    
    nodeLayout - the layout of the node to which the label belongs
    
    Returns:
    
    the model parameter representing the given label location
    
    See Also:
    
    INodeLabelLayoutModel.getLabelPlacement(YDimension, INodeLayout, Object)
  - getCandidateMask
```
public DiscreteNodeLabelPositions getCandidateMask()
```
    Gets the candidate mask which specifies the valid positions for node labels.
    
    Default Value:
    The default value is DiscreteNodeLabelPositions.INTERNAL_MASK
    
    Returns:
    
    the position mask that defines the allowed positions for a node label
  - getDefaultParameter
```
public Object getDefaultParameter()
```
    Gets a model parameter that encodes the default position of this model's allowed node label positions.
    Default positions are (in descending order):
    Descending order means that whenever two or more of the above default positions are part of the allowed positions, then the model parameter encodes the one that is listed first.
    Specified by:
    
    getDefaultParameter in interface INodeLabelLayoutModel
    
    The model parameter encodes DiscreteNodeLabelPositions.CENTER when none of the above default positions is part of the allowed positions.
    
    Returns:
    
    The DefaultParameter.
  - getDistance
```
public double getDistance()
```
    Gets the distance between the label's bounding box and the node.
    The distance must be a non-negative value.
    
    Default Value:
    The default value is 4.
    
    Returns:
    
    the distance between the node and the associated label
    
    See Also:
    
    setDistance(double)
  - getLabelCandidates
```
public YList getLabelCandidates(INodeLabelLayout labelLayout,
                                INodeLayout nodeLayout)
```
    Description copied from interface: INodeLabelLayoutModel
    
    Returns all NodeLabelCandidates that describe valid label positions within this model.
    In case the implementing INodeLabelLayoutModel allows every possible location, this method always returns the current location as a LabelCandidate.
    
    Specified by:
    
    getLabelCandidates in interface INodeLabelLayoutModel
    
    Parameters:
    
    labelLayout - the label for which candidates should be generated
    
    nodeLayout - the layout of the node to which the label belongs
    
    Returns:
    
    a list of NodeLabelCandidate instances
  - getLabelPlacement
```
protected YOrientedRectangle getLabelPlacement(YDimension labelSize,
                                               INodeLayout nodeLayout,
                                               DiscreteNodeLabelPositions position)
```
    Returns the oriented box of the label for the given label position.
    This method is called by getLabelPlacement(YDimension, INodeLayout, Object) and getLabelCandidates(INodeLabelLayout, INodeLayout) to retrieve a valid position.
    
    Parameters:
    
    labelSize - the size of the label that should be placed
    
    nodeLayout - the layout of the node to which the label belongs
    
    position - the label position that is valid in this model
    
    Returns:
    
    the oriented box of the label
  - getLabelPlacement
```
public YOrientedRectangle getLabelPlacement(YDimension labelSize,
                                            INodeLayout nodeLayout,
                                            Object parameter)
```
    Description copied from interface: INodeLabelLayoutModel
    
    Returns the bounds of the label for the position encoded by the given model parameter.
    
    Specified by:
    
    getLabelPlacement in interface INodeLabelLayoutModel
    
    Parameters:
    
    labelSize - the width and height of the label
    
    nodeLayout - the layout of the node to which the label belongs
    
    parameter - the model parameter that describes the abstract position of the label within this model
    
    Returns:
    
    the oriented box of the label
  - isParameterValid
```
public boolean isParameterValid(Object parameter)
```
    Checks whether or not the given model parameter encodes a valid node label position for this model.
    If the model parameter describes a position that is accepted by the candidate mask, this is a valid parameter.
    
    In order to be valid, the parameter should be created by this label model.
    
    Parameters:
    
    parameter - the model parameter
    
    Returns:
    
    true if the label position described by the given model parameter is allowed, false otherwise
  - setDistance
```
public void setDistance(double value)
```
    Sets the distance between the label's bounding box and the node.
    The distance must be a non-negative value.
    
    Default Value:
    The default value is 4.
    
    Parameters:
    
    value - the distance between the node and the associated label
    
    See Also:
    
    getDistance()

Class DiscreteNodeLabelLayoutModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DiscreteNodeLabelLayoutModel

DiscreteNodeLabelLayoutModel

DiscreteNodeLabelLayoutModel

Method Detail

createModelParameter

getCandidateMask

getDefaultParameter

getDistance

getLabelCandidates

getLabelPlacement

getLabelPlacement

isParameterValid

setDistance