Spec-Zone.ru › OpenJavaFX 8
javafx.scene.control

Класс Tooltip

java.lang.Object
  • javafx.stage.Window
    • javafx.stage.PopupWindow
      • javafx.scene.control.PopupControl
        • javafx.scene.control.Tooltip

Все реализуемые интерфейсы:

Styleable, EventTarget, Skinnable 


@IDProperty(value="id")
public class Tooltip
extends PopupControl
Подсказки — распространённые элементы пользовательского интерфейса, которые обычно используются для отображения дополнительной информации о узле в графическом дереве сцены, когда курсор мыши наводится на узел. Любой узел может отобразить подсказку. В большинстве случаев подсказка создаётся, и её свойство text изменяется для отображения простого текста пользователю. Однако подсказка может отображать произвольное графическое дерево узлов — это делается путём создания графического дерева и его установки в свойстве подсказки graphic.

Вот как установить подсказку на любой узел: 

Rectangle rect = new Rectangle(0, 0, 100, 100);
 Tooltip t = new Tooltip("A Square");
 Tooltip.install(rect, t);
Эта подсказка затем будет участвовать в стандартной семантике подсказок (то есть появляться при наведении, и т. д.). Обратите внимание, что подсказка не должна быть удалена: она будет удалена сборщиком мусора, когда на неё больше не будет ссылаться ни один узел. Однако удалить подсказку можно вручную.

Одна подсказка может быть установлена на несколько целевых узлов или нескольких элементах управления.

