Modifier and Type	Class and Description
private class	Tooltip.CSSBridge
private static class	Tooltip.TooltipBehavior

Modifier and Type	Field and Description
private final ReadOnlyBooleanWrapper	activated Typically, the tooltip is "activated" when the mouse moves over a Control.
private static Tooltip.TooltipBehavior	BEHAVIOR
private static final CssMetaData<Tooltip.CSSBridge, ContentDisplay>	CONTENT_DISPLAY
private final ObjectProperty<ContentDisplay>	contentDisplay
private final ObjectProperty<Font>	font
private static final CssMetaData<Tooltip.CSSBridge, Font>	FONT
private final ObjectProperty<Node>	graphic
private static final CssMetaData<Tooltip.CSSBridge, String>	GRAPHIC
private static final CssMetaData<Tooltip.CSSBridge, Number>	GRAPHIC_TEXT_GAP
private final DoubleProperty	graphicTextGap
private static final CssMetaData<Tooltip.CSSBridge, Duration>	HIDE_DELAY
private final ObjectProperty<Duration>	hideDelayProperty
private StyleableStringProperty	imageUrl
private static final CssMetaData<Tooltip.CSSBridge, Duration>	SHOW_DELAY
private static final CssMetaData<Tooltip.CSSBridge, Duration>	SHOW_DURATION
private final ObjectProperty<Duration>	showDelayProperty
private final ObjectProperty<Duration>	showDurationProperty
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES Hides javafx.scene.control.PopupControl.STYLEABLES.
private final StringProperty	text
private static final CssMetaData<Tooltip.CSSBridge, TextAlignment>	TEXT_ALIGNMENT
private static final CssMetaData<Tooltip.CSSBridge, OverrunStyle>	TEXT_OVERRUN
private final ObjectProperty<TextAlignment>	textAlignment
private final ObjectProperty<OverrunStyle>	textOverrun
private static String	TOOLTIP_PROP_KEY
private static int	TOOLTIP_XOFFSET
private static int	TOOLTIP_YOFFSET
private static final CssMetaData<Tooltip.CSSBridge, Boolean>	WRAP_TEXT
private final BooleanProperty	wrapText

Access	Constructor and Description
public	Tooltip() Creates a tooltip with an empty string for its text.
public	Tooltip(String A text string for the tooltip. text) Creates a tooltip with the specified text.

Method Summary

Modifier and Type	Method and Description
public final ReadOnlyBooleanProperty	activatedProperty()
public final ObjectProperty<ContentDisplay>	Returns: the content display property contentDisplayProperty() Specifies the positioning of the graphic relative to the text.
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.PopupControl.createDefaultSkin. Create a new instance of the default skin for this control.
public final ObjectProperty<Font>	Returns: the font property fontProperty() The default font to use for text in the Tooltip.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.control.PopupControl.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public final ContentDisplay	getContentDisplay()
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.control.PopupControl.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. The CssMetaData of this Styleable.
public final Font	getFont()
public final Node	getGraphic()
public final double	getGraphicTextGap()
public final Duration	getHideDelay()
public final Duration	getShowDelay()
public final Duration	getShowDuration()
public Styleable	getStyleableParent() Overrides javafx.scene.control.PopupControl.getStyleableParent. Implements javafx.css.Styleable.getStyleableParent. Return the parent of this Styleable, or null if there is no parent.
public final String	getText()
public final TextAlignment	getTextAlignment()
public final OverrunStyle	getTextOverrun()
public final ObjectProperty<Node>	Returns: the graphic property graphicProperty() An optional icon for the Tooltip.
public final DoubleProperty	Returns: the graphic text gap property graphicTextGapProperty() The amount of space between the graphic and text
public final ObjectProperty<Duration>	Returns: the hide delay property hideDelayProperty() The duration in which to continue showing the tooltip after the mouse has left the node.
private StyleableStringProperty	imageUrlProperty()
public static void	install(Node the node node, Tooltip the tooltip t) Associates the given `Tooltip` with the given `Node`.
public final boolean	isActivated()
public final boolean	isWrapText()
pack-priv final void	setActivated(boolean value)
public final void	setContentDisplay(ContentDisplay value)
public final void	setFont(Font value)
public final void	setGraphic(Node value)
public final void	setGraphicTextGap(double value)
public final void	setHideDelay(Duration hideDelay)
public final void	setShowDelay(Duration showDelay)
public final void	setShowDuration(Duration showDuration)
public final void	setText(String value)
public final void	setTextAlignment(TextAlignment value)
public final void	setTextOverrun(OverrunStyle value)
public final void	setWrapText(boolean value)
public final ObjectProperty<Duration>	Returns: show delay property showDelayProperty() The delay between the mouse entering the hovered node and when the associated tooltip will be shown to the user.
public final ObjectProperty<Duration>	Returns: the show duration property showDurationProperty() The duration that the tooltip should remain showing for until it is no longer visible to the user.
public final ObjectProperty<TextAlignment>	Returns: the text alignment property textAlignmentProperty() Specifies the behavior for lines of text when text is multiline.
public final ObjectProperty<OverrunStyle>	Returns: the text overrun property textOverrunProperty() Specifies the behavior to use if the text of the `Tooltip` exceeds the available space for rendering the text.
public final StringProperty	Returns: the text property textProperty() The text to display in the tooltip.
public static void	uninstall(Node the node node, Tooltip the tooltip t) Removes the association of the given `Tooltip` on the specified `Node`.
public final BooleanProperty	Returns: the wrap text property wrapTextProperty() If a run of text exceeds the width of the Tooltip, then this variable indicates whether the text should wrap onto another line.

