Класс Tooltip

javafx.scene.control.Tooltip

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

@IDProperty("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 button = new Button("Hover Over Me");
 button.setTooltip(new Tooltip("Tooltip for Button"));

С:: JavaFX 2.0

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

Вложенные классы/интерфейсы, объявленные в классе javafx.stage.PopupWindow

PopupWindow.AnchorLocation

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

Тип	Свойство	Описание
`final ReadOnlyBooleanProperty`	`activated`	Как правило, подсказка "активируется", когда курсор мыши перемещается над элементом управления.
`final ObjectProperty<ContentDisplay>`	`contentDisplay`	Устанавливает позиционирование графики относительно текста.
`final ObjectProperty<Font>`	`font`	Шрифт по умолчанию для использования в тексте подсказки.
`final ObjectProperty<Node>`	`graphic`	Необязательный значок для подсказки.
`final DoubleProperty`	`graphicTextGap`	Расстояние между графикой и текстом
`final ObjectProperty<Duration>`	`hideDelay`	Время в секундах, в течение которого подсказка будет отображаться после того, как курсор мыши ушёл с узла.
`final ObjectProperty<Duration>`	`showDelay`	Задержка между моментом, когда курсор мыши входит в наводимый узел, и моментом отображения связанной подсказки пользователю.
`final ObjectProperty<Duration>`	`showDuration`	Время в секундах, в течение которого подсказка должна оставаться видимой для пользователя, прежде чем исчезнет.
`final ObjectProperty<TextAlignment>`	`textAlignment`	Устанавливает поведение строк текста при многострочном тексте.
`final ObjectProperty<OverrunStyle>`	`textOverrun`	Устанавливает поведение, если текст `Tooltip` превышает доступное пространство для рендеринга текста.
`final StringProperty`	`text`	Текст, который будет отображен в подсказке.
`final 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, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y

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

Поля, объявленные в классе javafx.scene.control.PopupControl

bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

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

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

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

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

Методы, объявленные в классе javafx.scene.control.PopupControl

createDefaultSkin, getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleableParent, 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, forceIntegerRenderScaleProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getOutputScaleX, getOutputScaleY, getProperties, getRenderScaleX, getRenderScaleY, getScene, getUserData, getWidth, getWindows, getX, getY, hasProperties, heightProperty, isFocused, isForceIntegerRenderScale, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, outputScaleXProperty, outputScaleYProperty, removeEventFilter, removeEventHandler, renderScaleXProperty, renderScaleYProperty, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setForceIntegerRenderScale, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setRenderScaleX, setRenderScaleY, setUserData, setWidth, setX, setY, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Методы, объявленные в классе java.lang.Object

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

Методы, объявленные в интерфейсе javafx.css.Styleable

getStyleableNode

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

text

public final StringProperty textProperty

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

См. также:

textAlignment

public final ObjectProperty<TextAlignment> textAlignmentProperty

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

См. также:

textOverrun

public final ObjectProperty<OverrunStyle> textOverrunProperty

Определяет поведение, если текст Tooltip превышает доступное пространство для отображения текста.

См. также:

wrapText

public final BooleanProperty wrapTextProperty

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

См. также:

font

public final ObjectProperty<Font> fontProperty

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

См. также:

showDelay

public final ObjectProperty<Duration> showDelayProperty

Задержка между входом курсора в область наведения на узел и отображением связанной подсказки пользователю. Значение по умолчанию — 1000мс.

Значение по умолчанию:

1000мс

С версии:

См. также:

showDuration

public final ObjectProperty<Duration> showDurationProperty

Продолжительность отображения подсказки до её скрытия от пользователя. Если курсор уходит с элемента управления до завершения showDuration, подсказка останется отображённой в течение времени, указанного в hideDelayProperty(), даже если оставшееся время showDuration меньше времени hideDelay. Значение по умолчанию — 5000мс.

Значение по умолчанию:

5000мс

С версии:

См. также:

hideDelay

public final ObjectProperty<Duration> hideDelayProperty

Продолжительность отображения подсказки после того, как курсор покинул узел. После этого времени подсказка будет скрыта. Значение по умолчанию — 200мс.

Значение по умолчанию:

200мс

С версии:

См. также:

graphic

public final ObjectProperty<Node> graphicProperty

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

См. также:

contentDisplay

public final ObjectProperty<ContentDisplay> contentDisplayProperty

Определяет позиционирование графики относительно текста.

См. также:

graphicTextGap

public final DoubleProperty graphicTextGapProperty

Расстояние между графикой и текстом.

См. также:

activated

public final ReadOnlyBooleanProperty activatedProperty

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

См. также:

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

Tooltip

public Tooltip()

Создаёт подсказку с пустой строкой в качестве текста.

Tooltip

public Tooltip(String text)

Создаёт подсказку с указанным текстом.

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

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

install

public static void install(Node node, Tooltip t)

Связывает данную подсказку с указанным узлом. Подсказка может затем вести себя аналогично установке на любой Control. Одна подсказка может быть связана с несколькими узлами.

Параметры:

node - узел

t - подсказка

См. также:

uninstall

public static void uninstall(Node node, Tooltip t)

Удаляет связь данной подсказки с указанным узлом. Поэтому наведение на узел больше не приведет к отображению подсказки.

Параметры:

node - узел

t - подсказка

См. также:

textProperty

public final StringProperty textProperty()

Возвращает:

свойство текста

См. также:

setText

public final void setText(String value)

Устанавливает значение свойства text.

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

Текст, отображаемый в всплывающей подсказке. Если текст установлен в значение null, будет отображена пустая строка, несмотря на то, что значение равно null.

Параметры:

value - значение для свойства text

См. также:

getText

public final String getText()

Получает значение свойства text.

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

Возвращает:

значение свойства text

См. также:

textAlignmentProperty

public final ObjectProperty<TextAlignment> textAlignmentProperty()

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

Возвращает:

свойство выравнивания текста

См. также:

setTextAlignment

public final void setTextAlignment(TextAlignment value)

Устанавливает значение свойства textAlignment.

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

Параметры:

value - значение для свойства textAlignment

См. также:

getTextAlignment

public final TextAlignment getTextAlignment()

Получает значение свойства textAlignment.

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

Возвращает:

значение свойства textAlignment

См. также:

textOverrunProperty

public final ObjectProperty<OverrunStyle> textOverrunProperty()

Указывает поведение, если текст Tooltip превышает доступное пространство для отображения текста.

Возвращает:

свойство переполнения текста

См. также:

setTextOverrun

public final void setTextOverrun(OverrunStyle value)

Устанавливает значение свойства textOverrun.

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

Указывает поведение, если текст Tooltip превышает доступное пространство для отображения текста.

Параметры:

value - значение для свойства textOverrun

См. также:

getTextOverrun

public final OverrunStyle getTextOverrun()

Получает значение свойства textOverrun.

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

Указывает поведение, если текст Tooltip превышает доступное пространство для отображения текста.

Возвращает:

значение свойства textOverrun

См. также:

wrapTextProperty

public final BooleanProperty wrapTextProperty()

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

Возвращает:

свойство переноса текста

См. также:

setWrapText

public final void setWrapText(boolean value)

Устанавливает значение свойства wrapText.

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

Параметры:

value - значение для свойства wrapText

См. также:

isWrapText

public final boolean isWrapText()

Получает значение свойства wrapText.

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

Возвращает:

значение свойства wrapText

См. также:

fontProperty

public final ObjectProperty<Font> fontProperty()

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

Возвращает:

свойство шрифта

См. также:

setFont

public final void setFont(Font value)

Устанавливает значение свойства font.

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

Параметры:

value - значение для свойства font

См. также:

getFont

public final Font getFont()

Получает значение свойства font.

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

Возвращает:

значение свойства font

См. также:

showDelayProperty

public final ObjectProperty<Duration> showDelayProperty()

Задержка между входом курсора мыши в выделенную узел и отображением связанной всплывающей подсказки пользователю. Стандартная задержка составляет 1000мс.

Значение по умолчанию:

1000мс

Возвращает:

свойство задержки показа

С:

См. также:

Установить задержку отображения

public final void setShowDelay(Duration showDelay)

Устанавливает значение свойства showDelay.

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

Задержка между входом курсора мыши в выделенный узел и отображением связанного всплывающего подсказки пользователю. Значение по умолчанию - 1000 мс.

Значение по умолчанию:

1000 мс

Параметры:

showDelay - значение для свойства showDelay

С:

См. также:

Получить задержку отображения

public final Duration getShowDelay()

Получает значение свойства showDelay.

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

Значение по умолчанию:

1000 мс

Возвращает:

значение свойства showDelay

С:

См. также:

Свойство продолжительности отображения

public final ObjectProperty<Duration> showDurationProperty()

Продолжительность отображения всплывающей подсказки до ее скрытия. Если курсор покинет область управления до завершения отображения, всплывающая подсказка останется видимой в течение времени, указанного в hideDelayProperty(), даже если оставшееся время отображения меньше, чем задержка скрытия. Значение по умолчанию - 5000 мс.

Значение по умолчанию:

5000 мс

Возвращает:

свойство продолжительности отображения

С:

См. также:

Установить продолжительность отображения

public final void setShowDuration(Duration showDuration)

Устанавливает значение свойства showDuration.

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

Значение по умолчанию:

5000 мс

Параметры:

showDuration - значение для свойства showDuration

С:

См. также:

Получить продолжительность отображения

public final Duration getShowDuration()

Получает значение свойства showDuration.

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

Значение по умолчанию:

5000 мс

Возвращает:

значение свойства showDuration

С:

См. также:

Свойство задержки скрытия

public final ObjectProperty<Duration> hideDelayProperty()

Продолжительность отображения всплывающей подсказки после того, как курсор мыши покинул узел. По истечении этого времени всплывающая подсказка будет скрыта. Значение по умолчанию - 200 мс.

Значение по умолчанию:

200 мс

Возвращает:

свойство задержки скрытия

С:

См. также:

Установить задержку скрытия

public final void setHideDelay(Duration hideDelay)

Устанавливает значение свойства hideDelay.

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

Значение по умолчанию:

200 мс

Параметры:

hideDelay - значение для свойства hideDelay

С:

См. также:

Получить задержку скрытия

public final Duration getHideDelay()

Получает значение свойства hideDelay.

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

Значение по умолчанию:

200 мс

Возвращает:

значение свойства hideDelay

С:

См. также:

Свойство графического элемента

public final ObjectProperty<Node> graphicProperty()

Необязательный значок для всплывающей подсказки. Его можно расположить относительно текста, используя свойство content display. Узел, указанный для этой переменной, не может отображаться в другом месте в графическом дереве сцены, иначе будет выброшено исключение IllegalArgumentException. Подробнее см. в описании класса Node.

Возвращает:

свойство графического элемента

См. также:

Установить графический элемент

public final void setGraphic(Node value)

Устанавливает значение свойства graphic.

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

Параметры:

value - значение для свойства graphic

См. также:

Получить графический элемент

public final Node getGraphic()

Получает значение свойства graphic.

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

Возвращает:

значение свойства graphic

См. также:

Свойство отображения содержимого

public final ObjectProperty<ContentDisplay> contentDisplayProperty()

Определяет расположение графического элемента относительно текста.

Возвращает:

свойство отображения содержимого

См. также:

Установить отображение содержимого

public final void setContentDisplay(ContentDisplay value)

Устанавливает значение свойства contentDisplay.

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

Определяет расположение графического элемента относительно текста.

Параметры:

value - значение для свойства contentDisplay

См. также:

getContentDisplay

public final ContentDisplay getContentDisplay()

Получает значение свойства contentDisplay.

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

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

Возвращает:

значение свойства contentDisplay

См. также:

graphicTextGapProperty

public final DoubleProperty graphicTextGapProperty()

Величина отступа между графическим элементом и текстом

Возвращает:

свойство отступа между графическим элементом и текстом

См. также:

setGraphicTextGap

public final void setGraphicTextGap(double value)

Устанавливает значение свойства graphicTextGap.

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

Величина отступа между графическим элементом и текстом

Параметры:

value - значение для свойства graphicTextGap

См. также:

getGraphicTextGap

public final double getGraphicTextGap()

Получает значение свойства graphicTextGap.

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

Величина отступа между графическим элементом и текстом

Возвращает:

значение свойства graphicTextGap

См. также:

isActivated

public final boolean isActivated()

Получает значение свойства activated.

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

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

Возвращает:

значение свойства activated

См. также:

activatedProperty

public final ReadOnlyBooleanProperty activatedProperty()

Возвращает:

свойство activated

См. также:

getClassCssMetaData

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

Получает метаданные CSS, связанные с данным классом, что может включать метаданные CSS его суперклассов.

Возвращает:: метаданные CSS
С:: JavaFX 8.0

getCssMetaData

public List<CssMetaData<? extends Styleable,?>> getCssMetaData()

Метаданные CSS данного стилизуемого элемента. Может возвращаться как неизменяемый список.

Указано в:: getCssMetaData в интерфейсе Styleable
Переопределяет:: getCssMetaData в классе PopupControl
Возвращает:: метаданные CSS
С:: JavaFX 8.0

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