Класс 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
Краткое описание свойств
| Тип | Свойство | Описание |
|---|---|---|
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.stage.PopupWindow
PopupWindow.AnchorLocation
Краткое описание полей
Поля, объявленные в классе javafx.scene.control.PopupControl
bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
Tooltip() |
Создаёт подсказку со строкой-пустышкой в качестве текста. |
Tooltip |
Создаёт подсказку с указанным текстом. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
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 этого Styleable. |
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 |
|
final boolean |
isActivated() |
Получает значение свойства activated. |
final boolean |
isWrapText() |
Получает значение свойства wrapText. |
final void |
setContentDisplay |
Устанавливает значение свойства contentDisplay. |
final void |
setFont |
Устанавливает значение свойства font. |
final void |
setGraphic |
Устанавливает значение свойства graphic. |
final void |
setGraphicTextGap |
Устанавливает значение свойства graphicTextGap. |
final void |
setHideDelay |
Устанавливает значение свойства hideDelay. |
final void |
setShowDelay |
Устанавливает значение свойства showDelay. |
final void |
setShowDuration |
Устанавливает значение свойства showDuration. |
final void |
setText |
Устанавливает значение свойства text. |
final void |
setTextAlignment |
Устанавливает значение свойства textAlignment. |
final void |
setTextOverrun |
Устанавливает значение свойства textOverrun. |
final void |
setWrapText |
Устанавливает значение свойства wrapText. |
final ObjectProperty<Duration> |
showDelayProperty() |
Задержка между входом курсора мыши в наведенный узел и отображением связанной всплывающей подсказки пользователю. |
final ObjectProperty<Duration> |
showDurationProperty() |
Продолжительность отображения всплывающей подсказки, пока она видна пользователю. |
final ObjectProperty<TextAlignment> |
textAlignmentProperty() |
Указывает поведение строк текста при многострочном тексте. |
final ObjectProperty<OverrunStyle> |
textOverrunProperty() |
Указывает поведение, если текст Tooltip превышает доступное пространство для отображения текста. |
final StringProperty |
textProperty() |
Текст, который должен отображаться в всплывающей подсказке. |
static void |
uninstall |
|
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
- См. также:
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мс
- С версии:
- 9
- См. также:
showDuration
public final ObjectProperty<Duration> showDurationProperty
hideDelayProperty(), даже если оставшееся время showDuration меньше, чем hideDelay. Значение по умолчанию — 5000мс.- Значение по умолчанию:
- 5000мс
- С версии:
- 9
- См. также:
hideDelay
public final ObjectProperty<Duration> hideDelayProperty
- Значение по умолчанию:
- 200мс
- С версии:
- 9
- См. также:
graphic
public final ObjectProperty<Node> graphicProperty
content display. Узел, указанный для этой переменной, не может отображаться в другом месте в графическом дереве, в противном случае будет выброшено исключение IllegalArgumentException. Подробности см. в описании класса 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)
Tooltip с данным Node. Всплывающая подсказка может затем вести себя аналогично тому, когда она установлена на любом Control. Одна всплывающая подсказка может быть связана с несколькими узлами.- Параметры:
-
node- узел -
t- всплывающая подсказка - См. также:
uninstall
public static void uninstall(Node node, Tooltip t)
Tooltip с указанным Node. Таким образом, при наведении на узел всплывающая подсказка больше не будет отображаться.- Параметры:
-
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.- Описание свойства:
- Текст, который будет отображаться в подсказке. Если текст задан как null, будет отображена пустая строка, несмотря на то, что значение равно null.
- Возвращает:
- значение свойства
text - См. также:
textAlignmentProperty
public final ObjectProperty<TextAlignment> textAlignmentProperty()
contentDisplay, которое влияет на графику и текст, это свойство влияет только на несколько строк текста относительно границ текста.- Возвращает:
- свойство выравнивания текста
- См. также:
setTextAlignment
public final void setTextAlignment(TextAlignment value)
textAlignment.- Описание свойства:
- Устанавливает поведение строк текста при многострочном отображении текста. В отличие от
contentDisplay, которое влияет на графику и текст, это свойство влияет только на несколько строк текста относительно границ текста. - Параметры:
-
value- значение для свойстваtextAlignment - См. также:
getTextAlignment
public final TextAlignment getTextAlignment()
textAlignment.- Описание свойства:
- Устанавливает поведение строк текста при многострочном отображении текста. В отличие от
contentDisplay, которое влияет на графику и текст, это свойство влияет только на несколько строк текста относительно границ текста. - Возвращает:
- значение свойства
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 мс
- Возвращает:
- свойство задержки отображения
- С:
- 9
- См. также:
setShowDelay
public final void setShowDelay(Duration showDelay)
showDelay.- Описание свойства:
- Задержка между входом мыши в узлы и отображением связанной подсказки пользователю. Значение по умолчанию — 1000 мс.
- Значение по умолчанию:
- 1000 мс
- Параметры:
-
showDelay- значение для свойстваshowDelay - С:
- 9
- См. также:
getShowDelay
public final Duration getShowDelay()
showDelay.- Описание свойства:
- Задержка между входом мыши в узлы и отображением связанной подсказки пользователю. Значение по умолчанию — 1000 мс.
- Значение по умолчанию:
- 1000 мс
- Возвращает:
- значение свойства
showDelay - С:
- 9
- См. также:
showDurationProperty
public final ObjectProperty<Duration> showDurationProperty()
hideDelayProperty(), даже если оставшееся время showDuration меньше, чем hideDelay. Значение по умолчанию — 5000мс.- Значение по умолчанию:
- 5000мс
- Возвращает:
- свойство продолжительности отображения
- С версии:
- 9
- См. также:
setShowDuration
public final void setShowDuration(Duration showDuration)
showDuration.- Описание свойства:
- Продолжительность отображения всплывающей подсказки до момента, когда она больше не видна пользователю. Если курсор мыши покинет элемент управления до завершения showDuration, всплывающая подсказка будет отображаться в течение периода, указанного в
hideDelayProperty(), даже если оставшееся время showDuration меньше, чем hideDelay. Значение по умолчанию — 5000мс. - Значение по умолчанию:
- 5000мс
- Параметры:
-
showDuration- значение для свойстваshowDuration - С версии:
- 9
- См. также:
getShowDuration
public final Duration getShowDuration()
showDuration.- Описание свойства:
- Продолжительность отображения всплывающей подсказки до момента, когда она больше не видна пользователю. Если курсор мыши покинет элемент управления до завершения showDuration, всплывающая подсказка будет отображаться в течение периода, указанного в
hideDelayProperty(), даже если оставшееся время showDuration меньше, чем hideDelay. Значение по умолчанию — 5000мс. - Значение по умолчанию:
- 5000мс
- Возвращает:
- значение свойства
showDuration - С версии:
- 9
- См. также:
hideDelayProperty
public final ObjectProperty<Duration> hideDelayProperty()
- Значение по умолчанию:
- 200мс
- Возвращает:
- свойство задержки скрытия
- С версии:
- 9
- См. также:
setHideDelay
public final void setHideDelay(Duration hideDelay)
hideDelay.- Описание свойства:
- Продолжительность отображения всплывающей подсказки после того, как курсор мыши покинул узел. По истечении этого времени всплывающая подсказка скрывается. Значение по умолчанию — 200мс.
- Значение по умолчанию:
- 200мс
- Параметры:
-
hideDelay- значение для свойстваhideDelay - С версии:
- 9
- См. также:
getHideDelay
public final Duration getHideDelay()
hideDelay.- Описание свойства:
- Продолжительность отображения всплывающей подсказки после того, как курсор мыши покинул узел. По истечении этого времени всплывающая подсказка скрывается. Значение по умолчанию — 200мс.
- Значение по умолчанию:
- 200мс
- Возвращает:
- значение свойства
hideDelay - С версии:
- 9
- См. также:
graphicProperty
public final ObjectProperty<Node> graphicProperty()
content display. Узел, указанный для этой переменной, не может появляться в другом месте в дереве сцены, иначе будет выброшено исключение IllegalArgumentException. Дополнительные сведения см. в описании класса Node.- Возвращает:
- свойство значка
- См. также:
setGraphic
public final void setGraphic(Node value)
graphic.- Описание свойства:
- Необязательный значок для всплывающей подсказки. Его можно расположить относительно текста, используя свойство
content display. Узел, указанный для этой переменной, не может появляться в другом месте в дереве сцены, иначе будет выброшено исключениеIllegalArgumentException. Дополнительные сведения см. в описании классаNode. - Параметры:
-
value- значение для свойстваgraphic - См. также:
getGraphic
public final Node getGraphic()
graphic.- Описание свойства:
- Необязательный значок для всплывающей подсказки. Его можно расположить относительно текста, используя свойство
content display. Узел, указанный для этой переменной, не может появляться в другом месте в дереве сцены, иначе будет выброшено исключениеIllegalArgumentException. Дополнительные сведения см. в описании классаNode. - Возвращает:
- значение свойства
graphic - См. также:
contentDisplayProperty
public final ObjectProperty<ContentDisplay> contentDisplayProperty()
- Возвращает:
- свойство отображения содержимого
- См. также:
setContentDisplay
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.- Описание свойства:
- Обычно всплывающая подсказка "активируется", когда курсор мыши перемещается над элементом управления (Control). Обычно есть задержка между моментом, когда всплывающая подсказка "активируется", и моментом её фактического отображения. Подробности (например, величина задержки и т.д.) определяются реализацией скина.
- Возвращает:
- значение свойства
activated - См. также:
activatedProperty
public final ReadOnlyBooleanProperty activatedProperty()
- Возвращает:
- свойство
activated - См. также:
getClassCssMetaData
public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
CssMetaData, связанное с этим классом, которое может включать CssMetaData его суперклассов.- Возвращает:
CssMetaData- С момента:
- JavaFX 8.0
getCssMetaData
public List<CssMetaData<? extends Styleable,?>> getCssMetaData()
- Определено в:
-
getCssMetaDataв интерфейсеStyleable - Переопределяет:
-
getCssMetaDataв классеPopupControl - Возвращает:
- CssMetaData
- С момента:
- 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.