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

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

```
public class PreferredPlacementDescriptor
extends Object
```
A PreferredPlacementDescriptor provides placement information for automatic edge labeling.
It provides several options that influence the label placement in generic labeling algorithms and layout algorithms that support integrated label placement.

The preferred placement can describe multiple locations. For some options, like the placement along the edge, it is possible to have a combination of the valid values. These values can be connected with a logical or-operation.

The following options describe the preferred placement:
- the placement along the edge
- the side of the edge
- the reference of the side
- the rotation angle of the label
- the reference for the rotation angle
- the rotation behavior for label on the right side of the edge
- the angle offset for label on the right side of the edge
- the distance between the label and its edge segment
The PreferredPlacementDescriptor will be immutable after freeze() is called.

A PreferredPlacementDescriptor must be set for each label and will be retrieved by the layout algorithms calling PreferredPlacementDescriptor.

Constructor Summary

Constructors
Constructor and Description
`PreferredPlacementDescriptor()` Creates a new `PreferredPlacementDescriptor` instance with default settings.
`PreferredPlacementDescriptor(PreferredPlacementDescriptor descriptor)` Creates a new `PreferredPlacementDescriptor` instance that copies the given descriptor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`void`	`freeze()` Makes this `PreferredPlacementDescriptor` instance immutable.
`double`	`getAngle()` Gets the angle (in radians) for the label rotation.
`LabelAngleOnRightSideOffsets`	`getAngleOffsetOnRightSide()` Gets the angle offset for labels that are placed on the right side of the edge.
`LabelAngleReferences`	`getAngleReference()` Gets the reference of the angle given by `Angle`.
`LabelAngleOnRightSideRotations`	`getAngleRotationOnRightSide()` Gets how the angle is applied to labels on the right side in respect of the labels of the left side of the edge.
`double`	`getDistanceToEdge()` Gets the preferred distance between a label and the corresponding edge segment.
`LabelPlacements`	`getPlaceAlongEdge()` Gets the preferred placement along the edge.
`LabelPlacements`	`getSideOfEdge()` Gets the preferred side of the edge.
`LabelSideReferences`	`getSideReference()` Gets how to interpret the preferred side as given by `SideOfEdge`.
`int`	`hashCode()`
`boolean`	`isAngleAbsolute()` Gets whether or not one of the angle interpretations is absolute.
`boolean`	`isAngleOffsetOnRightSide180()` Gets whether or not one of the angle interpretations is to add an angle offset of `180` degrees to labels that are right of the edge.
`boolean`	`isAngleOffsetOnRightSideZero()` Gets whether or not one of the angle interpretations is to add no angle offset to labels that are right of the edge.
`boolean`	`isAngleOnRightSideCoRotating()` Gets whether or not one of the angle interpretations is to rotate the angle of labels that are right of the edge co-rotating with the labels left of or centered on the edge, i.e., the angle of all labels is interpreted clockwise.
`boolean`	`isAngleOnRightSideCounterRotating()` Gets whether or not one of the angle interpretations is to rotate the angle of labels that are right of the edge counter-rotating with the labels left of or centered on the edge, i.e., the angle of labels left or centered on edge is interpreted clockwise while the angle of labels right of edge is interpreted counter-clockwise.
`boolean`	`isAngleRelativeToEdgeFlow()` Gets whether or not one of the angle interpretation is relative to the edge slope.
`boolean`	`isAtCenter()` Gets whether or not one of the preferred placement locations for this label is at center.
`boolean`	`isAtSource()` Gets whether or not one of the preferred placement locations for this label is at source.
`boolean`	`isAtSourcePort()` Gets whether or not one of the preferred placements for this label is at the source port.
`boolean`	`isAtTarget()` Gets whether or not one of the preferred placements for this label is at target.
`boolean`	`isAtTargetPort()` Gets whether or not one of the preferred placements for this label is at the target port.
`boolean`	`isFrozen()` Returns whether or not this is an immutable instance of `PreferredPlacementDescriptor`.
`boolean`	`isLeftOfEdge()` Gets whether or not one of the preferred sides for this label is left of the edge.
`boolean`	`isOnEdge()` Gets whether or not one of the preferred sides for this label is on the edge.
`boolean`	`isRightOfEdge()` Gets whether or not one of the preferred sides for this label is right of the edge.
`boolean`	`isSideAbsoluteWithLeftInNorth()` Gets whether or not the preferred side specified by `SideOfEdge` is interpreted absolute, and on horizontal segments, labels with preferred side `LabelPlacements.LEFT_OF_EDGE` are placed above the segment.
`boolean`	`isSideAbsoluteWithRightInNorth()` Gets whether or not the preferred side specified by `SideOfEdge` is interpreted absolute, and on horizontal segments, labels with preferred side `LabelPlacements.RIGHT_OF_EDGE` are placed above the segment.
`boolean`	`isSideRelativeToEdgeFlow()` Gets whether or not the preferred side specified by `SideOfEdge` is interpreted relative to the edge flow.
`static PreferredPlacementDescriptor`	`newSharedInstance(LabelPlacements placement)` Returns an immutable descriptor instance for the specified placement.
`void`	`setAngle(double value)` Sets the angle (in radians) for the label rotation.
`void`	`setAngleOffsetOnRightSide(LabelAngleOnRightSideOffsets value)` Sets the angle offset for labels that are placed on the right side of the edge.
`void`	`setAngleReference(LabelAngleReferences value)` Sets the reference of the angle given by `Angle`.
`void`	`setAngleRotationOnRightSide(LabelAngleOnRightSideRotations value)` Sets how the angle is applied to labels on the right side in respect of the labels of the left side of the edge.
`void`	`setDistanceToEdge(double value)` Sets the preferred distance between a label and the corresponding edge segment.
`void`	`setPlaceAlongEdge(LabelPlacements value)` Sets the preferred placement along the edge.
`void`	`setSideOfEdge(LabelPlacements value)` Sets the preferred side of the edge.
`void`	`setSideReference(LabelSideReferences value)` Sets how to interpret the preferred side as given by `SideOfEdge`.
`String`	`toString()`

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