Поскольку большинство подсказок отображаются на элементах управления пользовательского интерфейса, существует специальный 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

  • Краткое описание свойств

    Все методыМетоды экземпляровКонкретные методы
    Тип Свойство и описание
    ReadOnlyBooleanProperty activated
    Обычно подсказка «активируется», когда курсор мыши перемещается над элементом управления.
    ObjectProperty<ContentDisplay> contentDisplay
    Определяет позиционирование графического элемента относительно текста.
    ObjectProperty<Font> font
    Шрифт по умолчанию для текста в подсказке.
    ObjectProperty<Node> graphic
    Необязательный значок для подсказки.
    DoubleProperty graphicTextGap
    Расстояние между графическим элементом и текстом
    ObjectProperty<TextAlignment> textAlignment
    Определяет поведение строк текста при многострочном тексте.
    ObjectProperty<OverrunStyle> textOverrun
    Определяет поведение, если текст Tooltip превышает доступное пространство для отображения текста.
    StringProperty text
    Текст, отображаемый в подсказке.
    BooleanProperty wrapText
    Если часть текста превышает ширину подсказки, это значение указывает, нужно ли переносить текст на другую строку.

    • Свойства, унаследованные от класса javafx.scene.control.PopupControl

      id, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skin, style

    • Свойства, унаследованные от класса javafx.stage.PopupWindow

      anchorLocation, anchorX, anchorY, autoFix, autoHide, consumeAutoHidingEvents, hideOnEscape, onAutoHide, ownerNode, ownerWindow

    • Свойства, унаследованные от класса javafx.stage.Window

      eventDispatcher, focused, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, scene, showing, width, x, y

  • Краткое описание вложенных классов

    • Вложенные классы/интерфейсы, унаследованные от класса javafx.stage.PopupWindow

      PopupWindow.AnchorLocation

  • Краткое описание полей

    • Поля, унаследованные от класса javafx.scene.control.PopupControl

      bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

  • Краткое описание конструкторов

    Конструкторы
    Конструктор и описание
    Tooltip()
    Создаёт подсказку с пустой строкой в качестве текста.
    Tooltip(String text)
    Создаёт подсказку со заданным текстом.

  • Краткое описание методов

    Все методыСтатические методыМетоды экземпляровКонкретные методы
    Модификатор и тип Метод и описание
    ReadOnlyBooleanProperty activatedProperty()
    Обычно подсказка «активируется», когда курсор мыши перемещается над элементом управления.
    ObjectProperty<ContentDisplay> contentDisplayProperty()
    Определяет позиционирование графического элемента относительно текста.
    protected Skin<?> createDefaultSkin()
    Создаёт новый экземпляр стандартной темы для этого элемента управления.
    ObjectProperty<Font> fontProperty()
    Шрифт по умолчанию для текста в подсказке.
    static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
    ContentDisplay getContentDisplay()
    Возвращает значение свойства contentDisplay.
    List<CssMetaData<? extends Styleable,?>> getCssMetaData()
    CssMetaData для этого элемента Styleable.
    Font getFont()
    Возвращает значение свойства font.
    Node getGraphic()
    Возвращает значение свойства graphic.
    double getGraphicTextGap()
    Возвращает значение свойства graphicTextGap.
    Styleable getStyleableParent()
    Возвращает родительский элемент этого Styleable, или null, если родителя нет.
    String getText()
    Возвращает значение свойства text.
    TextAlignment getTextAlignment()
    Возвращает значение свойства textAlignment.
    OverrunStyle getTextOverrun()
    Возвращает значение свойства textOverrun.
    ObjectProperty<Node> graphicProperty()
    Необязательный значок для подсказки.
    DoubleProperty graphicTextGapProperty()
    Расстояние между графическим элементом и текстом
    static void install(Node node, Tooltip t)
    Связывает данную подсказку Tooltip с данным узлом Node.
    boolean isActivated()
    Возвращает значение свойства activated.
    boolean isWrapText()
    Возвращает значение свойства wrapText.
    void setContentDisplay(ContentDisplay value)
    Устанавливает значение свойства contentDisplay.
    void setFont(Font value)
    Устанавливает значение свойства font.
    void setGraphic(Node value)
    Устанавливает значение свойства graphic.
    void setGraphicTextGap(double value)
    Устанавливает значение свойства graphicTextGap.
    void setText(String value)
    Устанавливает значение свойства text.
    void setTextAlignment(TextAlignment value)
    Устанавливает значение свойства textAlignment.
    void setTextOverrun(OverrunStyle value)
    Устанавливает значение свойства textOverrun.
    void setWrapText(boolean value)
    Устанавливает значение свойства wrapText.
    ObjectProperty<TextAlignment> textAlignmentProperty()
    Определяет поведение строк текста при многострочном тексте.
    ObjectProperty<OverrunStyle> textOverrunProperty()
    Определяет поведение, если текст Tooltip превышает доступное пространство для отображения текста.
    StringProperty textProperty()
    Текст, отображаемый в подсказке.
    static void uninstall(Node node, Tooltip t)
    Удаляет связь данной подсказки Tooltip с указанным узлом Node.
    BooleanProperty wrapTextProperty()
    Если часть текста превышает ширину подсказки, это значение указывает, нужно ли переносить текст на другую строку.

    • Методы, унаследованные от класса javafx.scene.control.PopupControl

      getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleClass, getTypeSelector, idProperty, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, pseudoClassStateChanged, setId, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setStyle, skinProperty, styleProperty

    • Методы, унаследованные от класса javafx.stage.PopupWindow

      anchorLocationProperty, anchorXProperty, anchorYProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, getAnchorLocation, getAnchorX, getAnchorY, getConsumeAutoHidingEvents, getOnAutoHide, getOwnerNode, getOwnerWindow, hide, hideOnEscapeProperty, isAutoFix, isAutoHide, isHideOnEscape, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty, setAnchorLocation, setAnchorX, setAnchorY, setAutoFix, setAutoHide, setConsumeAutoHidingEvents, setHideOnEscape, setOnAutoHide, setScene, show, show, show

    • Методы, унаследованные от класса javafx.stage.Window

      addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getProperties, getScene, getUserData, getWidth, getX, getY, hasProperties, heightProperty, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setUserData, setWidth, setX, setY, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

    • Методы, унаследованные от класса java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Подробное описание свойств

    • text

      public final StringProperty textProperty
      Текст, который будет отображаться в подсказке. Если текст установлен в null, будет отображена пустая строка, несмотря на то, что значение равно null.

      См. также:

      getText(), setText(String)

    • textAlignment

      public final ObjectProperty<TextAlignment> textAlignmentProperty
      Определяет поведение строк текста при многострочном тексте. В отличие от contentDisplay, который влияет на графику и текст, данная настройка влияет только на несколько строк текста относительно границ текста.

      См. также:

      getTextAlignment(), setTextAlignment(TextAlignment)

    • textOverrun

      public final ObjectProperty<OverrunStyle> textOverrunProperty
      Определяет поведение в случае, если текст Tooltip превышает доступное пространство для отрисовки текста.

      См. также:

      getTextOverrun(), setTextOverrun(OverrunStyle)

    • wrapText

      public final BooleanProperty wrapTextProperty
      Если строка текста превышает ширину подсказки, то эта переменная указывает, следует ли текст переносить на другую строку.

      См. также:

      isWrapText(), setWrapText(boolean)

    • font

      public final ObjectProperty<Font> fontProperty
      Шрифт по умолчанию для текста в подсказке. Если текст подсказки является форматированным текстом, то этот шрифт может или не может использоваться в зависимости от информации о шрифте, встроенной в форматированный текст, но в любом случае, когда требуется шрифт по умолчанию, будет использоваться этот шрифт.

      См. также:

      getFont(), setFont(Font)

    • graphic

      public final ObjectProperty<Node> graphicProperty
      Дополнительный значок для подсказки. Его можно разместить относительно текста, используя свойство content display. Узел, указанный для этой переменной, не может отображаться в другом месте в дереве сцены, в противном случае будет выброшено исключение IllegalArgumentException. Подробнее см. описание класса Node.

      См. также:

      getGraphic(), setGraphic(Node)

    • contentDisplay

      public final ObjectProperty<ContentDisplay> contentDisplayProperty
      Определяет позиционирование значка относительно текста.

      См. также:

      getContentDisplay(), setContentDisplay(ContentDisplay)

    • graphicTextGap

      public final DoubleProperty graphicTextGapProperty
      Расстояние между значком и текстом

      См. также:

      getGraphicTextGap(), setGraphicTextGap(double)

    • activated

      public final ReadOnlyBooleanProperty activatedProperty
      Обычно подсказка "активируется", когда курсор мыши перемещается над элементом управления. Обычно есть некоторая задержка между тем, когда подсказка "активируется", и моментом ее фактического отображения. Подробности (такие как величина задержки и т. д.) оставляются на усмотрение реализации скина.

      См. также:

      isActivated()

  • Подробное описание конструкторов

    • Tooltip

      public Tooltip()
      Создаёт подсказку со строкой по умолчанию.

    • Tooltip

      public Tooltip(String text)
      Создаёт подсказку со заданным текстом.

      Параметры:

      text - Строка текста для подсказки.

  • Метод

    • install

      public static void install(Node node,
                           Tooltip t)
      Связывает заданный Tooltip с заданным Node. Подсказка может затем вести себя аналогично, когда она установлена на любом Control. Одна подсказка может быть связана с несколькими узлами.

      См. также:

      Tooltip

    • uninstall

      public static void uninstall(Node node,
                             Tooltip t)
      Удаляет связь заданной Tooltip на указанном Node. Таким образом, при наведении курсора на узел подсказка больше не будет отображаться.

      См. также:

      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.

    • textAlignmentProperty

      public final ObjectProperty<TextAlignment> textAlignmentProperty()
      Определяет поведение строк текста при многострочном тексте. В отличие от contentDisplay, которое влияет на графику и текст, это значение влияет только на несколько строк текста относительно границ текста.

      См. также:

      getTextAlignment(), setTextAlignment(TextAlignment)

    • setTextAlignment

      public final void setTextAlignment(TextAlignment value)
      Устанавливает значение свойства textAlignment.

      Описание свойства:

      Определяет поведение строк текста при многострочном тексте. В отличие от contentDisplay, которое влияет на графику и текст, это значение влияет только на несколько строк текста относительно границ текста.

    • getTextAlignment

      public final TextAlignment getTextAlignment()
      Получает значение свойства textAlignment.

      Описание свойства:

      Определяет поведение строк текста при многострочном тексте. В отличие от contentDisplay, которое влияет на графику и текст, это значение влияет только на несколько строк текста относительно границ текста.

    • textOverrunProperty

      public final ObjectProperty<OverrunStyle> textOverrunProperty()
      Определяет поведение, если текст Tooltip превышает доступное пространство для рендеринга текста.

      См. также:

      getTextOverrun(), setTextOverrun(OverrunStyle)

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

      Описание свойства:

      Шрифт по умолчанию для текста в подсказке. Если текст подсказки представляет собой форматированный текст, этот шрифт может быть или не быть использован в зависимости от информации о шрифте, встроенной в форматированный текст, но в любом случае, когда требуется шрифт по умолчанию, будет использован этот шрифт.

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

    • contentDisplayProperty

      public final ObjectProperty<ContentDisplay> contentDisplayProperty()
      Определяет расположение значка относительно текста.

      См. также:

      getContentDisplay(), setContentDisplay(ContentDisplay)

    • setContentDisplay

      public final void setContentDisplay(ContentDisplay value)
      Устанавливает значение свойства contentDisplay.

      Описание свойства:

      Определяет расположение значка относительно текста.

    • getContentDisplay

      public final ContentDisplay getContentDisplay()
      Получает значение свойства contentDisplay.

      Описание свойства:

      Определяет расположение значка относительно текста.

    • graphicTextGapProperty

      public final DoubleProperty graphicTextGapProperty()
      Расстояние между значком и текстом

      См. также:

      getGraphicTextGap(), setGraphicTextGap(double)

    • setGraphicTextGap

      public final void setGraphicTextGap(double value)
      Устанавливает значение свойства graphicTextGap.

      Описание свойства:

      Расстояние между значком и текстом

    • getGraphicTextGap

      public final double getGraphicTextGap()
      Получает значение свойства graphicTextGap.

      Описание свойства:

      Расстояние между значком и текстом

    • isActivated

      public final boolean isActivated()
      Получает значение свойства activated.

      Описание свойства:

      Обычно подсказка «активируется», когда курсор мыши перемещается над элементом управления. Обычно есть некоторая задержка между моментом, когда подсказка становится «активной», и моментом ее фактического отображения. Подробности (например, длительность задержки и т. д.) оставляются на реализацию темы.

    • activatedProperty

      public final ReadOnlyBooleanProperty activatedProperty()
      Обычно подсказка «активируется», когда курсор мыши перемещается над элементом управления. Обычно есть некоторая задержка между моментом, когда подсказка становится «активной», и моментом ее фактического отображения. Подробности (например, длительность задержки и т. д.) оставляются на реализацию темы.

      См. также:

      isActivated()

    • createDefaultSkin

      protected Skin<?> createDefaultSkin()
      Создать новый экземпляр стандартной темы для этого элемента управления. Это вызывается для создания темы для элемента управления, если тема не предоставлена через CSS -fx-skin или явно не задана в подклассе с setSkin(...).

      Переопределяет:

      createDefaultSkin в классе PopupControl

      Возвращает:

      новый экземпляр стандартной темы для этого элемента управления. Если null, то элемент управления не будет иметь темы, если только она не будет предоставлена css.

    • getClassCssMetaData

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

      Возвращает:

      CssMetaData, связанная с этим классом, которая может включать CssMetaData его суперклассов.

      С:

      JavaFX 8.0

    • getCssMetaData

      public List<CssMetaData<? extends Styleable,?>> getCssMetaData()
      CssMetaData этого Стиля. Это может быть возвращено как неизменяемый список.

      Указывается:

      getCssMetaData в интерфейсе Styleable

      Переопределяет:

      getCssMetaData в классе PopupControl

      С:

      JavaFX 8.0

    • getStyleableParent

      public Styleable getStyleableParent()
      Описание скопировано из класса: PopupControl
      Возвращает родителя этого Styleable или null, если родителя нет. Стили PopupControl основаны на "владельце" всплывающего окна, который является ownerNode или, если ownerNode не установлен, корнем ownerWindow's сцены. Если всплывающее окно не было показано, оба ownerNode и ownerWindow будут null, и null будет возвращено. Обратите внимание, что корень сцены PopupWindow не возвращается, поскольку нет способа гарантировать, что корень сцены PopupWindow правильно вернет ownerNode или ownerWindow.

      Указывается:

      getStyleableParent в интерфейсе Styleable

      Переопределяет:

      getStyleableParent в классе PopupControl

      Возвращает:

      PopupWindow.getOwnerNode(), PopupWindow.getOwnerWindow() или null.

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API