Field Detail

activated	back to summary
private final ReadOnlyBooleanWrapper activated Typically, the tooltip is "activated" when the mouse moves over a Control. There is usually some delay between when the Tooltip becomes "activated" and when it is actually shown. The details (such as the amount of delay, etc) is left to the Skin implementation.

BEHAVIOR	back to summary
private static Tooltip.TooltipBehavior BEHAVIOR

CONTENT_DISPLAY	back to summary
private static final CssMetaData<Tooltip.CSSBridge, ContentDisplay> CONTENT_DISPLAY

contentDisplay	back to summary
private final ObjectProperty<ContentDisplay> contentDisplay

font	back to summary
private final ObjectProperty<Font> font

FONT	back to summary
private static final CssMetaData<Tooltip.CSSBridge, Font> FONT

graphic	back to summary
private final ObjectProperty<Node> graphic

GRAPHIC	back to summary
private static final CssMetaData<Tooltip.CSSBridge, String> GRAPHIC

GRAPHIC_TEXT_GAP	back to summary
private static final CssMetaData<Tooltip.CSSBridge, Number> GRAPHIC_TEXT_GAP

graphicTextGap	back to summary
private final DoubleProperty graphicTextGap

HIDE_DELAY	back to summary
private static final CssMetaData<Tooltip.CSSBridge, Duration> HIDE_DELAY

hideDelayProperty	back to summary
private final ObjectProperty<Duration> hideDelayProperty

imageUrl	back to summary
private StyleableStringProperty imageUrl

SHOW_DELAY	back to summary
private static final CssMetaData<Tooltip.CSSBridge, Duration> SHOW_DELAY

SHOW_DURATION	back to summary
private static final CssMetaData<Tooltip.CSSBridge, Duration> SHOW_DURATION

showDelayProperty	back to summary
private final ObjectProperty<Duration> showDelayProperty

showDurationProperty	back to summary
private final ObjectProperty<Duration> showDurationProperty

STYLEABLES	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES Hides javafx.scene.control.PopupControl.STYLEABLES.

text	back to summary
private final StringProperty text

TEXT_ALIGNMENT	back to summary
private static final CssMetaData<Tooltip.CSSBridge, TextAlignment> TEXT_ALIGNMENT

TEXT_OVERRUN	back to summary
private static final CssMetaData<Tooltip.CSSBridge, OverrunStyle> TEXT_OVERRUN

textAlignment	back to summary
private final ObjectProperty<TextAlignment> textAlignment

textOverrun	back to summary
private final ObjectProperty<OverrunStyle> textOverrun

TOOLTIP_PROP_KEY	back to summary
private static String TOOLTIP_PROP_KEY

TOOLTIP_XOFFSET	back to summary
private static int TOOLTIP_XOFFSET

TOOLTIP_YOFFSET	back to summary
private static int TOOLTIP_YOFFSET

WRAP_TEXT	back to summary
private static final CssMetaData<Tooltip.CSSBridge, Boolean> WRAP_TEXT

wrapText	back to summary
private final BooleanProperty wrapText

Constructor Detail