- Constructor Detail
  - PreferredPlacementDescriptor
```
public PreferredPlacementDescriptor()
```
    Creates a new PreferredPlacementDescriptor instance with default settings.
  - PreferredPlacementDescriptor
```
public PreferredPlacementDescriptor(PreferredPlacementDescriptor descriptor)
```
    Creates a new PreferredPlacementDescriptor instance that copies the given descriptor.
    
    Parameters:
    
    descriptor - the PreferredPlacementDescriptor that is copied
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - freeze
```
public void freeze()
```
    Makes this PreferredPlacementDescriptor instance immutable.
    If this instance is immutable, all setter methods will throw an IllegalStateException when invoked.
    
    See Also:
    
    isFrozen()
  - getAngle
```
public double getAngle()
```
    Gets the angle (in radians) for the label rotation.
    How this angle is applied depends on the angle reference, the rotation and the offset for labels on the right side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    Default Value:
    The default value is 0.
    
    Returns:
    
    the angle in radians
    
    See Also:
    
    setAngleReference(LabelAngleReferences), setAngleRotationOnRightSide(LabelAngleOnRightSideRotations), setAngleOffsetOnRightSide(LabelAngleOnRightSideOffsets), setAngle(double)
  - getAngleOffsetOnRightSide
```
public LabelAngleOnRightSideOffsets getAngleOffsetOnRightSide()
```
    Gets the angle offset for labels that are placed on the right side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is not valid angle offset
    
    Default Value:
    The default value is LabelAngleOnRightSideOffsets.NONE
    
    Returns:
    
    any combination of valid offsets (0 or 180 degrees)
    
    See Also:
    
    setAngleOffsetOnRightSide(LabelAngleOnRightSideOffsets)
  - getAngleReference
```
public LabelAngleReferences getAngleReference()
```
    Gets the reference of the angle given by Angle.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is not a valid angle reference
    
    Default Value:
    The default value is LabelAngleReferences.ABSOLUTE
    
    Returns:
    
    any combination of valid angle references
    
    See Also:
    
    setAngleReference(LabelAngleReferences)
  - getAngleRotationOnRightSide
```
public LabelAngleOnRightSideRotations getAngleRotationOnRightSide()
```
    Gets how the angle is applied to labels on the right side in respect of the labels of the left side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is not a valid angle rotation
    
    Default Value:
    The default value is LabelAngleOnRightSideRotations.CLOCKWISE
    
    Returns:
    
    any combination of valid rotation directions
    
    See Also:
    
    setAngleRotationOnRightSide(LabelAngleOnRightSideRotations)
  - getDistanceToEdge
```
public double getDistanceToEdge()
```
    Gets the preferred distance between a label and the corresponding edge segment.
    If the given distance is < 0, the distance is not fixed, i.e., it is chosen by the automatic labeling algorithm.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is infinite or NaN
    
    Default Value:
    The default value is -1.
    
    Returns:
    
    preferred distance between a label and the corresponding edge segment
    
    See Also:
    
    setDistanceToEdge(double)
  - getPlaceAlongEdge
