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

クラスTooltip

  • すべての実装されたインタフェース:
    Styleable, EventTarget, Skinnable
    @IDProperty("id")
public class Tooltip
extends PopupControl
    ツールチップは一般的なUI要素であり、これらの要素は通常、シーングラフ内のノードがマウスでポイントされた場合にそのノードに関する追加情報を表示するために使用されます。 すべてのノードでツールチップを表示できます。 多くの場合、ユーザーにプレーン・テキストを表示するために、ツールチップを作成し、そのtextプロパティを変更します。 ただし、ツールチップではその中にノードの任意のシーングラフを表示できます。このことは、シーングラフを作成してTooltipのgraphicプロパティ内に設定することによって行います。

    任意のノードでツールチップを設定するには、次のアプローチを使用します。 

     Rectangle rect = new Rectangle(0, 0, 100, 100);
 Tooltip t = new Tooltip("A Square");
 Tooltip.install(rect, t);
    次に、このツールチップを通常のツールチップ・セマンティクス(カーソルを置いたときに表示されるなど)とともに追加します。 ツールチップをアンインストールする必要はありません。いずれのノードからも参照されなくなると、ガベージ・コレクションされます。 ただし、ツールチップを手動でアンインストールすることは可能です。

    複数のターゲット・ノードまたは複数のコントロールに単一のツールチップをインストールできます。

    ツールチップはUIコントロールに表示されることが多いため、ツールチップのインストールの冗長性を軽減するための、すべてのコントロール向けの特殊なAPIがあります。 次の例は、ボタン・コントロールのツールチップを作成する方法を示しています。 

     import javafx.scene.control.Tooltip;
 import javafx.scene.control.Button;

 Button button = new Button("Hover Over Me");
 button.setTooltip(new Tooltip("Tooltip for Button"));
    導入されたバージョン:
    JavaFX 2.0

    • プロパティの詳細

      • text

        public final StringProperty textProperty
        ツールチップに表示するテキスト。 テキストがnullに設定されている場合は、値がnullであるにもかかわらず、空の文字列が表示されます。
        関連項目:
        getText()、setText(String)

      • wrapText

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

      • font

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

      • showDelay

        public final ObjectProperty<Duration> showDelayProperty
        リングされたノードに入るマウスと関連付けられたツールチップがユーザーに表示されるときの間の遅延。 デフォルトの遅延は1000msです。
        デフォルト値:
        1000ms
        導入されたバージョン:
        9
        関連項目:
        getShowDelay(), setShowDelay(Duration)

      • showDuration

        public final ObjectProperty<Duration> showDurationProperty
        ツールチップがユーザーに表示されなくなるまで、ツールチップが表示されたままになる期間。 showDurationが終了する前にマウスがコントロールから離れると、showDurationの残りの時間がhideDelayの持続時間より短い場合でも、ツールチップはhideDelayProperty()で指定された時間だけ表示されたままになります。 デフォルト値は5000msです。
        デフォルト値:
        5000ms
        導入されたバージョン:
        9
        関連項目:
        getShowDuration(), setShowDuration(Duration)

      • hideDelay

        public final ObjectProperty<Duration> hideDelayProperty
        マウスがノードを離れた後にツールチップを表示し続ける時間。 この時間が経過すると、ツールチップが非表示になります。 デフォルト値は200msです。
        デフォルト値:
        200ms
        導入されたバージョン:
        9
        関連項目:
        getHideDelay(), setHideDelay(Duration)

      • graphic

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

      • activated

        public final ReadOnlyBooleanProperty activatedProperty
        通常、マウスがControl上に置かれるとツールチップがアクティブ化されます。 通常、ツールチップがアクティブになった瞬間から実際に表示されるまでには若干遅延があります。 詳細(遅延時間など)はスキン実装に従います。
        関連項目:
        isActivated()

    • コンストラクタの詳細

      • Tooltip

        public Tooltip()
        そのテキストが空の文字列のツールチップを作成します。

      • Tooltip

        public Tooltip​(String text)
        指定されたテキストでツールチップを作成します。
        パラメータ:
        text - ツールチップのテキスト文字列。

    • メソッドの詳細

      • install

        public static void install​(Node node,
                           Tooltip t)
        指定されたTooltipを指定されたNodeに関連付けます。 その後、ツールチップは、それがControlで設定されたときのように動作できます。 1つのツールチップは、複数のノードに関連付けることができます。
        パラメータ:
        node - ノード
        t - ツールチップ
        関連項目:
        Tooltip

      • uninstall

        public static void uninstall​(Node node,
                             Tooltip t)
        指定されたNode上の指定されたTooltipのアソシエーションを削除します。 このため、マウス・カーソルをノードの上に置いても、ツールチップが表示されなくなります。
        パラメータ:
        node - ノード
        t - ツールチップ
        関連項目:
        Tooltip

      • textProperty

        public final StringProperty textProperty()
        ツールチップに表示するテキスト。 テキストがnullに設定されている場合は、値がnullであるにもかかわらず、空の文字列が表示されます。
        関連項目:
        getText()、setText(String)

      • setText

        public final void setText​(String value)
        プロパティtextの値を設定します。
        プロパティの説明:
        ツールチップに表示するテキスト。 テキストがnullに設定されている場合は、値がnullであるにもかかわらず、空の文字列が表示されます。

      • getText

        public final String getText()
        プロパティtextの値を取得します。
        プロパティの説明:
        ツールチップに表示するテキスト。 テキストがnullに設定されている場合は、値がnullであるにもかかわらず、空の文字列が表示されます。

      • setTextAlignment

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

      • getTextAlignment

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

      • setTextOverrun

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

      • getTextOverrun

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

      • 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の値を取得します。
        プロパティの説明:
        ツールチップ内のテキストに使用するデフォルト・フォント。 ツールチップのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。

      • showDelayProperty

        public final ObjectProperty<Duration> showDelayProperty()
        リングされたノードに入るマウスと関連付けられたツールチップがユーザーに表示されるときの間の遅延。 デフォルトの遅延は1000msです。
        デフォルト値:
        1000ms
        導入されたバージョン:
        9
        関連項目:
        getShowDelay(), setShowDelay(Duration)

      • setShowDelay

        public final void setShowDelay​(Duration showDelay)
        プロパティshowDelayの値を設定します。
        プロパティの説明:
        リングされたノードに入るマウスと関連付けられたツールチップがユーザーに表示されるときの間の遅延。 デフォルトの遅延は1000msです。
        デフォルト値:
        1000ms
        導入されたバージョン:
        9

      • getShowDelay

        public final Duration getShowDelay()
        プロパティshowDelayの値を取得します。
        プロパティの説明:
        リングされたノードに入るマウスと関連付けられたツールチップがユーザーに表示されるときの間の遅延。 デフォルトの遅延は1000msです。
        デフォルト値:
        1000ms
        導入されたバージョン:
        9

      • showDurationProperty

        public final ObjectProperty<Duration> showDurationProperty()
        ツールチップがユーザーに表示されなくなるまで、ツールチップが表示されたままになる期間。 showDurationが終了する前にマウスがコントロールから離れると、showDurationの残りの時間がhideDelayの持続時間より短い場合でも、ツールチップはhideDelayProperty()で指定された時間だけ表示されたままになります。 デフォルト値は5000msです。
        デフォルト値:
        5000ms
        導入されたバージョン:
        9
        関連項目:
        getShowDuration(), setShowDuration(Duration)

      • setShowDuration

        public final void setShowDuration​(Duration showDuration)
        プロパティshowDurationの値を設定します。
        プロパティの説明:
        ツールチップがユーザーに表示されなくなるまで、ツールチップが表示されたままになる期間。 showDurationが終了する前にマウスがコントロールから離れると、showDurationの残りの時間がhideDelayの持続時間より短い場合でも、ツールチップはhideDelayProperty()で指定された時間だけ表示されたままになります。 デフォルト値は5000msです。
        デフォルト値:
        5000ms
        導入されたバージョン:
        9

      • getShowDuration

        public final Duration getShowDuration()
        プロパティshowDurationの値を取得します。
        プロパティの説明:
        ツールチップがユーザーに表示されなくなるまで、ツールチップが表示されたままになる期間。 showDurationが終了する前にマウスがコントロールから離れると、showDurationの残りの時間がhideDelayの持続時間より短い場合でも、ツールチップはhideDelayProperty()で指定された時間だけ表示されたままになります。 デフォルト値は5000msです。
        デフォルト値:
        5000ms
        導入されたバージョン:
        9

      • hideDelayProperty

        public final ObjectProperty<Duration> hideDelayProperty()
        マウスがノードを離れた後にツールチップを表示し続ける時間。 この時間が経過すると、ツールチップが非表示になります。 デフォルト値は200msです。
        デフォルト値:
        200ms
        導入されたバージョン:
        9
        関連項目:
        getHideDelay(), setHideDelay(Duration)

      • setHideDelay

        public final void setHideDelay​(Duration hideDelay)
        プロパティhideDelayの値を設定します。
        プロパティの説明:
        マウスがノードを離れた後にツールチップを表示し続ける時間。 この時間が経過すると、ツールチップが非表示になります。 デフォルト値は200msです。
        デフォルト値:
        200ms
        導入されたバージョン:
        9

      • getHideDelay

        public final Duration getHideDelay()
        プロパティhideDelayの値を取得します。
        プロパティの説明:
        マウスがノードを離れた後にツールチップを表示し続ける時間。 この時間が経過すると、ツールチップが非表示になります。 デフォルト値は200msです。
        デフォルト値:
        200ms
        導入されたバージョン:
        9

      • graphicProperty

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

      • setGraphic

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

      • getGraphic

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

      • setContentDisplay

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

      • getContentDisplay

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

      • setGraphicTextGap

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

      • getGraphicTextGap

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

      • isActivated

        public final boolean isActivated()
        プロパティactivatedの値を取得します。
        プロパティの説明:
        通常、マウスがControl上に置かれるとツールチップがアクティブ化されます。 通常、ツールチップがアクティブになった瞬間から実際に表示されるまでには若干遅延があります。 詳細(遅延時間など)はスキン実装に従います。

      • activatedProperty

        public final ReadOnlyBooleanProperty activatedProperty()
        通常、マウスがControl上に置かれるとツールチップがアクティブ化されます。 通常、ツールチップがアクティブになった瞬間から実際に表示されるまでには若干遅延があります。 詳細(遅延時間など)はスキン実装に従います。
        関連項目:
        isActivated()

      • getClassCssMetaData

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

      • getCssMetaData

        public List<CssMetaData<? extends Styleable,?>> getCssMetaData()
        このStyleableのCssMetaData。 これは変更不可能なリストとして返される場合があります。
        定義:
        getCssMetaData 、インタフェース: Styleable
        オーバーライド:
        getCssMetaData 、クラス: PopupControl
        戻り値:
        CssMetaData
        導入されたバージョン:
        JavaFX 8.0