モジュール javafx.controls
パッケージ javafx.scene.control

クラスLabeled

  • すべての実装されたインタフェース:
    Styleable, EventTarget, Skinnable
    直系の既知のサブクラス:
    ButtonBase, Cell, Label, TitledPane

    @DefaultProperty("text")
public abstract class Labeled
extends Control
    ラベル付けされたControlは、ユーザー・インタフェースの一部として関連付けられたテキスト・コンテンツを持ちます。 たとえば、ButtonにはLabelやTooltipなどその他の多くのコントロールと同様に、textが表示されます。

    また、Labeledは便利なベース・クラスでもあり、読取り専用のテキスト・コンテンツがUIの一部として表示される新しいコントロールを構築するときに、このクラスをベースに拡張できます。

    テキストの上にグラフィックを配置する方法の例を次に示します。 

    
  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);
    導入されたバージョン:
    JavaFX 2.0
    関連項目:
    Button、Label、ToggleButton

    • プロパティの詳細

      • 位置合せ

        public final ObjectProperty<Pos> alignmentProperty
        ラベル表示内に空きスペースがある場合の、ラベル表示内のテキストとグラフィックを位置合せする方法を指定します。
        関連項目:
        getAlignment()、setAlignment(Pos)

      • ellipsisString

        public final StringProperty ellipsisStringProperty
        テキストが切り捨てられた場合に楕円に表示する文字列を指定します。
        省略記号表
        例
        "..." ほとんどのロケールのデフォルト値
        " . . . "
        " [...] "
        "\u2026" Unicodeの省略記号'…'
        "" 省略記号はなく、切り捨てられた文字列を表示するだけです

        フォントによっては、必ずしもすべてのUnicode文字がサポートされないことに注意してください。

        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        getEllipsisString()、setEllipsisString(String)

      • wrapText

        public final BooleanProperty wrapTextProperty
        テキストの長さがラベル表示の幅を超える場合に、テキストを別の行に折り返すかどうかをこの変数で示します。
        関連項目:
        isWrapText()、setWrapText(boolean)

      • font

        public final ObjectProperty<Font> fontProperty
        ラベル表示内のテキストに使用するデフォルト・フォント。 ラベルのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。
        関連項目:
        getFont()、setFont(Font)

      • graphic

        public final ObjectProperty<Node> graphicProperty
        ラベル表示のオプション・アイコン。 これは、setContentDisplay(javafx.scene.control.ContentDisplay)を使用して、テキストに対して相対的に配置できます。 この変数用に指定されているノードは、シーングラフのどこにも使用できません。使用した場合、IllegalArgumentExceptionがスローされます。 詳細は、Nodeのクラスの説明を参照してください。
        関連項目:
        getGraphic()、setGraphic(Node)

      • labelPadding

        public final ReadOnlyObjectProperty<Insets> labelPaddingProperty
        ラベル表示のテキストおよびグラフィックのコンテンツ周辺の余白。 labelPaddingはデフォルトではInsets.EMPTYで、nullに設定することはできません。 サブクラスによって、この余白の外側とLabeledの余白の内側にノードが追加される場合があります。 このプロパティは、CSSからのみ設定できます。
        関連項目:
        getLabelPadding()

      • mnemonicParsing

        public final BooleanProperty mnemonicParsingProperty
        テキストの解析を有効/無効にするMnemonicParsingプロパティ。 これがtrueに設定されている場合、Labelのテキストが解析され、テキストにニーモニック解析文字「_」が含まれているかどうかが確認されます。 ニーモニックが検出されると、キーの組合せが後続の文字に基づいて決定され、ニーモニックが追加されます。

        Labeledのデフォルト値はfalseですが、一部のコントロールではデフォルトで有効になっています。

        関連項目:
        isMnemonicParsing()、setMnemonicParsing(boolean)

    • コンストラクタの詳細

      • Labeled

        public Labeled​()
        テキストとグラフィックなしでラベルを作成します。

      • Labeled

        public Labeled​(String text)
        テキスト付きでラベルを作成します。
        パラメータ:
        text - ラベルのテキスト。

      • Labeled

        public Labeled​(String text,
               Node graphic)
        テキストとグラフィック付きでラベルを作成します。
        パラメータ:
        text - ラベルのテキスト。
        graphic - ラベルのグラフィック。

    • メソッドの詳細

      • textProperty

        public final StringProperty textProperty​()
        ラベルに表示するテキスト。 テキストはnullになる場合があります。
        関連項目:
        getText()、setText(String)

      • setText

        public final void setText​(String value)
        プロパティtextの値を設定します。
        プロパティの説明:
        ラベルに表示するテキスト。 テキストはnullになる場合があります。

      • getText

        public final String getText​()
        プロパティtextの値を取得します。
        プロパティの説明:
        ラベルに表示するテキスト。 テキストはnullになる場合があります。

      • alignmentProperty

        public final ObjectProperty<Pos> alignmentProperty​()
        ラベル表示内に空きスペースがある場合の、ラベル表示内のテキストとグラフィックを位置合せする方法を指定します。
        関連項目:
        getAlignment()、setAlignment(Pos)

      • setAlignment

        public final void setAlignment​(Pos value)
        プロパティalignmentの値を設定します。
        プロパティの説明:
        ラベル表示内に空きスペースがある場合の、ラベル表示内のテキストとグラフィックを位置合せする方法を指定します。

      • getAlignment

        public final Pos getAlignment​()
        プロパティalignmentの値を取得します。
        プロパティの説明:
        ラベル表示内に空きスペースがある場合の、ラベル表示内のテキストとグラフィックを位置合せする方法を指定します。

      • setTextAlignment

        public final void setTextAlignment​(TextAlignment value)
        プロパティtextAlignmentの値を設定します。
        プロパティの説明:
        テキストが複数行の場合のテキストの行の動作を指定します。グラフィックとテキストに作用するcontentDisplayProperty()とは異なり、この設定は複数行のテキストのみに、テキスト境界に対して相対的に作用します。

      • getTextAlignment

        public final TextAlignment getTextAlignment​()
        プロパティtextAlignmentの値を取得します。
        プロパティの説明:
        テキストが複数行の場合のテキストの行の動作を指定します。グラフィックとテキストに作用するcontentDisplayProperty()とは異なり、この設定は複数行のテキストのみに、テキスト境界に対して相対的に作用します。

      • setTextOverrun

        public final void setTextOverrun​(OverrunStyle value)
        プロパティtextOverrunの値を設定します。
        プロパティの説明:
        Labeledのテキストが、テキストのレンダリングに使用できるスペースを超過した場合に使用する動作を指定します。

      • getTextOverrun

        public final OverrunStyle getTextOverrun​()
        プロパティtextOverrunの値を取得します。
        プロパティの説明:
        Labeledのテキストが、テキストのレンダリングに使用できるスペースを超過した場合に使用する動作を指定します。

      • ellipsisStringProperty

        public final StringProperty ellipsisStringProperty​()
        テキストが切り捨てられた場合に楕円に表示する文字列を指定します。
        省略記号表
        例
        "..." ほとんどのロケールのデフォルト値
        " . . . "
        " [...] "
        "\u2026" Unicodeの省略記号'…'
        "" 省略記号はなく、切り捨てられた文字列を表示するだけです

        フォントによっては、必ずしもすべてのUnicode文字がサポートされないことに注意してください。

        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        getEllipsisString()、setEllipsisString(String)

      • setEllipsisString

        public final void setEllipsisString​(String value)
        プロパティellipsisStringの値を設定します。
        プロパティの説明:
        テキストが切り捨てられた場合に楕円に表示する文字列を指定します。
        省略記号表
        例
        "..." ほとんどのロケールのデフォルト値
        " . . . "
        " [...] "
        "\u2026" Unicodeの省略記号'…'
        "" 省略記号はなく、切り捨てられた文字列を表示するだけです

        フォントによっては、必ずしもすべてのUnicode文字がサポートされないことに注意してください。

        導入されたバージョン:
        JavaFX 2.2

      • getEllipsisString

        public final String getEllipsisString​()
        プロパティellipsisStringの値を取得します。
        プロパティの説明:
        テキストが切り捨てられた場合に楕円に表示する文字列を指定します。
        省略記号表
        例
        "..." ほとんどのロケールのデフォルト値
        " . . . "
        " [...] "
        "\u2026" Unicodeの省略記号'…'
        "" 省略記号はなく、切り捨てられた文字列を表示するだけです

        フォントによっては、必ずしもすべてのUnicode文字がサポートされないことに注意してください。

        導入されたバージョン:
        JavaFX 2.2

      • wrapTextProperty

        public final BooleanProperty wrapTextProperty​()
        テキストの長さがラベル表示の幅を超える場合に、テキストを別の行に折り返すかどうかをこの変数で示します。
        関連項目:
        isWrapText()、setWrapText(boolean)

      • setWrapText

        public final void setWrapText​(boolean value)
        プロパティwrapTextの値を設定します。
        プロパティの説明:
        テキストの長さがラベル表示の幅を超える場合に、テキストを別の行に折り返すかどうかをこの変数で示します。

      • isWrapText

        public final boolean isWrapText​()
        プロパティwrapTextの値を取得します。
        プロパティの説明:
        テキストの長さがラベル表示の幅を超える場合に、テキストを別の行に折り返すかどうかをこの変数で示します。

      • fontProperty

        public final ObjectProperty<Font> fontProperty​()
        ラベル表示内のテキストに使用するデフォルト・フォント。 ラベルのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。
        関連項目:
        getFont()、setFont(Font)

      • setFont

        public final void setFont​(Font value)
        プロパティfontの値を設定します。
        プロパティの説明:
        ラベル表示内のテキストに使用するデフォルト・フォント。 ラベルのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。

      • getFont

        public final Font getFont​()
        プロパティfontの値を取得します。
        プロパティの説明:
        ラベル表示内のテキストに使用するデフォルト・フォント。 ラベルのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。

      • graphicProperty

        public final ObjectProperty<Node> graphicProperty​()
        ラベル表示のオプション・アイコン。 これは、setContentDisplay(javafx.scene.control.ContentDisplay)を使用して、テキストに対して相対的に配置できます。 この変数用に指定されているノードは、シーングラフのどこにも使用できません。使用した場合、IllegalArgumentExceptionがスローされます。 詳細は、Nodeのクラスの説明を参照してください。
        関連項目:
        getGraphic()、setGraphic(Node)

      • setGraphic

        public final void setGraphic​(Node value)
        プロパティgraphicの値を設定します。
        プロパティの説明:
        ラベル表示のオプション・アイコン。 これは、setContentDisplay(javafx.scene.control.ContentDisplay)を使用して、テキストに対して相対的に配置できます。 この変数用に指定されているノードは、シーングラフのどこにも使用できません。使用した場合、IllegalArgumentExceptionがスローされます。 詳細は、Nodeのクラスの説明を参照してください。

      • getGraphic

        public final Node getGraphic​()
        プロパティgraphicの値を取得します。
        プロパティの説明:
        ラベル表示のオプション・アイコン。 これは、setContentDisplay(javafx.scene.control.ContentDisplay)を使用して、テキストに対して相対的に配置できます。 この変数用に指定されているノードは、シーングラフのどこにも使用できません。使用した場合、IllegalArgumentExceptionがスローされます。 詳細は、Nodeのクラスの説明を参照してください。

      • setUnderline

        public final void setUnderline​(boolean value)
        プロパティunderlineの値を設定します。
        プロパティの説明:
        すべてのテキストに下線を付けるかどうか。

      • isUnderline

        public final boolean isUnderline​()
        プロパティunderlineの値を取得します。
        プロパティの説明:
        すべてのテキストに下線を付けるかどうか。

      • setLineSpacing

        public final void setLineSpacing​(double value)
        プロパティlineSpacingの値を設定します。
        プロパティの説明:
        行間のピクセル単位の空間を指定します。
        導入されたバージョン:
        JavaFX 8.0

      • getLineSpacing

        public final double getLineSpacing​()
        プロパティlineSpacingの値を取得します。
        プロパティの説明:
        行間のピクセル単位の空間を指定します。
        導入されたバージョン:
        JavaFX 8.0

      • setContentDisplay

        public final void setContentDisplay​(ContentDisplay value)
        プロパティcontentDisplayの値を設定します。
        プロパティの説明:
        テキストに対するグラフィックの相対的な位置決めを指定します。

      • getContentDisplay

        public final ContentDisplay getContentDisplay​()
        プロパティcontentDisplayの値を取得します。
        プロパティの説明:
        テキストに対するグラフィックの相対的な位置決めを指定します。

      • labelPaddingProperty

        public final ReadOnlyObjectProperty<Insets> labelPaddingProperty​()
        ラベル表示のテキストおよびグラフィックのコンテンツ周辺の余白。 labelPaddingはデフォルトではInsets.EMPTYで、nullに設定することはできません。 サブクラスによって、この余白の外側とLabeledの余白の内側にノードが追加される場合があります。 このプロパティは、CSSからのみ設定できます。
        関連項目:
        getLabelPadding()

      • getLabelPadding

        public final Insets getLabelPadding​()
        プロパティlabelPaddingの値を取得します。
        プロパティの説明:
        ラベル表示のテキストおよびグラフィックのコンテンツ周辺の余白。 labelPaddingはデフォルトではInsets.EMPTYで、nullに設定することはできません。 サブクラスによって、この余白の外側とLabeledの余白の内側にノードが追加される場合があります。 このプロパティは、CSSからのみ設定できます。

      • setGraphicTextGap

        public final void setGraphicTextGap​(double value)
        プロパティgraphicTextGapの値を設定します。
        プロパティの説明:
        グラフィックとテキストの間の総スペース

      • getGraphicTextGap

        public final double getGraphicTextGap​()
        プロパティgraphicTextGapの値を取得します。
        プロパティの説明:
        グラフィックとテキストの間の総スペース

      • setTextFill

        public final void setTextFill​(Paint value)
        プロパティtextFillの値を設定します。
        プロパティの説明:
        テキストを入力するために使用されるPaint。

      • getTextFill

        public final Paint getTextFill​()
        プロパティtextFillの値を取得します。
        プロパティの説明:
        テキストを入力するために使用されるPaint。

      • setMnemonicParsing

        public final void setMnemonicParsing​(boolean value)
        プロパティmnemonicParsingの値を設定します。
        プロパティの説明:
        テキストの解析を有効/無効にするMnemonicParsingプロパティ。 これがtrueに設定されている場合、Labelのテキストが解析され、テキストにニーモニック解析文字「_」が含まれているかどうかが確認されます。 ニーモニックが検出されると、キーの組合せが後続の文字に基づいて決定され、ニーモニックが追加されます。

        Labeledのデフォルト値はfalseですが、一部のコントロールではデフォルトで有効になっています。

      • isMnemonicParsing

        public final boolean isMnemonicParsing​()
        プロパティmnemonicParsingの値を取得します。
        プロパティの説明:
        テキストの解析を有効/無効にするMnemonicParsingプロパティ。 これがtrueに設定されている場合、Labelのテキストが解析され、テキストにニーモニック解析文字「_」が含まれているかどうかが確認されます。 ニーモニックが検出されると、キーの組合せが後続の文字に基づいて決定され、ニーモニックが追加されます。

        Labeledのデフォルト値はfalseですが、一部のコントロールではデフォルトで有効になっています。

      • mnemonicParsingProperty

        public final BooleanProperty mnemonicParsingProperty​()
        テキストの解析を有効/無効にするMnemonicParsingプロパティ。 これがtrueに設定されている場合、Labelのテキストが解析され、テキストにニーモニック解析文字「_」が含まれているかどうかが確認されます。 ニーモニックが検出されると、キーの組合せが後続の文字に基づいて決定され、ニーモニックが追加されます。

        Labeledのデフォルト値はfalseですが、一部のコントロールではデフォルトで有効になっています。

        関連項目:
        isMnemonicParsing()、setMnemonicParsing(boolean)

      • toString

        public String toString​()
        次のクラスからコピーされた説明: Node
        オブジェクトの文字列表現を返します。
        オーバーライド:
        toString 、クラス: Node
        戻り値:
        オブジェクトの文字列表現。

      • getInitialAlignment

        protected Pos getInitialAlignment​()
        JavaFX CSSエンジンが初期値を正しく設定するために使用する、このコントロールの初期整列状態を返します。 このメソッドは、最初はPos.CENTER_LEFTを使用するようにオーバーライドされています。
        戻り値:
        このコントロールの初期の整列状態
        導入されたバージョン:
        9

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData​()
        戻り値:
        このクラスに関連付けられたCssMetaData。スーパークラスのCssMetaDataを含むことがあります。
        導入されたバージョン:
        JavaFX 8.0

      • getControlCssMetaData

        public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData​()
        オーバーライド:
        getControlCssMetaData 、クラス: Control
        戻り値:
        コントロールのCSSでスタイル設定可能なプロパティの変更不可能なリスト
        導入されたバージョン:
        JavaFX 8.0