Module javafx.controls
Package javafx.scene.control

Class Labeled

  • All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    Direct Known Subclasses:
    ButtonBase, Cell, Label, TitledPane
    @DefaultProperty("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

    • 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

      • 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.

      • 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.

      • 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.

      • 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.
        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​(String value)
        Sets the value of the property ellipsisString.
        Property description:
        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

      • 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.
        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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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

      • 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.

      • 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.

      • 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.

      • 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 List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
        Returns:
        The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
        Since:
        JavaFX 8.0