Tooltip	back to summary
public Tooltip() Creates a tooltip with an empty string for its text.

Tooltip	back to summary
public Tooltip(String text) Creates a tooltip with the specified text. Parameters text:String A text string for the tooltip.

Method Detail

activatedProperty	back to summary
public final ReadOnlyBooleanProperty activatedProperty()

contentDisplayProperty	back to summary
public final ObjectProperty<ContentDisplay> contentDisplayProperty() Specifies the positioning of the graphic relative to the text. Returns:ObjectProperty<ContentDisplay> the content display property

contentDisplayProperty

back to summary

public final ObjectProperty<ContentDisplay> contentDisplayProperty()

Specifies the positioning of the graphic relative to the text.

Returns:ObjectProperty<ContentDisplay>: the content display property

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.PopupControl.createDefaultSkin. Doc from javafx.scene.control.PopupControl.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.PopupControl.createDefaultSkin.

Doc from javafx.scene.control.PopupControl.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

fontProperty	back to summary
public final ObjectProperty<Font> fontProperty() The default font to use for text in the Tooltip. If the Tooltip's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used. Returns:ObjectProperty<Font> the font property

fontProperty

back to summary

public final ObjectProperty<Font> fontProperty()

The default font to use for text in the Tooltip. If the Tooltip's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used.

Returns:ObjectProperty<Font>: the font property

getClassCssMetaData back to summary

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

Hides javafx.scene.control.PopupControl.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getContentDisplay	back to summary
public final ContentDisplay getContentDisplay()

getCssMetaData

back to summary

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

Overrides javafx.scene.control.PopupControl.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.control.PopupControl.getCssMetaData.

The CssMetaData of this Styleable. This may be returned as an unmodifiable list.

Returns:List<CssMetaData<? extends Styleable, ?>>

Doc from javafx.css.Styleable.getCssMetaData.

the CssMetaData

Annotations

@Override

Since

JavaFX 8.0

getFont	back to summary
public final Font getFont()

getGraphic	back to summary
public final Node getGraphic()

getGraphicTextGap	back to summary
public final double getGraphicTextGap()

getHideDelay	back to summary
public final Duration getHideDelay()

getShowDelay	back to summary
public final Duration getShowDelay()

getShowDuration	back to summary
public final Duration getShowDuration()

getStyleableParent back to summary

getStyleableParent	back to summary
public Styleable getStyleableParent() Overrides javafx.scene.control.PopupControl.getStyleableParent. Implements javafx.css.Styleable.getStyleableParent. Doc from javafx.scene.control.PopupControl.getStyleableParent. Return the parent of this Styleable, or null if there is no parent. A PopupControl's styles are based on the popup "owner" which is the `ownerNode` or, if the ownerNode is not set, the root of the `ownerWindow's` scene. If the popup has not been shown, both ownerNode and ownerWindow will be null and `null` will be returned. Note that the PopupWindow's scene root is not returned because there is no way to guarantee that the PopupWindow's scene root would properly return the ownerNode or ownerWindow. Returns:Styleable `javafx.stage.PopupWindow#getOwnerNode()`, `javafx.stage.PopupWindow#getOwnerWindow()`, or null. Annotations @Override

public Styleable getStyleableParent()

Overrides javafx.scene.control.PopupControl.getStyleableParent.

Implements javafx.css.Styleable.getStyleableParent.

Doc from javafx.scene.control.PopupControl.getStyleableParent.

Return the parent of this Styleable, or null if there is no parent. A PopupControl's styles are based on the popup "owner" which is the ownerNode or, if the ownerNode is not set, the root of the ownerWindow's scene. If the popup has not been shown, both ownerNode and ownerWindow will be null and null will be returned. Note that the PopupWindow's scene root is not returned because there is no way to guarantee that the PopupWindow's scene root would properly return the ownerNode or ownerWindow.

Returns:Styleable

javafx.stage.PopupWindow#getOwnerNode(), javafx.stage.PopupWindow#getOwnerWindow(), or null.

Annotations

@Override

getText	back to summary
public final String getText()

getTextAlignment	back to summary
public final TextAlignment getTextAlignment()

getTextOverrun	back to summary
public final OverrunStyle getTextOverrun()

graphicProperty back to summary

public final ObjectProperty<Node> graphicProperty()