```
public LabelPlacements getPlaceAlongEdge()
```
    Gets the preferred placement along the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    Placements LabelPlacements.AT_SOURCE_PORT and LabelPlacements.AT_TARGET_PORT that indicate a placement directly at the edge port are currently only supported by HierarchicLayout.
    
    Default Value:
    The default value is LabelPlacements.AT_CENTER
    
    Returns:
    
    one of the valid positions along the edge
    
    See Also:
    
    setPlaceAlongEdge(LabelPlacements)
  - getSideOfEdge
```
public LabelPlacements getSideOfEdge()
```
    Gets the preferred side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    Default Value:
    The default value is LabelPlacements.ON_EDGE
    
    Returns:
    
    one of the valid sides of the edge
    
    See Also:
    
    setSideOfEdge(LabelPlacements)
  - getSideReference
```
public LabelSideReferences getSideReference()
```
    Gets how to interpret the preferred side as given by SideOfEdge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified side reference is invalid
    
    Default Value:
    The default value is LabelSideReferences.RELATIVE_TO_EDGE_FLOW
    
    Returns:
    
    any combination of the valid side references
    
    See Also:
    
    setSideReference(LabelSideReferences)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAngleAbsolute
```
public boolean isAngleAbsolute()
```
    Gets whether or not one of the angle interpretations is absolute.
    
    Returns:
    
    true if absolute angle interpretation is a possible angle interpretation for this label, false otherwise
    
    See Also:
    
    LabelAngleReferences.ABSOLUTE
  - isAngleOffsetOnRightSide180
```
public boolean isAngleOffsetOnRightSide180()
```
    Gets whether or not one of the angle interpretations is to add an angle offset of 180 degrees to labels that are right of the edge.
    
    Returns:
    
    true if adding an angle offset of 180 degrees for right-side edges is a possible angle interpretation for this label, false otherwise.
    
    See Also:
    
    isRightOfEdge(), LabelAngleOnRightSideOffsets.SEMI
  - isAngleOffsetOnRightSideZero
```
public boolean isAngleOffsetOnRightSideZero()
```
    Gets whether or not one of the angle interpretations is to add no angle offset to labels that are right of the edge.
    
    Returns:
    
    true if adding no angle offset for right-side edges is a possible angle interpretation for this label, false otherwise
    
    See Also:
    
    isRightOfEdge(), LabelAngleOnRightSideOffsets.NONE
  - isAngleOnRightSideCoRotating
```
public boolean isAngleOnRightSideCoRotating()
```
    Gets whether or not one of the angle interpretations is to rotate the angle of labels that are right of the edge co-rotating with the labels left of or centered on the edge, i.e., the angle of all labels is interpreted clockwise.
    
    Returns:
    
    true if co-rotating angle interpretation for right-side edges is a possible angle interpretation for this label, false otherwise
    
    See Also:
    
    isRightOfEdge(), LabelAngleOnRightSideRotations.CLOCKWISE
  - isAngleOnRightSideCounterRotating
```
public boolean isAngleOnRightSideCounterRotating()
```
    Gets whether or not one of the angle interpretations is to rotate the angle of labels that are right of the edge counter-rotating with the labels left of or centered on the edge, i.e., the angle of labels left or centered on edge is interpreted clockwise while the angle of labels right of edge is interpreted counter-clockwise.
    
    Returns:
    
    true if counter-rotating angle interpretation for right-side edges is a possible angle interpretation for this label, false otherwise
    
    See Also:
    
    isRightOfEdge(), LabelAngleOnRightSideRotations.COUNTER_CLOCKWISE
  - isAngleRelativeToEdgeFlow
```
public boolean isAngleRelativeToEdgeFlow()
```
    Gets whether or not one of the angle interpretation is relative to the edge slope.
    
    Returns:
    
    true if angle interpretation relative to the edge slope is a possible angle interpretation for this label, false otherwise
    
    See Also:
    
    LabelAngleReferences.RELATIVE_TO_EDGE_FLOW
  - isAtCenter
```
public boolean isAtCenter()
```
    Gets whether or not one of the preferred placement locations for this label is at center.
    
    Returns:
    
    true if at center is a possible placement for this label, false otherwise
    
    See Also:
    
    LabelPlacements.AT_CENTER
  - isAtSource
