javafx.scene.control

Class Labeled

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

Direct Known Subclasses:

ButtonBase, Cell, Label, TitledPane

@DefaultProperty(value="text")
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

Type	Property and Description
ObjectProperty<Pos>	alignment Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.
ObjectProperty<ContentDisplay>	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.
ObjectProperty<Font>	font The default font to use for text in the Labeled.
ObjectProperty<Node>	graphic An optional icon for the Labeled.
DoubleProperty	graphicTextGap The amount of space between the graphic and text
ReadOnlyObjectProperty<Insets>	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.
ObjectProperty<TextAlignment>	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.
ObjectProperty<Paint>	textFill The Paint used to fill the text.
ObjectProperty<OverrunStyle>	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

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
Labeled() Creates a Label with no text and graphic
Labeled(String text) Creates a Label with text
Labeled(String text, Node graphic) Creates a Label with text and a graphic

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Pos>	alignmentProperty() Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.
ObjectProperty<ContentDisplay>	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.
ObjectProperty<Font>	fontProperty() The default font to use for text in the Labeled.
Pos	getAlignment() Gets the value of the property alignment.
static List<CssMetaData<? extends Styleable,?>>	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.
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
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.
Insets	getLabelPadding() Gets the value of the property labelPadding.
double	getLineSpacing() Gets the value of the property lineSpacing.
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.
ObjectProperty<Node>	graphicProperty() An optional icon for the Labeled.
DoubleProperty	graphicTextGapProperty() The amount of space between the graphic and text
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.
ReadOnlyObjectProperty<Insets>	labelPaddingProperty() The padding around the Labeled's text and graphic content.
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(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.
void	setLineSpacing(double value) Sets the value of the property lineSpacing.
void	setMnemonicParsing(boolean value) Sets the value of the property mnemonicParsing.
void	setText(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.
ObjectProperty<TextAlignment>	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.
ObjectProperty<Paint>	textFillProperty() The Paint used to fill the text.
ObjectProperty<OverrunStyle>	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.
String	toString() Returns a string representation for the object.
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, getCssMetaData, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

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 ObjectProperty<Pos> 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 ObjectProperty<TextAlignment> 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 ObjectProperty<OverrunStyle> 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.

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 ObjectProperty<Font> 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 ObjectProperty<Node> 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 ObjectProperty<ContentDisplay> contentDisplayProperty

Specifies the positioning of the graphic relative to the text.

See Also:

getContentDisplay(), setContentDisplay(ContentDisplay)

labelPadding

public final ReadOnlyObjectProperty<Insets> 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 ObjectProperty<Paint> 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)

Constructor Detail

Labeled

public Labeled()

Creates a Label with no text and graphic

Labeled

public Labeled(String text)

Creates a Label with text

Parameters:

text - The text for the label.

Labeled

public Labeled(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(String value)

Sets the value of the property text.

Property description:

The text to display in the label. The text may be null.

getText

public final String getText()

Gets the value of the property text.

Property description:

The text to display in the label. The text may be null.

alignmentProperty

public final ObjectProperty<Pos> 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.

Property description:

Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.

getAlignment

public final Pos getAlignment()

Gets the value of the property alignment.

Property description:

Specifies how the text and graphic within the Labeled should be aligned when there is empty space within the Labeled.

textAlignmentProperty

public final ObjectProperty<TextAlignment> 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.

Property description:

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.

getTextAlignment

public final TextAlignment getTextAlignment()

Gets the value of the property textAlignment.

Property description:

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.

textOverrunProperty

public final ObjectProperty<OverrunStyle> 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.

Property description:

Specifies the behavior to use if the text of the Labeled exceeds the available space for rendering the text.

getTextOverrun

public final OverrunStyle getTextOverrun()

Gets the value of the property textOverrun.

Property description:

Specifies the behavior to use if the text of the Labeled exceeds the available space for rendering the text.

ellipsisStringProperty

public final StringProperty ellipsisStringProperty()

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

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(String value)

Sets the value of the property ellipsisString.

Property description:

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

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

getEllipsisString

public final String getEllipsisString()

Gets the value of the property ellipsisString.

Property description:

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

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

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.

Property description:

If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.

isWrapText

public final boolean isWrapText()

Gets the value of the property wrapText.

Property description:

If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.

getContentBias

public Orientation getContentBias()

If wrapText is true, then contentBias will be HORIZONTAL, otherwise it is null.

Overrides:

getContentBias in class Node

Returns:

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

See Also:

Node.isResizable(), Node.minWidth(double), Node.minHeight(double), Node.prefWidth(double), Node.prefHeight(double), Node.maxWidth(double), Node.maxHeight(double)

fontProperty

public final ObjectProperty<Font> 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.

Property description:

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.

getFont

public final Font getFont()

Gets the value of the property font.

Property description:

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.

graphicProperty

public final ObjectProperty<Node> 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.

Property description:

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.

getGraphic

public final Node getGraphic()

Gets the value of the property graphic.

Property description:

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.

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.

Property description:

Whether all text should be underlined.

isUnderline

public final boolean isUnderline()

Gets the value of the property underline.

Property description:

Whether all text should be underlined.

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.

Property description:

Specifies the space in pixel between lines.

Since:

JavaFX 8.0

getLineSpacing

public final double getLineSpacing()

Gets the value of the property lineSpacing.

Property description:

Specifies the space in pixel between lines.

Since:

JavaFX 8.0

contentDisplayProperty

public final ObjectProperty<ContentDisplay> 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.

Property description:

Specifies the positioning of the graphic relative to the text.

getContentDisplay

public final ContentDisplay getContentDisplay()

Gets the value of the property contentDisplay.

Property description:

Specifies the positioning of the graphic relative to the text.

labelPaddingProperty

public final ReadOnlyObjectProperty<Insets> 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()

getLabelPadding

public final Insets getLabelPadding()

Gets the value of the property labelPadding.

Property description:

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.

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.

Property description:

The amount of space between the graphic and text

getGraphicTextGap

public final double getGraphicTextGap()

Gets the value of the property graphicTextGap.

Property description:

The amount of space between the graphic and text

setTextFill

public final void setTextFill(Paint value)

Sets the value of the property textFill.

Property description:

The Paint used to fill the text.

getTextFill

public final Paint getTextFill()

Gets the value of the property textFill.

Property description:

The Paint used to fill the text.

textFillProperty

public final ObjectProperty<Paint> 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.

Property description:

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.

isMnemonicParsing

public final boolean isMnemonicParsing()

Gets the value of the property mnemonicParsing.

Property description:

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.

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 String toString()

Description copied from class: Node

Returns a string representation for the object.

Overrides:

toString in class Node

Returns:

a string representation for the object.

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

Returns:

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

Since:

JavaFX 8.0

getControlCssMetaData

public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Control

Returns:

unmodifiable list of the controls css styleable properties

Since:

JavaFX 8.0