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

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

```
public class LabelLayoutData
extends Object
```
LabelLayoutData encapsulates layout information for a label.
The information is used by clients to inform label-aware layout algorithms about labeling constraints like label size and preferred placement.

Label-aware algorithms like HierarchicLayout return the calculated label positions by assigning the corresponding box to the provided LabelLayoutData instances.

DataProviders are used for associating an array of LabelLayoutData instances with either the nodes or the edges of a LayoutGraph. The DataProviders must be registered with the input graph using one of the keys defined in LabelLayoutKeys.

Constructor Summary

Constructors
Constructor and Description
`LabelLayoutData(double width, double height)` Creates a new instance of `LabelLayoutData` for a label with the given width and height.
`LabelLayoutData(YOrientedRectangle bounds)` Creates a new instance of `LabelLayoutData` for a label with the given oriented box and preferred placement descriptor.
`LabelLayoutData(YOrientedRectangle bounds, PreferredPlacementDescriptor preferredPlacement)` Creates a new instance of `LabelLayoutData` for a label with the given oriented box and preferred placement descriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`YOrientedRectangle`	`getBounds()` Gets the `oriented box` of the label.
`double`	`getHeight()` Gets the height of the label's bounding box.
`PreferredPlacementDescriptor`	`getPreferredPlacementDescriptor()` Gets the preferred placement of this label.
`double`	`getWidth()` Gets the width of the label's bounding box.
`double`	`getX()` Gets the x-coordinate of the upper-left corner of the label's bounding box.
`double`	`getY()` Gets the y-coordinate of the upper-left corner of the label's bounding box.
`void`	`setBounds(YOrientedRectangle value)` Sets the `oriented box` of the label.
`void`	`setLocation(double x, double y)` Specifies the coordinates of the upper-left corner of the bounding box of the label.
`void`	`setPreferredPlacementDescriptor(PreferredPlacementDescriptor value)` Sets the preferred placement of this label.
`void`	`setSize(double width, double height)` Specifies the width and height of the `oriented box` of this label.
`String`	`toString()` Returns a `String` representation of `LabelLayoutData`.

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

- Constructor Detail
  - LabelLayoutData
```
public LabelLayoutData(double width,
                       double height)
```
    Creates a new instance of LabelLayoutData for a label with the given width and height.
    
    Parameters:
    
    width - the width of the label
    
    height - the height of the label
  - LabelLayoutData
```
public LabelLayoutData(YOrientedRectangle bounds)
```
    Creates a new instance of LabelLayoutData for a label with the given oriented box and preferred placement descriptor.
    
    Throws:
    
    IllegalArgumentException - if the specified descriptor is null
    
    Parameters:
    
    bounds - the box of the label
    
    See Also:
    
    PreferredPlacementDescriptor, setPreferredPlacementDescriptor(PreferredPlacementDescriptor)
  - LabelLayoutData
```
public LabelLayoutData(YOrientedRectangle bounds,
                       PreferredPlacementDescriptor preferredPlacement)
```
    Creates a new instance of LabelLayoutData for a label with the given oriented box and preferred placement descriptor.
    
    Throws:
    
    IllegalArgumentException - if the specified descriptor is null
    
    Parameters:
    
    bounds - the box of the label
    
    preferredPlacement - a preferred placement descriptor
    
    See Also:
    
    PreferredPlacementDescriptor, setPreferredPlacementDescriptor(PreferredPlacementDescriptor)
- Method Detail
  - getBounds
```
public YOrientedRectangle getBounds()
```
    Gets the oriented box of the label.
    
    Returns:
    
    the bounds of the label
    
    See Also:
    
    setBounds(YOrientedRectangle)
  - getHeight
```
public double getHeight()
```
    Gets the height of the label's bounding box.
    
    Returns:
    
    the height of the bounding box of the label
    
    See Also:
    
    YOrientedRectangle.getBoundingBox()
  - getPreferredPlacementDescriptor
```
public PreferredPlacementDescriptor getPreferredPlacementDescriptor()
```
    Gets the preferred placement of this label.
    
    Throws:
    
    IllegalArgumentException - if the specified descriptor is null
    
    Default Value:
    The default value is PreferredPlacementDescriptor. A descriptor that allows all placements LabelPlacements.ANYWHERE
    
    Returns:
    
    the desired placement
    
    See Also:
    
    setPreferredPlacementDescriptor(PreferredPlacementDescriptor)
  - getWidth
```
public double getWidth()
```
    Gets the width of the label's bounding box.
    
    Returns:
    
    the width of the bounding box of the label
    
    See Also:
    
    YOrientedRectangle.getBoundingBox()
  - getX
```
public double getX()
```
    Gets the x-coordinate of the upper-left corner of the label's bounding box.
    
    Returns:
    
    the x-coordinate of the upper-left corner
    
    See Also:
    
    YOrientedRectangle.getBoundingBox()
  - getY
```
public double getY()
```
    Gets the y-coordinate of the upper-left corner of the label's bounding box.
    
    Returns:
    
    the y-coordinate of the upper-left corner
    
    See Also:
    
    YOrientedRectangle.getBoundingBox()
  - setBounds
```
public void setBounds(YOrientedRectangle value)
```
    Sets the oriented box of the label.
    
    Parameters:
    
    value - the bounds of the label
    
    See Also:
    
    getBounds()
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    Specifies the coordinates of the upper-left corner of the bounding box of the label.
    
    Parameters:
    
    x - the new x-coordinate of the upper-left corner
    
    y - the new y-coordinate of the upper-left corner
    
    See Also:
    
    getX(), getY(), YOrientedRectangle.getBoundingBox()
  - setPreferredPlacementDescriptor
```
public void setPreferredPlacementDescriptor(PreferredPlacementDescriptor value)
```
    Sets the preferred placement of this label.
    
    Throws:
    
    IllegalArgumentException - if the specified descriptor is null
    
    Default Value:
    The default value is PreferredPlacementDescriptor. A descriptor that allows all placements LabelPlacements.ANYWHERE
    
    Parameters:
    
    value - the desired placement
    
    See Also:
    
    getPreferredPlacementDescriptor()
  - setSize
```
public void setSize(double width,
                    double height)
```
    Specifies the width and height of the oriented box of this label.
    
    Width and Height in contrast yield the width and height of the paraxial bounding box of the oriented box. Both sizes only coincide in the case the oriented box is not rotated.
    
    Parameters:
    
    width - the width of the oriented box
    
    height - the height of the oriented box
    
    See Also:
    
    setBounds(YOrientedRectangle)
  - toString
```
public String toString()
```
    Returns a String representation of LabelLayoutData.
    The String contains the bounds of the label and the preferred placement
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String representation of LabelLayoutData

Class LabelLayoutData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LabelLayoutData

LabelLayoutData

LabelLayoutData

Method Detail

getBounds

getHeight

getPreferredPlacementDescriptor

getWidth

getX

getY

setBounds

setLocation

setPreferredPlacementDescriptor

setSize

toString