```
public boolean isAtSource()
```
    Gets whether or not one of the preferred placement locations for this label is at source.
    
    Returns:
    
    true if at source is a possible placement for this label, false otherwise
    
    See Also:
    
    LabelPlacements.AT_SOURCE
  - isAtSourcePort
```
public boolean isAtSourcePort()
```
    Gets whether or not one of the preferred placements for this label is at the source port.
    
    Returns:
    
    true if at source port is a possible placement for this label, false otherwise
    
    See Also:
    
    LabelPlacements.AT_SOURCE_PORT
  - isAtTarget
```
public boolean isAtTarget()
```
    Gets whether or not one of the preferred placements for this label is at target.
    
    Returns:
    
    true if at target is a possible placement for this label, false otherwise
    
    See Also:
    
    LabelPlacements.AT_TARGET
  - isAtTargetPort
```
public boolean isAtTargetPort()
```
    Gets whether or not one of the preferred placements for this label is at the target port.
    
    Returns:
    
    true if at target port is a possible placement for this label, false otherwise
    
    See Also:
    
    LabelPlacements.AT_TARGET_PORT
  - isFrozen
```
public boolean isFrozen()
```
    Returns whether or not this is an immutable instance of PreferredPlacementDescriptor.
    If this instance is immutable, all setter methods will throw an IllegalStateException when invoked.
    
    Returns:
    
    true if this instance is immutable, false otherwise
    
    See Also:
    
    freeze()
  - isLeftOfEdge
```
public boolean isLeftOfEdge()
```
    Gets whether or not one of the preferred sides for this label is left of the edge.
    
    Returns:
    
    true if left of the edge is a possible side for this label, false otherwise
    
    See Also:
    
    LabelPlacements.LEFT_OF_EDGE
  - isOnEdge
```
public boolean isOnEdge()
```
    Gets whether or not one of the preferred sides for this label is on the edge.
    
    Returns:
    
    true if on the edge is a possible side for this label, false otherwise
    
    See Also:
    
    LabelPlacements.ON_EDGE
  - isRightOfEdge
```
public boolean isRightOfEdge()
```
    Gets whether or not one of the preferred sides for this label is right of the edge.
    
    Returns:
    
    true if right of the edge is a possible side for this label, false otherwise
    
    See Also:
    
    LabelPlacements.RIGHT_OF_EDGE
  - isSideAbsoluteWithLeftInNorth
```
public boolean isSideAbsoluteWithLeftInNorth()
```
    Gets whether or not the preferred side specified by SideOfEdge is interpreted absolute, and on horizontal segments, labels with preferred side LabelPlacements.LEFT_OF_EDGE are placed above the segment.
    
    Returns:
    
    true if the preferred side is interpreted absolute, false otherwise
    
    See Also:
    
    LabelSideReferences.ABSOLUTE_WITH_LEFT_IN_NORTH
  - isSideAbsoluteWithRightInNorth
```
public boolean isSideAbsoluteWithRightInNorth()
```
    Gets whether or not the preferred side specified by SideOfEdge is interpreted absolute, and on horizontal segments, labels with preferred side LabelPlacements.RIGHT_OF_EDGE are placed above the segment.
    
    Returns:
    
    true if the preferred side is interpreted absolute, false otherwise
    
    See Also:
    
    LabelSideReferences.ABSOLUTE_WITH_RIGHT_IN_NORTH
  - isSideRelativeToEdgeFlow
```
public boolean isSideRelativeToEdgeFlow()
```
    Gets whether or not the preferred side specified by SideOfEdge is interpreted relative to the edge flow.
    
    Returns:
    
    true if the preferred side is interpreted relative to the edge flow, false otherwise
    
    See Also:
    
    LabelSideReferences.RELATIVE_TO_EDGE_FLOW
  - newSharedInstance
```
public static final PreferredPlacementDescriptor newSharedInstance(LabelPlacements placement)
```
    Returns an immutable descriptor instance for the specified placement.
    Descriptor instances returned by this method will use default values for all properties but placement along edge and side of edge.
    
    Parameters:
    
    placement - a combination of valid placements along the edge and valid sides of the edge
    
    Returns:
    
    an immutable descriptor instance for the specified placement
    
    See Also:
    
    isFrozen(), getPlaceAlongEdge(), getSideOfEdge()
  - setAngle
