Module  javafx.controls
软件包  javafx.scene.control

Class Tooltip

  • All Implemented Interfaces:
    StyleableEventTargetSkinnable


    @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来使工具提示更加冗长。 下面的示例显示了如何为Button控件创建一个工具提示:

      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
    • 构造方法详细信息

      • Tooltip

        public Tooltip​()
        为其文本创建一个带有空字符串的工具提示。
      • Tooltip

        public Tooltip​(String text)
        用指定的文本创建一个工具提示。
        参数
        text - 工具提示的文本字符串。
    • 方法详细信息

      • install

        public static void install​(Node node,
                                   Tooltip t)
        将给定的Tooltip与给定的Node相关联 然后,工具提示可以与任何Control上的设置相似 单个工具提示可以与多个节点相关联。
        参数
        node - 节点
        t - 工具提示
        另请参见:
        Tooltip
      • uninstall

        public static void uninstall​(Node node,
                                     Tooltip t)
        删除给定的Tooltip在指定的Node上的关联 因此,在该节点上悬停将不再显示工具提示。
        参数
        node - 节点
        t - 工具提示
        另请参见:
        Tooltip
      • textProperty

        public final StringProperty textProperty​()
        要在工具提示中显示的文字。 如果文本设置为null,则将显示一个空字符串,尽管值为null。
        另请参见:
        getText()setText(String)
      • setText

        public final void setText​(String value)
        设置属性文本的值。
        Property description:
        要在工具提示中显示的文字。 如果文本设置为null,则将显示一个空字符串,尽管值为null。
      • getText

        public final String getText​()
        获取属性文本的值。
        Property description:
        要在工具提示中显示的文字。 如果文本设置为null,则将显示一个空字符串,尽管值为null。
      • setTextAlignment

        public final void setTextAlignment​(TextAlignment value)
        设置textAlignment属性的值。
        Property description:
        指定文本行多行时的行为。 与影响图形和文本的contentDisplay不同,此设置仅影响文本边界的多行文本。
      • getTextAlignment

        public final TextAlignment getTextAlignment​()
        获取属性textAlignment的值。
        Property description:
        指定文本行多行时的行为。 与影响图形和文本的contentDisplay不同,此设置仅影响文本边界的多行文本。
      • setTextOverrun

        public final void setTextOverrun​(OverrunStyle value)
        设置textOverrun属性的值。
        Property description:
        指定 Tooltip的文本超过可用空间进行渲染时使用的行为。
      • getTextOverrun

        public final OverrunStyle getTextOverrun​()
        获取textOverrun属性的值。
        Property description:
        指定 Tooltip的文本超过可用空间进行渲染时使用的行为。
      • setWrapText

        public final void setWrapText​(boolean value)
        设置属性wrapText的值。
        Property description:
        如果文本运行超过工具提示的宽度,则该变量指示文本是否应该包装到另一行。
      • isWrapText

        public final boolean isWrapText​()
        获取propertyTextText的值。
        Property description:
        如果文本运行超过工具提示的宽度,则该变量指示文本是否应该包装到另一行。
      • fontProperty

        public final ObjectProperty<Font> fontProperty​()
        工具提示中用于文本的默认字体。 如果工具提示的文本是富文本,则根据嵌入在富文本中的字体信息,可能会使用或不使用此字体,但是在任何需要默认字体的情况下,将使用该字体。
        另请参见:
        getFont()setFont(Font)
      • setFont

        public final void setFont​(Font value)
        设置属性字体的值。
        Property description:
        工具提示中用于文本的默认字体。 如果工具提示的文本是富文本,则根据嵌入在富文本中的字体信息,可能会使用或不使用此字体,但是在任何需要默认字体的情况下,将使用该字体。
      • getFont

        public final Font getFont​()
        获取属性字体的值。
        Property description:
        工具提示中用于文本的默认字体。 如果工具提示的文本是富文本,则根据嵌入在富文本中的字体信息,可能会使用或不使用此字体,但是在任何需要默认字体的情况下,将使用该字体。
      • showDelayProperty

        public final ObjectProperty<Duration> showDelayProperty​()
        进入悬停节点的鼠标与相关联的工具提示之间的延迟将显示给用户。 默认延迟为1000ms。
        Default value:
        1000毫秒
        从以下版本开始:
        9
        另请参见:
        getShowDelay()setShowDelay(Duration)
      • setShowDelay

        public final void setShowDelay​(Duration showDelay)
        设置属性showDelay的值。
        Property description:
        进入悬停节点的鼠标与相关联的工具提示之间的延迟将显示给用户。 默认延迟为1000ms。
        Default value:
        1000毫秒
        从以下版本开始:
        9
      • getShowDelay

        public final Duration getShowDelay​()
        获取属性showDelay的值。
        Property description:
        进入悬停节点的鼠标与相关联的工具提示之间的延迟将显示给用户。 默认延迟为1000ms。
        Default value:
        1000毫秒
        从以下版本开始:
        9
      • showDurationProperty

        public final ObjectProperty<Duration> showDurationProperty​()
        工具提示应保持显示的持续时间,直到用户不再可见。 如果在showDuration完成之前鼠标离开控件,则即使在showDuration的剩余时间小于hideDelay持续时间,工具提示将继续显示hideDelayProperty()指定的持续时间。 默认值为5000ms。
        Default value:
        5000毫秒
        从以下版本开始:
        9
        另请参见:
        getShowDuration()setShowDuration(Duration)
      • setShowDuration

        public final void setShowDuration​(Duration showDuration)
        设置属性showDuration的值。
        Property description:
        工具提示应保持显示的持续时间,直到用户不再可见。 如果在showDuration完成之前鼠标离开控件,则即使在showDuration的剩余时间小于hideDelay持续时间,工具提示仍将显示hideDelayProperty()指定的持续时间。 默认值为5000ms。
        Default value:
        5000毫秒
        从以下版本开始:
        9
      • getShowDuration

        public final Duration getShowDuration​()
        获取属性showDuration的值。
        Property description:
        工具提示应保持显示的持续时间,直到用户不再可见。 如果在showDuration完成之前鼠标离开控件,则即使在showDuration的剩余时间小于hideDelay持续时间的情况下 ,工具提示仍将显示hideDelayProperty()指定的持续时间。 默认值为5000ms。
        Default value:
        5000毫秒
        从以下版本开始:
        9
      • hideDelayProperty

        public final ObjectProperty<Duration> hideDelayProperty​()
        在鼠标离开节点后继续显示工具提示的持续时间。 一旦这段时间过去,工具提示就会隐藏起来。 默认值为200ms。
        Default value:
        200毫秒
        从以下版本开始:
        9
        另请参见:
        getHideDelay()setHideDelay(Duration)
      • setHideDelay

        public final void setHideDelay​(Duration hideDelay)
        设置属性hideDelay的值。
        Property description:
        在鼠标离开节点后继续显示工具提示的持续时间。 一旦这段时间过去,工具提示就会隐藏起来。 默认值为200ms。
        Default value:
        200毫秒
        从以下版本开始:
        9
      • getHideDelay

        public final Duration getHideDelay​()
        获取属性hideDelay的值。
        Property description:
        在鼠标离开节点后继续显示工具提示的持续时间。 一旦这段时间过去,工具提示就会隐藏起来。 默认值为200ms。
        Default value:
        200毫秒
        从以下版本开始:
        9
      • graphicProperty

        public final ObjectProperty<Node> graphicProperty​()
        工具提示的可选图标。 这可以通过使用content display属性相对于文本进行定位。 为此变量指定的节点不能出现在场景图中的其他IllegalArgumentException ,否则抛出IllegalArgumentException 有关详细信息,请参阅Node的类描述。
        另请参见:
        getGraphic()setGraphic(Node)
      • setGraphic

        public final void setGraphic​(Node value)
        设置属性图形的值。
        Property description:
        工具提示的可选图标。 这可以通过使用content display属性相对于文本定位。 为此变量指定的节点不能出现在场景图形的其他IllegalArgumentException ,否则抛出IllegalArgumentException 有关详细信息,请参阅Node的类描述。
      • getGraphic

        public final Node getGraphic​()
        获取属性图形的值。
        Property description:
        工具提示的可选图标。 这可以通过使用content display属性相对于文本定位。 为此变量指定的节点不能出现在场景图中的其他IllegalArgumentException ,否则抛出IllegalArgumentException 有关详细信息,请参阅Node的类描述。
      • setContentDisplay

        public final void setContentDisplay​(ContentDisplay value)
        设置属性contentDisplay的值。
        Property description:
        指定图形相对于文本的位置。
      • getContentDisplay

        public final ContentDisplay getContentDisplay​()
        获取属性contentDisplay的值。
        Property description:
        指定图形相对于文本的位置。
      • setGraphicTextGap

        public final void setGraphicTextGap​(double value)
        设置属性graphicTextGap的值。
        Property description:
        图形和文字之间的空间量
      • getGraphicTextGap

        public final double getGraphicTextGap​()
        获取属性graphicTextGap的值。
        Property description:
        图形和文字之间的空间量
      • isActivated

        public final boolean isActivated​()
        获取激活的属性的值。
        Property description:
        通常,当鼠标移动到控件上时,工具提示被“激活”。 当Tooltip变为“激活”和实际显示时,通常会有一些延迟。 细节(如延迟量等)留给皮肤实现。
      • activatedProperty

        public final ReadOnlyBooleanProperty activatedProperty​()
        通常,当鼠标移动到控件上时,工具提示被“激活”。 当Tooltip变为“激活”和实际显示时,通常会有一些延迟。 细节(如延迟量等)留给皮肤实现。
        另请参见:
        isActivated()
      • createDefaultSkin

        protected Skin<?> createDefaultSkin​()
        为此控件创建一个新的默认皮肤实例。 如果没有通过CSS -fx-skin提供皮肤或者在具有setSkin(...)的子类中显式设置,则调用此控件创建皮肤。
        重写:
        createDefaultSkinPopupControl
        结果
        此控件的默认皮肤的新实例。 如果为null,则控件将没有皮肤,除非由css提供。
      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData​()
        结果
        与此类相关联的CssMetaData可能包括其类的CssMetaData。
        从以下版本开始:
        JavaFX 8.0