Labeled

java.lang.Object
- Region
- - javafx.scene.control.Control
  - - javafx.scene.control.Labeled

All Implemented Interfaces:

Skinnable

Direct Known Subclasses:

ButtonBase, Cell, Label, TitledPane
```
public abstract class Labeled
extends Control
```
A Labeled Control is one which has as part of its user interface a textual content associated with it. For example, a Button displays text, as does a Label, a Tooltip, and many other controls.
Labeled is also a convenient base class from which to extend when building new Controls which, as part of their UI, display read-only textual content.

Example of how to place a graphic above the text:
```
  Image image = new Image(getClass().getResourceAsStream("image.png"));
  ImageView imageView = new ImageView();
  imageView.setImage(image);
  Label label = new Label("text", imageView);
  label.setContentDisplay(ContentDisplay.TOP);
 
```
Since:

JavaFX 2.0

See Also:

Button, Label, ToggleButton

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`alignment` Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.
`<any>`	`contentDisplay` Specifies the positioning of the graphic relative to the text.
`StringProperty`	`ellipsisString` Specifies the string to display for the ellipsis when text is truncated.
`<any>`	`font` The default font to use for text in the Labeled.
`<any>`	`graphic` An optional icon for the Labeled.
`DoubleProperty`	`graphicTextGap` The amount of space between the graphic and text
`<any>`	`labelPadding` The padding around the Labeled's text and graphic content.
`DoubleProperty`	`lineSpacing` Specifies the space in pixel between lines.
`BooleanProperty`	`mnemonicParsing` MnemonicParsing property to enable/disable text parsing.
`<any>`	`textAlignment` Specifies the behavior for lines of text when text is multiline Unlike `contentDisplayProperty()` which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds.
`<any>`	`textFill` The `Paint` used to fill the text.
`<any>`	`textOverrun` Specifies the behavior to use if the text of the `Labeled` exceeds the available space for rendering the text.
`StringProperty`	`text` The text to display in the label.
`BooleanProperty`	`underline` Whether all text should be underlined.
`BooleanProperty`	`wrapText` If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class Labeled.StyleableProperties

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Labeled.StyleableProperties`

Field Summary

Fields
Modifier and Type	Field and Description
`private <any>`	`alignment`
`private <any>`	`contentDisplay`
`private static java.lang.String`	`DEFAULT_ELLIPSIS_STRING`
`private StringProperty`	`ellipsisString`
`private <any>`	`font`
`private <any>`	`graphic`
`private DoubleProperty`	`graphicTextGap`
`private StyleableStringProperty`	`imageUrl`
`private <any>`	`labelPadding`
`private DoubleProperty`	`lineSpacing`
`private BooleanProperty`	`mnemonicParsing` MnemonicParsing property to enable/disable text parsing.
`private StringProperty`	`text`
`private <any>`	`textAlignment`
`private <any>`	`textFill` The `Paint` used to fill the text.
`private <any>`	`textOverrun`
`private BooleanProperty`	`underline`
`private BooleanProperty`	`wrapText`

Constructor Summary

Constructors
Constructor and Description
`Labeled()` Creates a Label with no text and graphic
`Labeled(java.lang.String text)` Creates a Label with text
`Labeled(java.lang.String text, Node graphic)` Creates a Label with text and a graphic

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`alignmentProperty()` Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.
`<any>`	`contentDisplayProperty()` Specifies the positioning of the graphic relative to the text.
`StringProperty`	`ellipsisStringProperty()` Specifies the string to display for the ellipsis when text is truncated.
`<any>`	`fontProperty()` The default font to use for text in the Labeled.
`Pos`	`getAlignment()` Gets the value of the property alignment.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`Orientation`	`getContentBias()` If wrapText is true, then contentBias will be HORIZONTAL, otherwise it is null.
`ContentDisplay`	`getContentDisplay()` Gets the value of the property contentDisplay.
`java.util.List<<any>>`	`getControlCssMetaData()`
`java.lang.String`	`getEllipsisString()` Gets the value of the property ellipsisString.
`Font`	`getFont()` Gets the value of the property font.
`Node`	`getGraphic()` Gets the value of the property graphic.
`double`	`getGraphicTextGap()` Gets the value of the property graphicTextGap.
`protected Pos`	`getInitialAlignment()` Returns the initial alignment state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
`Insets`	`getLabelPadding()` Gets the value of the property labelPadding.
`double`	`getLineSpacing()` Gets the value of the property lineSpacing.
`java.lang.String`	`getText()` Gets the value of the property text.
`TextAlignment`	`getTextAlignment()` Gets the value of the property textAlignment.
`Paint`	`getTextFill()` Gets the value of the property textFill.
`OverrunStyle`	`getTextOverrun()` Gets the value of the property textOverrun.
`<any>`	`graphicProperty()` An optional icon for the Labeled.
`DoubleProperty`	`graphicTextGapProperty()` The amount of space between the graphic and text
`private StyleableStringProperty`	`imageUrlProperty()` The imageUrl property is set from CSS and then the graphic property is set from the invalidated method.
`boolean`	`isMnemonicParsing()` Gets the value of the property mnemonicParsing.
`boolean`	`isUnderline()` Gets the value of the property underline.
`boolean`	`isWrapText()` Gets the value of the property wrapText.
`<any>`	`labelPaddingProperty()` The padding around the Labeled's text and graphic content.
`private <any>`	`labelPaddingPropertyImpl()`
`DoubleProperty`	`lineSpacingProperty()` Specifies the space in pixel between lines.
`BooleanProperty`	`mnemonicParsingProperty()` MnemonicParsing property to enable/disable text parsing.
`void`	`setAlignment(Pos value)` Sets the value of the property alignment.
`void`	`setContentDisplay(ContentDisplay value)` Sets the value of the property contentDisplay.
`void`	`setEllipsisString(java.lang.String value)` Sets the value of the property ellipsisString.
`void`	`setFont(Font value)` Sets the value of the property font.
`void`	`setGraphic(Node value)` Sets the value of the property graphic.
`void`	`setGraphicTextGap(double value)` Sets the value of the property graphicTextGap.
`private void`	`setLabelPadding(Insets value)`
`void`	`setLineSpacing(double value)` Sets the value of the property lineSpacing.
`void`	`setMnemonicParsing(boolean value)` Sets the value of the property mnemonicParsing.
`void`	`setText(java.lang.String value)` Sets the value of the property text.
`void`	`setTextAlignment(TextAlignment value)` Sets the value of the property textAlignment.
`void`	`setTextFill(Paint value)` Sets the value of the property textFill.
`void`	`setTextOverrun(OverrunStyle value)` Sets the value of the property textOverrun.
`void`	`setUnderline(boolean value)` Sets the value of the property underline.
`void`	`setWrapText(boolean value)` Sets the value of the property wrapText.
`<any>`	`textAlignmentProperty()` Specifies the behavior for lines of text when text is multiline Unlike `contentDisplayProperty()` which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds.
`<any>`	`textFillProperty()` The `Paint` used to fill the text.
`<any>`	`textOverrunProperty()` Specifies the behavior to use if the text of the `Labeled` exceeds the available space for rendering the text.
`StringProperty`	`textProperty()` The text to display in the label.
`java.lang.String`	`toString()`
`BooleanProperty`	`underlineProperty()` Whether all text should be underlined.
`BooleanProperty`	`wrapTextProperty()` If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.

Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, executeAccessibleAction, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

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

Property Detail

text
```
public final StringProperty textProperty
```
The text to display in the label. The text may be null.

See Also:

getText(), setText(String)

alignment
```
public final <any> alignmentProperty
```
Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.

See Also:

getAlignment(), setAlignment(Pos)

textAlignment
```
public final <any> textAlignmentProperty
```
Specifies the behavior for lines of text when text is multiline Unlike contentDisplayProperty() which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds.

See Also:

getTextAlignment(), setTextAlignment(TextAlignment)

textOverrun
```
public final <any> textOverrunProperty
```
Specifies the behavior to use if the text of the Labeled exceeds the available space for rendering the text.

See Also:

getTextOverrun(), setTextOverrun(OverrunStyle)

ellipsisString

public final StringProperty ellipsisStringProperty

Specifies the string to display for the ellipsis when text is truncated.

Ellipsis Table
Examples
"..."	Default value for most locales
" . . . "
" [...] "
"\u2026"	The Unicode ellipsis character '…'
""	No ellipsis, just display the truncated string

Note that not all fonts support all Unicode characters.

Since:: JavaFX 2.2
See Also:: getEllipsisString(), setEllipsisString(String)

wrapText
```
public final BooleanProperty wrapTextProperty
```
If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.

See Also:

isWrapText(), setWrapText(boolean)

font
```
public final <any> fontProperty
```
The default font to use for text in the Labeled. If the Label's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used.

See Also:

getFont(), setFont(Font)

graphic
```
public final <any> graphicProperty
```
An optional icon for the Labeled. This can be positioned relative to the text by using setContentDisplay(javafx.scene.control.ContentDisplay). The node specified for this variable cannot appear elsewhere in the scene graph, otherwise the IllegalArgumentException is thrown. See the class description of Node for more detail.

See Also:

getGraphic(), setGraphic(Node)

underline
```
public final BooleanProperty underlineProperty
```
Whether all text should be underlined.

See Also:

isUnderline(), setUnderline(boolean)

lineSpacing
```
public final DoubleProperty lineSpacingProperty
```
Specifies the space in pixel between lines.

Since:

JavaFX 8.0

See Also:

getLineSpacing(), setLineSpacing(double)

contentDisplay
```
public final <any> contentDisplayProperty
```
Specifies the positioning of the graphic relative to the text.

See Also:

getContentDisplay(), setContentDisplay(ContentDisplay)

labelPadding
```
public final <any> labelPaddingProperty
```
The padding around the Labeled's text and graphic content. By default labelPadding is Insets.EMPTY and cannot be set to null. Subclasses may add nodes outside this padding and inside the Labeled's padding. This property can only be set from CSS.

See Also:

getLabelPadding()

graphicTextGap
```
public final DoubleProperty graphicTextGapProperty
```
The amount of space between the graphic and text

See Also:

getGraphicTextGap(), setGraphicTextGap(double)

textFill
```
public final <any> textFillProperty
```
The Paint used to fill the text.

See Also:

getTextFill(), setTextFill(Paint)

mnemonicParsing
```
public final BooleanProperty mnemonicParsingProperty
```
MnemonicParsing property to enable/disable text parsing. If this is set to true, then the Label text will be parsed to see if it contains the mnemonic parsing character '_'. When a mnemonic is detected the key combination will be determined based on the succeeding character, and the mnemonic added.
The default value for Labeled is false, but it is enabled by default on some Controls.

See Also:

isMnemonicParsing(), setMnemonicParsing(boolean)

Field Detail
- DEFAULT_ELLIPSIS_STRING
```
private static final java.lang.String DEFAULT_ELLIPSIS_STRING
```
  See Also:
  
  Constant Field Values
- text
```
private StringProperty text
```
- alignment
```
private <any> alignment
```
- textAlignment
```
private <any> textAlignment
```
- textOverrun
```
private <any> textOverrun
```
- ellipsisString
```
private StringProperty ellipsisString
```
- wrapText
```
private BooleanProperty wrapText
```
- font
```
private <any> font
```
- graphic
```
private <any> graphic
```
- imageUrl
```
private StyleableStringProperty imageUrl
```
- underline
```
private BooleanProperty underline
```
- lineSpacing
```
private DoubleProperty lineSpacing
```
- contentDisplay
```
private <any> contentDisplay
```
- labelPadding
```
private <any> labelPadding
```
- graphicTextGap
```
private DoubleProperty graphicTextGap
```
- textFill
```
private <any> textFill
```
  The Paint used to fill the text.
- mnemonicParsing
```
private BooleanProperty mnemonicParsing
```
  MnemonicParsing property to enable/disable text parsing. If this is set to true, then the Label text will be parsed to see if it contains the mnemonic parsing character '_'. When a mnemonic is detected the key combination will be determined based on the succeeding character, and the mnemonic added.
  The default value for Labeled is false, but it is enabled by default on some Controls.

Constructor Detail
- Labeled
```
public Labeled()
```
  Creates a Label with no text and graphic
- Labeled
```
public Labeled(java.lang.String text)
```
  Creates a Label with text
  
  Parameters:
  
  text - The text for the label.
- Labeled
```
public Labeled(java.lang.String text,
               Node graphic)