```
public void setAngle(double value)
```
    Sets the angle (in radians) for the label rotation.
    How this angle is applied depends on the angle reference, the rotation and the offset for labels on the right side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    Default Value:
    The default value is 0.
    
    Parameters:
    
    value - the angle in radians
    
    See Also:
    
    setAngleReference(LabelAngleReferences), setAngleRotationOnRightSide(LabelAngleOnRightSideRotations), setAngleOffsetOnRightSide(LabelAngleOnRightSideOffsets), getAngle()
  - setAngleOffsetOnRightSide
```
public void setAngleOffsetOnRightSide(LabelAngleOnRightSideOffsets value)
```
    Sets the angle offset for labels that are placed on the right side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is not valid angle offset
    
    Default Value:
    The default value is LabelAngleOnRightSideOffsets.NONE
    
    Parameters:
    
    value - any combination of valid offsets (0 or 180 degrees)
    
    See Also:
    
    getAngleOffsetOnRightSide()
  - setAngleReference
```
public void setAngleReference(LabelAngleReferences value)
```
    Sets the reference of the angle given by Angle.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is not a valid angle reference
    
    Default Value:
    The default value is LabelAngleReferences.ABSOLUTE
    
    Parameters:
    
    value - any combination of valid angle references
    
    See Also:
    
    getAngleReference()
  - setAngleRotationOnRightSide
```
public void setAngleRotationOnRightSide(LabelAngleOnRightSideRotations value)
```
    Sets how the angle is applied to labels on the right side in respect of the labels of the left side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is not a valid angle rotation
    
    Default Value:
    The default value is LabelAngleOnRightSideRotations.CLOCKWISE
    
    Parameters:
    
    value - any combination of valid rotation directions
    
    See Also:
    
    getAngleRotationOnRightSide()
  - setDistanceToEdge
```
public void setDistanceToEdge(double value)
```
    Sets the preferred distance between a label and the corresponding edge segment.
    If the given distance is < 0, the distance is not fixed, i.e., it is chosen by the automatic labeling algorithm.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified value is infinite or NaN
    
    Default Value:
    The default value is -1.
    
    Parameters:
    
    value - preferred distance between a label and the corresponding edge segment
    
    See Also:
    
    getDistanceToEdge()
  - setPlaceAlongEdge
```
public void setPlaceAlongEdge(LabelPlacements value)
```
    Sets the preferred placement along the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    Placements LabelPlacements.AT_SOURCE_PORT and LabelPlacements.AT_TARGET_PORT that indicate a placement directly at the edge port are currently only supported by HierarchicLayout.
    
    Default Value:
    The default value is LabelPlacements.AT_CENTER
    
    Parameters:
    
    value - one of the valid positions along the edge
    
    See Also:
    
    getPlaceAlongEdge()
  - setSideOfEdge
```
public void setSideOfEdge(LabelPlacements value)
```
    Sets the preferred side of the edge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    Default Value:
    The default value is LabelPlacements.ON_EDGE
    
    Parameters:
    
    value - one of the valid sides of the edge
    
    See Also:
    
    getSideOfEdge()
  - setSideReference
```
public void setSideReference(LabelSideReferences value)
```
    Sets how to interpret the preferred side as given by SideOfEdge.
    
    Throws:
    
    IllegalStateException - if this instance is immutable
    
    IllegalArgumentException - if the specified side reference is invalid
    
    Default Value:
    The default value is LabelSideReferences.RELATIVE_TO_EDGE_FLOW
    
    Parameters:
    
    value - any combination of the valid side references
    
    See Also:
    
    getSideReference()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PreferredPlacementDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PreferredPlacementDescriptor

PreferredPlacementDescriptor

Method Detail

equals

freeze

getAngle

getAngleOffsetOnRightSide

getAngleReference

getAngleRotationOnRightSide

getDistanceToEdge

getPlaceAlongEdge

getSideOfEdge

getSideReference

hashCode

isAngleAbsolute

isAngleOffsetOnRightSide180

isAngleOffsetOnRightSideZero

isAngleOnRightSideCoRotating

isAngleOnRightSideCounterRotating

isAngleRelativeToEdgeFlow

isAtCenter

isAtSource

isAtSourcePort

isAtTarget

isAtTargetPort

isFrozen

isLeftOfEdge

isOnEdge

isRightOfEdge

isSideAbsoluteWithLeftInNorth

isSideAbsoluteWithRightInNorth

isSideRelativeToEdgeFlow

newSharedInstance

setAngle

setAngleOffsetOnRightSide

setAngleReference

setAngleRotationOnRightSide

setDistanceToEdge

setPlaceAlongEdge

setSideOfEdge

setSideReference

toString