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

java.lang.Object
- com.yworks.yfiles.graph.styles.DefaultLabelStyle

All Implemented Interfaces:

ILabelStyle, ICloneable, Cloneable
```
public class DefaultLabelStyle
extends Object
implements ILabelStyle, Cloneable
```
A basic label style which renders the label's Text and optionally a background and border.

Constructor Summary

Constructors
Constructor and Description
`DefaultLabelStyle()` Creates a new instance using `DefaultLabelStyleRenderer` as renderer.
`DefaultLabelStyle(DefaultLabelStyleRenderer renderer)` Creates a new instance using the provided renderer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultLabelStyle`	`clone()` Creates a copy of this object and returns it.
`Paint`	`getBackgroundPaint()` Gets the brush to use for the background box of the label.
`Pen`	`getBackgroundPen()` Gets the pen to use for the background box of the label.
`NodeOrientation`	`getFlowDirection()` Gets the flow direction.
`Font`	`getFont()` Gets the typeface to use for the label.
`FontSmoothingType`	`getFontSmoothingType()` Returns the smoothing type for the Font that is used for the text.
`InsetsD`	`getInsets()` Gets the insets for this label.
`double`	`getLineSpacing()` Returns the value for the lineSpacing property of the JavaFX text.
`DefaultLabelStyleRenderer`	`getRenderer()` Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given label and this style instance.
`TextAlignment`	`getTextAlignment()` Gets the text alignment.
`Paint`	`getTextPaint()` Gets the brush to use for the label's text.
`TextWrapping`	`getTextWrapping()` Gets the text wrapping mode.
`VPos`	`getVerticalTextAlignment()` Gets the vertical text alignment to use if the label is assigned more space than needed.
`boolean`	`isAutoFlippingEnabled()` Gets a value indicating whether the label should be flipped 180 degrees automatically, if it would be oriented downwards, otherwise.
`boolean`	`isStrikethrough()` Indicates whether or not each line of text should have a line through it.
`boolean`	`isTextClippingEnabled()` Gets a value that determines whether text should be clipped.
`boolean`	`isUnderline()` Indicates whether or not the text is underlined.
`void`	`setAutoFlippingEnabled(boolean value)` Sets a value indicating whether the label should be flipped 180 degrees automatically, if it would be oriented downwards, otherwise.
`void`	`setBackgroundPaint(Paint value)` Sets the brush to use for the background box of the label.
`void`	`setBackgroundPen(Pen value)` Sets the pen to use for the background box of the label.
`void`	`setFlowDirection(NodeOrientation value)` Sets the flow direction.
`void`	`setFont(Font value)` Sets the typeface to use for the label.
`void`	`setFontSmoothingType(FontSmoothingType fontSmoothingType)` Sets he smoothing type for the Font that to use for the text.
`void`	`setInsets(InsetsD insets)` Sets the insets for this label.
`void`	`setLineSpacing(double lineSpacing)` Sets the value for the lineSpacing property of the JavaFX text.
`void`	`setStrikethrough(boolean strikethrough)` Sets whether or not each line of text should have a line through it.
`void`	`setTextAlignment(TextAlignment value)` Sets the text alignment.
`void`	`setTextClippingEnabled(boolean value)` Sets a value that determines whether text should be clipped.
`void`	`setTextPaint(Paint value)` Sets the brush to use for the label's text.
`void`	`setTextWrapping(TextWrapping value)` Sets the text wrapping mode.
`void`	`setUnderline(boolean underline)` Sets whether or not the text is underlined.
`void`	`setVerticalTextAlignment(VPos value)` Sets the vertical text alignment to use if the label is assigned more space than needed.

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

- Constructor Detail
  - DefaultLabelStyle
```
public DefaultLabelStyle()
```
    Creates a new instance using DefaultLabelStyleRenderer as renderer.
  - DefaultLabelStyle
```
public DefaultLabelStyle(DefaultLabelStyleRenderer renderer)
```
    Creates a new instance using the provided renderer.
    
    Parameters:
    
    renderer - The custom renderer for this style instance.
- Method Detail
  - clone
```
public DefaultLabelStyle clone()
```
    Description copied from interface: ICloneable
    
    Creates a copy of this object and returns it.
    
    Specified by:
    
    clone in interface ICloneable
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A copy of this object.
    
    See Also:
    
    Object.clone()
  - getBackgroundPaint
```
public final Paint getBackgroundPaint()
```
    Gets the brush to use for the background box of the label.
    The default value is null.
    
    Returns:
    
    The background brush or null.
    
    See Also:
    
    setBackgroundPaint(Paint)
  - getBackgroundPen
```
public final Pen getBackgroundPen()
```
    Gets the pen to use for the background box of the label.
    The default value is null.
    
    Returns:
    
    The background pen or null.
    
    See Also:
    
    setBackgroundPen(Pen)
  - getFlowDirection
```
public final NodeOrientation getFlowDirection()
```
    Gets the flow direction.
    The default is NodeOrientation.LEFT_TO_RIGHT.
    
    Returns:
    
    The flow direction.
    
    See Also:
    
    setFlowDirection(NodeOrientation)
  - getFont
```
public final Font getFont()
```
    Gets the typeface to use for the label.
    The default value is an instance of Font for Arial".
    
    Throws:
    
    IllegalArgumentException - value cannot be null!
    
    Returns:
    
    The typeface.
    
    See Also:
    
    setFont(Font)
  - getFontSmoothingType
```
public FontSmoothingType getFontSmoothingType()
```
    Returns the smoothing type for the Font that is used for the text.
    The default value is FontSmoothingType.GRAY
  - getInsets
```
public InsetsD getInsets()
```
    Gets the insets for this label. The insets define the distance between the label border and the label content. The default value is an instance of InsetsD with uniform value 2.
    
    Returns:
    
    the InsetsD for this label.
  - getLineSpacing
```
public double getLineSpacing()
```
    Returns the value for the lineSpacing property of the JavaFX text.
    The default value is 0.
  - getRenderer
```
public final DefaultLabelStyleRenderer getRenderer()
```
    Description copied from interface: ILabelStyle
    
    Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given label and this style instance.
    The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:
    
    Specified by:
    
    getRenderer in interface ILabelStyle
    
    Returns:
    
    The Renderer.
  - getTextAlignment
```
public final TextAlignment getTextAlignment()
```
    Gets the text alignment.
    The default value is TextAlignment.LEFT.
    
    Returns:
    
    The text decorations.
    
    See Also:
    
    setTextAlignment(TextAlignment)
  - getTextPaint
```
public final Paint getTextPaint()
```
    Gets the brush to use for the label's text.
    The default value is Color.BLACK.
    
    Throws:
    
    IllegalArgumentException - value cannot be null!
    
    Returns:
    
    The font brush or null.
    
    See Also:
    
    setTextPaint(Paint)
  - getTextWrapping
```
public final TextWrapping getTextWrapping()
```
    Gets the text wrapping mode.
    The default is TextWrapping.WRAP.
    
    Returns:
    
    The text wrapping mode.
    
    See Also:
    
    setTextWrapping(TextWrapping)
  - getVerticalTextAlignment
```
public final VPos getVerticalTextAlignment()
```
    Gets the vertical text alignment to use if the label is assigned more space than needed.
    The default value is VPos.TOP.
    
    Returns:
    
    The vertical text alignment.
    
    See Also:
    
    setVerticalTextAlignment(VPos)
  - isAutoFlippingEnabled
```
public final boolean isAutoFlippingEnabled()
```
    Gets a value indicating whether the label should be flipped 180 degrees automatically, if it would be oriented downwards, otherwise.
    The default value is true.
    
    Returns:
    
    true if the label should be flipped automatically otherwise, false.
    
    See Also:
    
    setAutoFlippingEnabled(boolean)
  - isStrikethrough
```
public boolean isStrikethrough()
```
    Indicates whether or not each line of text should have a line through it.
    The default value is false
  - isTextClippingEnabled
```
public final boolean isTextClippingEnabled()
```
    Gets a value that determines whether text should be clipped.
    The default value is true.
    
    Returns:
    
    The TextClippingEnabled.
    
    See Also:
    
    setTextClippingEnabled(boolean)
  - isUnderline
```
public boolean isUnderline()
```
    Indicates whether or not the text is underlined.
    The default value is false
  - setAutoFlippingEnabled
```
public final void setAutoFlippingEnabled(boolean value)
```
    Sets a value indicating whether the label should be flipped 180 degrees automatically, if it would be oriented downwards, otherwise.
    The default value is true.
    
    Parameters:
    
    value - true if the label should be flipped automatically otherwise, false.
    
    See Also:
    
    isAutoFlippingEnabled()
  - setBackgroundPaint
```
public final void setBackgroundPaint(Paint value)
```
    Sets the brush to use for the background box of the label.
    The default value is null.
    
    Parameters:
    
    value - The background brush or null.
    
    See Also:
    
    getBackgroundPaint()
  - setBackgroundPen
```
public final void setBackgroundPen(Pen value)
```
    Sets the pen to use for the background box of the label.
    The default value is null.
    
    Parameters:
    
    value - The background pen or null.
    
    See Also:
    
    getBackgroundPen()
  - setFlowDirection
```
public final void setFlowDirection(NodeOrientation value)
```
    Sets the flow direction.
    The default is NodeOrientation.LEFT_TO_RIGHT.
    
    Parameters:
    
    value - The flow direction.
    
    See Also:
    
    getFlowDirection()
  - setFont
```
public final void setFont(Font value)
```
    Sets the typeface to use for the label.
    The default value is an instance of Font for Arial".
    
    Throws:
    
    IllegalArgumentException - value cannot be null!
    
    Parameters:
    
    value - The typeface.
    
    See Also:
    
    getFont()
  - setFontSmoothingType
```
public void setFontSmoothingType(FontSmoothingType fontSmoothingType)
```
    Sets he smoothing type for the Font that to use for the text.
    
    Parameters:
    
    fontSmoothingType - The JavaFX FontSmoothingType to set.
  - setInsets
```
public void setInsets(InsetsD insets)
```
    Sets the insets for this label. The insets define the distance between the label border and the label content. The default value is an instance of InsetsD with uniform value 2.
  - setLineSpacing
```
public void setLineSpacing(double lineSpacing)
```
    Sets the value for the lineSpacing property of the JavaFX text.
    The default value is 0.
  - setStrikethrough
```
public void setStrikethrough(boolean strikethrough)
```
    Sets whether or not each line of text should have a line through it.
  - setTextAlignment
```
public final void setTextAlignment(TextAlignment value)
```
    Sets the text alignment.
    The default value is TextAlignment.LEFT.
    
    Parameters:
    
    value - The text decorations.
    
    See Also:
    
    getTextAlignment()
  - setTextClippingEnabled
```
public final void setTextClippingEnabled(boolean value)
```
    Sets a value that determines whether text should be clipped.
    The default value is true.
    
    Parameters:
    
    value - The TextClippingEnabled to set.
    
    See Also:
    
    isTextClippingEnabled()
  - setTextPaint
```
public final void setTextPaint(Paint value)
```
    Sets the brush to use for the label's text.
    The default value is Color.BLACK.
    
    Throws:
    
    IllegalArgumentException - value cannot be null!
    
    Parameters:
    
    value - The font brush or null.
    
    See Also:
    
    getTextPaint()
  - setTextWrapping
```
public final void setTextWrapping(TextWrapping value)
```
    Sets the text wrapping mode.
    The default is TextWrapping.WRAP.
    
    Parameters:
    
    value - The text wrapping mode.
    
    See Also:
    
    getTextWrapping()
  - setUnderline
```
public void setUnderline(boolean underline)
```
    Sets whether or not the text is underlined.
  - setVerticalTextAlignment
```
public final void setVerticalTextAlignment(VPos value)
```
    Sets the vertical text alignment to use if the label is assigned more space than needed.
    The default value is VPos.TOP.
    
    Parameters:
    
    value - The vertical text alignment.
    
    See Also:
    
    getVerticalTextAlignment()

Class DefaultLabelStyle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultLabelStyle

DefaultLabelStyle

Method Detail

clone

getBackgroundPaint

getBackgroundPen

getFlowDirection

getFont

getFontSmoothingType

getInsets

getLineSpacing

getRenderer

getTextAlignment

getTextPaint

getTextWrapping

getVerticalTextAlignment

isAutoFlippingEnabled

isStrikethrough

isTextClippingEnabled

isUnderline

setAutoFlippingEnabled

setBackgroundPaint

setBackgroundPen

setFlowDirection

setFont

setFontSmoothingType

setInsets

setLineSpacing

setStrikethrough

setTextAlignment

setTextClippingEnabled

setTextPaint

setTextWrapping

setUnderline

setVerticalTextAlignment