```
  Creates a Label with text and a graphic
  
  Parameters:
  
  text - The text for the label.
  
  graphic - The graphic for the label.

Method Detail

textProperty
```
public final StringProperty textProperty()
```
The text to display in the label. The text may be null.

See Also:

getText(), setText(String)

setText

public final void setText(java.lang.String value)

Sets the value of the property text.

getText
```
public final java.lang.String getText()
```
Gets the value of the property text.

alignmentProperty
```
public final <any> alignmentProperty()
```
Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.

See Also:

getAlignment(), setAlignment(Pos)

setAlignment
```
public final void setAlignment(Pos value)
```
Sets the value of the property alignment.

getAlignment
```
public final Pos getAlignment()
```
Gets the value of the property alignment.

textAlignmentProperty
```
public final <any> textAlignmentProperty()
```
Specifies the behavior for lines of text when text is multiline Unlike contentDisplayProperty() which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds.

See Also:

getTextAlignment(), setTextAlignment(TextAlignment)

setTextAlignment
```
public final void setTextAlignment(TextAlignment value)
```
Sets the value of the property textAlignment.

getTextAlignment
```
public final TextAlignment getTextAlignment()
```
Gets the value of the property textAlignment.

textOverrunProperty
```
public final <any> textOverrunProperty()
```
Specifies the behavior to use if the text of the Labeled exceeds the available space for rendering the text.

See Also:

getTextOverrun(), setTextOverrun(OverrunStyle)

setTextOverrun

public final void setTextOverrun(OverrunStyle value)

Sets the value of the property textOverrun.

getTextOverrun
```
public final OverrunStyle getTextOverrun()
```
Gets the value of the property textOverrun.

ellipsisStringProperty

public final StringProperty ellipsisStringProperty()

Specifies the string to display for the ellipsis when text is truncated.

Ellipsis Table
Examples
"..."	Default value for most locales
" . . . "
" [...] "
"\u2026"	The Unicode ellipsis character '…'
""	No ellipsis, just display the truncated string

Note that not all fonts support all Unicode characters.

Since:: JavaFX 2.2
See Also:: getEllipsisString(), setEllipsisString(String)

setEllipsisString
```
public final void setEllipsisString(java.lang.String value)
```
Sets the value of the property ellipsisString.

Since:

JavaFX 2.2

getEllipsisString
```
public final java.lang.String getEllipsisString()
```
Gets the value of the property ellipsisString.

Since:

JavaFX 2.2

wrapTextProperty
```
public final BooleanProperty wrapTextProperty()
```
If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.

See Also:

isWrapText(), setWrapText(boolean)

setWrapText
```
public final void setWrapText(boolean value)
```
Sets the value of the property wrapText.

isWrapText
```
public final boolean isWrapText()
```
Gets the value of the property wrapText.

getContentBias
```
public Orientation getContentBias()
```
If wrapText is true, then contentBias will be HORIZONTAL, otherwise it is null.

Returns:

orientation of width/height dependency or null if there is none

fontProperty
```
public final <any> fontProperty()
```
The default font to use for text in the Labeled. If the Label's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used.

See Also:

getFont(), setFont(Font)

setFont
```
public final void setFont(Font value)
```
Sets the value of the property font.

getFont
```
public final Font getFont()
```
Gets the value of the property font.

graphicProperty
```
public final <any> graphicProperty()
```
An optional icon for the Labeled. This can be positioned relative to the text by using setContentDisplay(javafx.scene.control.ContentDisplay). The node specified for this variable cannot appear elsewhere in the scene graph, otherwise the IllegalArgumentException is thrown. See the class description of Node for more detail.

See Also:

getGraphic(), setGraphic(Node)

setGraphic
```
public final void setGraphic(Node value)
```
Sets the value of the property graphic.

getGraphic
```
public final Node getGraphic()
```
Gets the value of the property graphic.

imageUrlProperty
```
private StyleableStringProperty imageUrlProperty()
```
The imageUrl property is set from CSS and then the graphic property is set from the invalidated method. This ensures that the same image isn't reloaded.

underlineProperty
```
public final BooleanProperty underlineProperty()
```
Whether all text should be underlined.

See Also:

isUnderline(), setUnderline(boolean)

setUnderline
```
public final void setUnderline(boolean value)
```
Sets the value of the property underline.

isUnderline
```
public final boolean isUnderline()
```
Gets the value of the property underline.

lineSpacingProperty
```
public final DoubleProperty lineSpacingProperty()
```
Specifies the space in pixel between lines.

Since:

JavaFX 8.0

See Also:

getLineSpacing(), setLineSpacing(double)

setLineSpacing
```
public final void setLineSpacing(double value)
```
Sets the value of the property lineSpacing.

Since:

JavaFX 8.0

getLineSpacing
```
public final double getLineSpacing()
```
Gets the value of the property lineSpacing.

Since:

JavaFX 8.0

contentDisplayProperty
```
public final <any> contentDisplayProperty()
```
Specifies the positioning of the graphic relative to the text.

See Also:

getContentDisplay(), setContentDisplay(ContentDisplay)

setContentDisplay
```
public final void setContentDisplay(ContentDisplay value)
```
Sets the value of the property contentDisplay.

getContentDisplay
```
public final ContentDisplay getContentDisplay()
```
Gets the value of the property contentDisplay.

labelPaddingProperty
```
public final <any> labelPaddingProperty()
```
The padding around the Labeled's text and graphic content. By default labelPadding is Insets.EMPTY and cannot be set to null. Subclasses may add nodes outside this padding and inside the Labeled's padding. This property can only be set from CSS.

See Also:

getLabelPadding()

labelPaddingPropertyImpl

private <any> labelPaddingPropertyImpl()

setLabelPadding

private void setLabelPadding(Insets value)

getLabelPadding
```
public final Insets getLabelPadding()
```
Gets the value of the property labelPadding.

graphicTextGapProperty
```
public final DoubleProperty graphicTextGapProperty()
```
The amount of space between the graphic and text

See Also:

getGraphicTextGap(), setGraphicTextGap(double)

setGraphicTextGap
```
public final void setGraphicTextGap(double value)
```
Sets the value of the property graphicTextGap.

getGraphicTextGap
```
public final double getGraphicTextGap()
```
Gets the value of the property graphicTextGap.

setTextFill
```
public final void setTextFill(Paint value)
```
Sets the value of the property textFill.

getTextFill
```
public final Paint getTextFill()
```
Gets the value of the property textFill.

textFillProperty
```
public final <any> textFillProperty()
```
The Paint used to fill the text.

See Also:

getTextFill(), setTextFill(Paint)

setMnemonicParsing
```
public final void setMnemonicParsing(boolean value)
```
Sets the value of the property mnemonicParsing.

isMnemonicParsing
```
public final boolean isMnemonicParsing()
```
Gets the value of the property mnemonicParsing.

mnemonicParsingProperty
```
public final BooleanProperty mnemonicParsingProperty()
```
MnemonicParsing property to enable/disable text parsing. If this is set to true, then the Label text will be parsed to see if it contains the mnemonic parsing character '_'. When a mnemonic is detected the key combination will be determined based on the succeeding character, and the mnemonic added.
The default value for Labeled is false, but it is enabled by default on some Controls.

See Also:

isMnemonicParsing(), setMnemonicParsing(boolean)

toString
```
public java.lang.String toString()
```

getInitialAlignment
```
protected Pos getInitialAlignment()
```
Returns the initial alignment state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden to use Pos.CENTER_LEFT initially.

Returns:

the initial alignment state of this control

Since:

9

getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Since:

JavaFX 8.0

getControlCssMetaData
```
public java.util.List<<any>> getControlCssMetaData()
```
Overrides:

getControlCssMetaData in class Control

Returns:

unmodifiable list of the controls css styleable properties

Since:

JavaFX 8.0

Class Labeled

Property Summary

Properties inherited from class javafx.scene.control.Control

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.Control

Methods inherited from class java.lang.Object

Property Detail

text

alignment

textAlignment

textOverrun

ellipsisString

wrapText

font

graphic

underline

lineSpacing

contentDisplay

labelPadding

graphicTextGap

textFill

mnemonicParsing

Field Detail

DEFAULT_ELLIPSIS_STRING

text

alignment

textAlignment

textOverrun

ellipsisString

wrapText

font

graphic

imageUrl

underline

lineSpacing

contentDisplay

labelPadding

graphicTextGap

textFill

mnemonicParsing

Constructor Detail

Labeled

Labeled

Labeled

Method Detail

textProperty

setText

getText

alignmentProperty

setAlignment

getAlignment

textAlignmentProperty

setTextAlignment

getTextAlignment

textOverrunProperty

setTextOverrun

getTextOverrun

ellipsisStringProperty

setEllipsisString

getEllipsisString

wrapTextProperty

setWrapText

isWrapText

getContentBias

fontProperty

setFont

getFont

graphicProperty

setGraphic

getGraphic

imageUrlProperty

underlineProperty

setUnderline

isUnderline

lineSpacingProperty

setLineSpacing

getLineSpacing