An optional icon for the Tooltip. This can be positioned relative to the text by using the content display property. The node specified for this variable cannot appear elsewhere in the scene graph, otherwise the IllegalArgumentException is thrown. See the class description of Node for more detail.

Returns:ObjectProperty<Node>: the graphic property

graphicTextGapProperty

back to summary

public final DoubleProperty graphicTextGapProperty()

The amount of space between the graphic and text

Returns:DoubleProperty: the graphic text gap property

hideDelayProperty

back to summary

public final ObjectProperty<Duration> hideDelayProperty()

The duration in which to continue showing the tooltip after the mouse has left the node. Once this time has elapsed the tooltip will hide. The default value is 200ms.

Returns:ObjectProperty<Duration>: the hide delay property
Default Value: 200ms
Since: 9

imageUrlProperty	back to summary
private StyleableStringProperty imageUrlProperty()

install back to summary

public static void install(Node node, Tooltip t)

Associates the given Tooltip with the given Node. The tooltip can then behave similar to when it is set on any Control. A single tooltip can be associated with multiple nodes.

Parameters

node:Node: the node
t:Tooltip: the tooltip

See Also

Tooltip

isActivated	back to summary
public final boolean isActivated()

isWrapText	back to summary
public final boolean isWrapText()

setActivated	back to summary
pack-priv final void setActivated(boolean value)

setContentDisplay	back to summary
public final void setContentDisplay(ContentDisplay value)

setFont	back to summary
public final void setFont(Font value)

setGraphic	back to summary
public final void setGraphic(Node value)

setGraphicTextGap	back to summary
public final void setGraphicTextGap(double value)

setHideDelay	back to summary
public final void setHideDelay(Duration hideDelay)

setShowDelay	back to summary
public final void setShowDelay(Duration showDelay)

setShowDuration	back to summary
public final void setShowDuration(Duration showDuration)

setText	back to summary
public final void setText(String value)

setTextAlignment	back to summary
public final void setTextAlignment(TextAlignment value)

setTextOverrun	back to summary
public final void setTextOverrun(OverrunStyle value)

setWrapText	back to summary
public final void setWrapText(boolean value)

showDelayProperty

back to summary

public final ObjectProperty<Duration> showDelayProperty()

The delay between the mouse entering the hovered node and when the associated tooltip will be shown to the user. The default delay is 1000ms.

Returns:ObjectProperty<Duration>: show delay property
Default Value: 1000ms
Since: 9

showDurationProperty back to summary

public final ObjectProperty<Duration> showDurationProperty()

The duration that the tooltip should remain showing for until it is no longer visible to the user. If the mouse leaves the control before the showDuration finishes, then the tooltip will remain showing for the duration specified in the hideDelayProperty(), even if the remaining time of the showDuration is less than the hideDelay duration. The default value is 5000ms.

Returns:ObjectProperty<Duration>: the show duration property
Default Value: 5000ms
Since: 9

textAlignmentProperty back to summary

public final ObjectProperty<TextAlignment> textAlignmentProperty()

Specifies the behavior for lines of text when text is multiline. Unlike contentDisplay which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds.

Returns:ObjectProperty<TextAlignment>: the text alignment property

textOverrunProperty back to summary

public final ObjectProperty<OverrunStyle> textOverrunProperty()

Specifies the behavior to use if the text of the Tooltip exceeds the available space for rendering the text.

Returns:ObjectProperty<OverrunStyle>: the text overrun property

textProperty

back to summary

public final StringProperty textProperty()

The text to display in the tooltip. If the text is set to null, an empty string will be displayed, despite the value being null.

Returns:StringProperty: the text property

uninstall back to summary

public static void uninstall(Node node, Tooltip t)

Removes the association of the given Tooltip on the specified Node. Hence hovering on the node will no longer result in showing of the tooltip.

Parameters

node:Node: the node
t:Tooltip: the tooltip

See Also

Tooltip

wrapTextProperty

back to summary

public final BooleanProperty wrapTextProperty()

If a run of text exceeds the width of the Tooltip, then this variable indicates whether the text should wrap onto another line.

Returns:BooleanProperty: the wrap text property

javafx.scene.control back to summary

private final Class Tooltip.CSSBridge

Class Inheritance

extends CSSBridge

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.control.PopupControl.CSSBridge
javafx.scene.control.Tooltip.CSSBridge

Field Summary

Modifier and Type	Field and Description
private Tooltip	tooltip

Constructor Summary

Access	Constructor and Description
pack-priv	CSSBridge()

Method Summary

Inherited from javafx.scene.control.PopupControl.CSSBridge:: getCssMetaData getStyleableParent requestLayout

Field Detail

tooltip	back to summary
private Tooltip tooltip

Constructor Detail

CSSBridge	back to summary
pack-priv CSSBridge()

javafx.scene.control back to summary

private Class Tooltip.TooltipBehavior

Class Inheritance

extends Object

java.lang.Object
javafx.scene.control.Tooltip.TooltipBehavior

Field Summary

Modifier and Type	Field and Description
private Tooltip	activatedTooltip The tooltip that is currently activated.
private Timeline	activationTimer
private boolean	hideOnExit
private Timeline	hideTimer
private Node	hoveredNode The Node with a tooltip over which the mouse is hovering.
private EventHandler<MouseEvent>	KILL_HANDLER Registers for mouse click, press, release, drag events.
private double	lastMouseX The last position of the mouse, in screen coordinates.
private double	lastMouseY
private EventHandler<MouseEvent>	LEAVING_HANDLER Registers for mouse exit events.
private Timeline	leftTimer
private EventHandler<MouseEvent>	MOVE_HANDLER Registers for mouse move events only.
private Tooltip	visibleTooltip The tooltip that is currently visible.

Constructor Summary

Access	Constructor and Description
pack-priv	TooltipBehavior(final boolean hideOnExit)

Method Summary

Modifier and Type	Method and Description
private Window	Returns: the top level window getWindow(final Node the node node) Gets the top level window associated with this node.
private void	install(Node node, Tooltip t)
private boolean	Returns: true if entire hierarchy is visible isWindowHierarchyVisible(Node the node to check node) Gets whether the entire window hierarchy is visible for this node.
private void	uninstall(Node node)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

activatedTooltip	back to summary
private Tooltip activatedTooltip The tooltip that is currently activated. There can only be one of these at a time.

activationTimer	back to summary
private Timeline activationTimer

hideOnExit	back to summary
private boolean hideOnExit

hideTimer	back to summary
private Timeline hideTimer

hoveredNode	back to summary
private Node hoveredNode The Node with a tooltip over which the mouse is hovering. There can only be one of these at a time.

KILL_HANDLER	back to summary
private EventHandler<MouseEvent> KILL_HANDLER Registers for mouse click, press, release, drag events. If any of these occur, then the tooltip is hidden (if it is visible), it is deactivated, and any and all timers are stopped.

lastMouseX	back to summary
private double lastMouseX The last position of the mouse, in screen coordinates.

lastMouseY	back to summary
private double lastMouseY

LEAVING_HANDLER	back to summary
private EventHandler<MouseEvent> LEAVING_HANDLER Registers for mouse exit events. If the ACTIVATION_TIMER is running then this will simply stop it. If the HIDE_TIMER is running then this will stop the HIDE_TIMER, hide the tooltip, and start the LEFT_TIMER.

leftTimer	back to summary
private Timeline leftTimer

MOVE_HANDLER	back to summary
private EventHandler<MouseEvent> MOVE_HANDLER Registers for mouse move events only. When the mouse is moved, this handler will detect it and decide whether to start the ACTIVATION_TIMER (if the ACTIVATION_TIMER is not started), restart the ACTIVATION_TIMER (if ACTIVATION_TIMER is running), or skip the ACTIVATION_TIMER and just show the tooltip (if the LEFT_TIMER is running).

visibleTooltip	back to summary
private Tooltip visibleTooltip The tooltip that is currently visible. There can only be one of these at a time.

Constructor Detail

TooltipBehavior	back to summary
pack-priv TooltipBehavior(final boolean hideOnExit)

Method Detail

getWindow

back to summary

private Window getWindow(final Node node)

Gets the top level window associated with this node.

Parameters

node:Node: the node

Returns:Window

the top level window

install	back to summary
private void install(Node node, Tooltip t)

isWindowHierarchyVisible

back to summary

private boolean isWindowHierarchyVisible(Node node)

Gets whether the entire window hierarchy is visible for this node.

Parameters

node:Node: the node to check

Returns:boolean

true if entire hierarchy is visible

uninstall	back to summary
private void uninstall(Node node)

public Class Tooltip

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Tooltip.CSSBridge

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class Tooltip.TooltipBehavior

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail