Class Tooltip

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

javafx.scene.control.PopupControl

javafx.scene.control.Tooltip

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

@IDProperty("id")
public class Tooltip
extends PopupControl

Tooltips are common UI elements which are typically used for showing additional information about a Node in the scenegraph when the Node is hovered over by the mouse. Any Node can show a tooltip. In most cases a Tooltip is created and its text property is modified to show plain text to the user. However, a Tooltip is able to show within it an arbitrary scenegraph of nodes - this is done by creating the scenegraph and setting it inside the Tooltip graphic property.

You use the following approach to set a Tooltip on any node:

 Rectangle rect = new Rectangle(0, 0, 100, 100);
Tooltip t = new Tooltip("A Square");
Tooltip.install(rect, t);

This tooltip will then participate with the typical tooltip semantics (i.e. appearing on hover, etc). Note that the Tooltip does not have to be uninstalled: it will be garbage collected when it is not referenced by any Node. It is possible to manually uninstall the tooltip, however.

A single tooltip can be installed on multiple target nodes or multiple controls.

Because most Tooltips are shown on UI controls, there is special API for all controls to make installing a Tooltip less verbose. The example below shows how to create a tooltip for a Button control:

 Button button = new Button("Hover Over Me");
button.setTooltip(new Tooltip("Tooltip for Button"));

Since:

JavaFX 2.0

Nested Class Summary

Nested classes/interfaces declared in class PopupWindow

PopupWindow.AnchorLocation

Modifier and Type	Class	Description
static enum	PopupWindow.AnchorLocation	Anchor location constants for popup anchor point selection.

Property Summary

Properties

Type	Property	Description
final ReadOnlyBooleanProperty	activated	Typically, the tooltip is "activated" when the mouse moves over a Control.
final ObjectProperty<ContentDisplay>	contentDisplay	Specifies the positioning of the graphic relative to the text.
final ObjectProperty<Font>	font	The default font to use for text in the Tooltip.
final ObjectProperty<Node>	graphic	An optional icon for the Tooltip.
final DoubleProperty	graphicTextGap	The amount of space between the graphic and text
final ObjectProperty<Duration>	hideDelay	The duration in which to continue showing the tooltip after the mouse has left the node.
final ObjectProperty<Duration>	showDelay	The delay between the mouse entering the hovered node and when the associated tooltip will be shown to the user.
final ObjectProperty<Duration>	showDuration	The duration that the tooltip should remain showing for until it is no longer visible to the user.
final ObjectProperty<TextAlignment>	textAlignment	Specifies the behavior for lines of text when text is multiline.
final ObjectProperty<OverrunStyle>	textOverrun	Specifies the behavior to use if the text of the Tooltip exceeds the available space for rendering the text.
final StringProperty	text	The text to display in the tooltip.
final BooleanProperty	wrapText	If a run of text exceeds the width of the Tooltip, then this variable indicates whether the text should wrap onto another line.

Properties declared in class PopupControl

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

Type	Property	Description
final StringProperty	id	The id of this PopupControl.
final DoubleProperty	maxHeight	Property for overriding the control's computed maximum height.
final DoubleProperty	maxWidth	Property for overriding the control's computed maximum width.
final DoubleProperty	minHeight	Property for overriding the control's computed minimum height.
final DoubleProperty	minWidth	Property for overriding the control's computed minimum width.
final DoubleProperty	prefHeight	Property for overriding the control's computed preferred height.
final DoubleProperty	prefWidth	Property for overriding the control's computed preferred width.
final ObjectProperty<Skin<?>>	skin	Skin is responsible for rendering this PopupControl.
final StringProperty	style	A string representation of the CSS style associated with this specific PopupControl.

Properties declared in class PopupWindow

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

Type	Property	Description
final ObjectProperty<PopupWindow.AnchorLocation>	anchorLocation	Specifies the popup anchor point which is used in popup positioning.
final ReadOnlyDoubleProperty	anchorX	Specifies the x coordinate of the popup anchor point on the screen.
final ReadOnlyDoubleProperty	anchorY	Specifies the y coordinate of the popup anchor point on the screen.
final BooleanProperty	autoFix	This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.
final BooleanProperty	autoHide	Specifies whether Popups should auto hide.
final BooleanProperty	consumeAutoHidingEvents	Specifies whether the event, which caused the Popup to hide, should be consumed.
final BooleanProperty	hideOnEscape	Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
final ObjectProperty<EventHandler<Event>>	onAutoHide	Called after autoHide is run.
final ReadOnlyObjectProperty<Node>	ownerNode	The node which is the owner of this popup.
final ReadOnlyObjectProperty<Window>	ownerWindow	The window which is the parent of this popup.

Properties declared in class Window

eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y

Type	Property	Description
final ObjectProperty<EventDispatcher>	eventDispatcher	Specifies the event dispatcher for this node.
final ReadOnlyBooleanProperty	focused	Whether or not this Window has the keyboard or input focus.
final BooleanProperty	forceIntegerRenderScale	Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale.
final ReadOnlyDoubleProperty	height	The height of this Window.
final ObjectProperty<EventHandler<WindowEvent>>	onCloseRequest	Called when there is an external request to close this Window.
final ObjectProperty<EventHandler<WindowEvent>>	onHidden	Called just after the Window has been hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onHiding	Called just prior to the Window being hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onShowing	Called just prior to the Window being shown.
final ObjectProperty<EventHandler<WindowEvent>>	onShown	Called just after the Window is shown.
final DoubleProperty	opacity	Defines the opacity of the Window as a value between 0.0 and 1.0.
final ReadOnlyDoubleProperty	outputScaleX	The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final ReadOnlyDoubleProperty	outputScaleY	The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final DoubleProperty	renderScaleX	The horizontal scale that the Window will use when rendering its Scene to the rendering buffer.
final DoubleProperty	renderScaleY	The vertical scale that the Window will use when rendering its Scene to the rendering buffer.
final ReadOnlyObjectProperty<Scene>	scene	The Scene to be rendered on this Window.
final ReadOnlyBooleanProperty	showing	Whether or not this Window is showing (that is, open on the user's system).
final ReadOnlyDoubleProperty	width	The width of this Window.
final ReadOnlyDoubleProperty	x	The horizontal location of this Window on the screen.
final ReadOnlyDoubleProperty	y	The vertical location of this Window on the screen.

Field Summary

Fields declared in class PopupControl

bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

Modifier and Type	Field	Description
protected PopupControl.CSSBridge	bridge	We need a special root node, except we can't replace the special root node already in the PopupControl.
static final double	USE_COMPUTED_SIZE	Sentinel value which can be passed to a control's setMinWidth(), setMinHeight(), setPrefWidth(), setPrefHeight(), setMaxWidth(), setMaxHeight() methods to reset the control's size constraint back to it's intrinsic size returned by computeMinWidth(), computeMinHeight(), computePrefWidth(), computePrefHeight(), computeMaxWidth(), or computeMaxHeight().
static final double	USE_PREF_SIZE	Sentinel value which can be passed to a control's setMinWidth(), setMinHeight(), setMaxWidth() or setMaxHeight() methods to indicate that the preferred dimension should be used for that max and/or min constraint.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final ReadOnlyBooleanProperty	activatedProperty()	Typically, the tooltip is "activated" when the mouse moves over a Control.
final ObjectProperty<ContentDisplay>	contentDisplayProperty()	Specifies the positioning of the graphic relative to the text.
final ObjectProperty<Font>	fontProperty()	The default font to use for text in the Tooltip.
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
final ContentDisplay	getContentDisplay()	Gets the value of the contentDisplay property.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	The CssMetaData of this Styleable.
final Font	getFont()	Gets the value of the font property.
final Node	getGraphic()	Gets the value of the graphic property.
final double	getGraphicTextGap()	Gets the value of the graphicTextGap property.
final Duration	getHideDelay()	Gets the value of the hideDelay property.
final Duration	getShowDelay()	Gets the value of the showDelay property.
final Duration	getShowDuration()	Gets the value of the showDuration property.
final String	getText()	Gets the value of the text property.
final TextAlignment	getTextAlignment()	Gets the value of the textAlignment property.
final OverrunStyle	getTextOverrun()	Gets the value of the textOverrun property.
final ObjectProperty<Node>	graphicProperty()	An optional icon for the Tooltip.
final DoubleProperty	graphicTextGapProperty()	The amount of space between the graphic and text
final ObjectProperty<Duration>	hideDelayProperty()	The duration in which to continue showing the tooltip after the mouse has left the node.
static void	install(Node node, Tooltip t)	Associates the given Tooltip with the given Node.
final boolean	isActivated()	Gets the value of the activated property.
final boolean	isWrapText()	Gets the value of the wrapText property.
final void	setContentDisplay(ContentDisplay value)	Sets the value of the contentDisplay property.
final void	setFont(Font value)	Sets the value of the font property.
final void	setGraphic(Node value)	Sets the value of the graphic property.
final void	setGraphicTextGap(double value)	Sets the value of the graphicTextGap property.
final void	setHideDelay(Duration hideDelay)	Sets the value of the hideDelay property.
final void	setShowDelay(Duration showDelay)	Sets the value of the showDelay property.
final void	setShowDuration(Duration showDuration)	Sets the value of the showDuration property.
final void	setText(String value)	Sets the value of the text property.
final void	setTextAlignment(TextAlignment value)	Sets the value of the textAlignment property.
final void	setTextOverrun(OverrunStyle value)	Sets the value of the textOverrun property.
final void	setWrapText(boolean value)	Sets the value of the wrapText property.
final ObjectProperty<Duration>	showDelayProperty()	The delay between the mouse entering the hovered node and when the associated tooltip will be shown to the user.
final ObjectProperty<Duration>	showDurationProperty()	The duration that the tooltip should remain showing for until it is no longer visible to the user.
final ObjectProperty<TextAlignment>	textAlignmentProperty()	Specifies the behavior for lines of text when text is multiline.
final ObjectProperty<OverrunStyle>	textOverrunProperty()	Specifies the behavior to use if the text of the Tooltip exceeds the available space for rendering the text.
final StringProperty	textProperty()	The text to display in the tooltip.
static void	uninstall(Node node, Tooltip t)	Removes the association of the given Tooltip on the specified Node.
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.

Methods declared in class 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

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()	Create a new instance of the default skin for this control.
final String	getId()	The id of this PopupControl.
final double	getMaxHeight()	Property for overriding the control's computed maximum height.
final double	getMaxWidth()	Property for overriding the control's computed maximum width.
final double	getMinHeight()	Property for overriding the control's computed minimum height.
final double	getMinWidth()	Property for overriding the control's computed minimum width.
final double	getPrefHeight()	Property for overriding the control's computed preferred height.
final double	getPrefWidth()	Property for overriding the control's computed preferred width.
final ObservableSet<PseudoClass>	getPseudoClassStates()	Return the pseudo-class state of this Styleable.
final Skin<?>	getSkin()	Gets the value of the skin property.
final String	getStyle()	Gets the value of the style property.
Styleable	getStyleableParent()	Return the parent of this Styleable, or null if there is no parent.
final ObservableList<String>	getStyleClass()	Returns the list of String identifiers that make up the styleClass for this PopupControl.
String	getTypeSelector()	The type of this Styleable that is to be used in selector matching.
final StringProperty	idProperty()	The id of this PopupControl.
final double	maxHeight(double width)	Called during layout to determine the maximum height for this node.
final DoubleProperty	maxHeightProperty()	Property for overriding the control's computed maximum height.
final double	maxWidth(double height)	Called during layout to determine the maximum width for this node.
final DoubleProperty	maxWidthProperty()	Property for overriding the control's computed maximum width.
final double	minHeight(double width)	Called during layout to determine the minimum height for this node.
final DoubleProperty	minHeightProperty()	Property for overriding the control's computed minimum height.
final double	minWidth(double height)	Called during layout to determine the minimum width for this node.
final DoubleProperty	minWidthProperty()	Property for overriding the control's computed minimum width.
final double	prefHeight(double width)	Called during layout to determine the preferred height for this node.
final DoubleProperty	prefHeightProperty()	Property for overriding the control's computed preferred height.
final double	prefWidth(double height)	Called during layout to determine the preferred width for this node.
final DoubleProperty	prefWidthProperty()	Property for overriding the control's computed preferred width.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this node has changed.
final void	setId(String value)	Sets the id of this PopupControl.
final void	setMaxHeight(double value)	Property for overriding the control's computed maximum height.
void	setMaxSize(double maxWidth, double maxHeight)	Convenience method for overriding the control's computed maximum width and height.
final void	setMaxWidth(double value)	Property for overriding the control's computed maximum width.
final void	setMinHeight(double value)	Property for overriding the control's computed minimum height.
void	setMinSize(double minWidth, double minHeight)	Convenience method for overriding the control's computed minimum width and height.
final void	setMinWidth(double value)	Property for overriding the control's computed minimum width.
final void	setPrefHeight(double value)	Property for overriding the control's computed preferred height.
void	setPrefSize(double prefWidth, double prefHeight)	Convenience method for overriding the control's computed preferred width and height.
final void	setPrefWidth(double value)	Property for overriding the control's computed preferred width.
final void	setSkin(Skin<?> value)	Sets the value of the skin property.
final void	setStyle(String value)	Sets the value of the style property.
final ObjectProperty<Skin<?>>	skinProperty()	Skin is responsible for rendering this PopupControl.
final StringProperty	styleProperty()	A string representation of the CSS style associated with this specific PopupControl.

Methods declared in class 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

Modifier and Type	Method	Description
final ObjectProperty<PopupWindow.AnchorLocation>	anchorLocationProperty()	Specifies the popup anchor point which is used in popup positioning.
final ReadOnlyDoubleProperty	anchorXProperty()	Specifies the x coordinate of the popup anchor point on the screen.
final ReadOnlyDoubleProperty	anchorYProperty()	Specifies the y coordinate of the popup anchor point on the screen.
final BooleanProperty	autoFixProperty()	This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.
final BooleanProperty	autoHideProperty()	Specifies whether Popups should auto hide.
final BooleanProperty	consumeAutoHidingEventsProperty()	Specifies whether the event, which caused the Popup to hide, should be consumed.
final PopupWindow.AnchorLocation	getAnchorLocation()	Gets the value of the anchorLocation property.
final double	getAnchorX()	Gets the value of the anchorX property.
final double	getAnchorY()	Gets the value of the anchorY property.
final boolean	getConsumeAutoHidingEvents()	Gets the value of the consumeAutoHidingEvents property.
final EventHandler<Event>	getOnAutoHide()	Gets the value of the onAutoHide property.
final Node	getOwnerNode()	Gets the value of the ownerNode property.
final Window	getOwnerWindow()	Gets the value of the ownerWindow property.
void	hide()	Hide this Popup and all its children
final BooleanProperty	hideOnEscapeProperty()	Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
final boolean	isAutoFix()	Gets the value of the autoFix property.
final boolean	isAutoHide()	Gets the value of the autoHide property.
final boolean	isHideOnEscape()	Gets the value of the hideOnEscape property.
final ObjectProperty<EventHandler<Event>>	onAutoHideProperty()	Called after autoHide is run.
final ReadOnlyObjectProperty<Node>	ownerNodeProperty()	The node which is the owner of this popup.
final ReadOnlyObjectProperty<Window>	ownerWindowProperty()	The window which is the parent of this popup.
final void	setAnchorLocation(PopupWindow.AnchorLocation value)	Sets the value of the anchorLocation property.
final void	setAnchorX(double value)	Sets the value of the anchorX property.
final void	setAnchorY(double value)	Sets the value of the anchorY property.
final void	setAutoFix(boolean value)	Sets the value of the autoFix property.
final void	setAutoHide(boolean value)	Sets the value of the autoHide property.
final void	setConsumeAutoHidingEvents(boolean value)	Sets the value of the consumeAutoHidingEvents property.
final void	setHideOnEscape(boolean value)	Sets the value of the hideOnEscape property.
final void	setOnAutoHide(EventHandler<Event> value)	Sets the value of the onAutoHide property.
protected final void	setScene(Scene scene)	Note to subclasses: the scene used by PopupWindow is very specifically managed by PopupWindow.
void	show(Node ownerNode, double anchorX, double anchorY)	Shows the popup at the specified location on the screen.
void	show(Window owner)	Show the popup.
void	show(Window ownerWindow, double anchorX, double anchorY)	Shows the popup at the specified location on the screen.

Methods declared in class 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

Modifier and Type	Method	Description
final <T extends Event> void	addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Registers an event filter for this target.
final <T extends Event> void	addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Registers an event handler for this target.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)	Construct an event dispatch chain for this target.
void	centerOnScreen()	Sets x and y properties on this Window so that it is centered on the current screen.
final ObjectProperty<EventDispatcher>	eventDispatcherProperty()	Specifies the event dispatcher for this node.
final void	fireEvent(Event event)	Fires the specified event.
final ReadOnlyBooleanProperty	focusedProperty()	Whether or not this Window has the keyboard or input focus.
final BooleanProperty	forceIntegerRenderScaleProperty()	Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale.
final EventDispatcher	getEventDispatcher()	Gets the value of the eventDispatcher property.
final double	getHeight()	Gets the value of the height property.
final EventHandler<WindowEvent>	getOnCloseRequest()	Gets the value of the onCloseRequest property.
final EventHandler<WindowEvent>	getOnHidden()	Gets the value of the onHidden property.
final EventHandler<WindowEvent>	getOnHiding()	Gets the value of the onHiding property.
final EventHandler<WindowEvent>	getOnShowing()	Gets the value of the onShowing property.
final EventHandler<WindowEvent>	getOnShown()	Gets the value of the onShown property.
final double	getOpacity()	Gets the value of the opacity property.
final double	getOutputScaleX()	Gets the value of the outputScaleX property.
final double	getOutputScaleY()	Gets the value of the outputScaleY property.
final ObservableMap<Object,Object>	getProperties()	Returns an observable map of properties on this node for use primarily by application developers.
final double	getRenderScaleX()	Gets the value of the renderScaleX property.
final double	getRenderScaleY()	Gets the value of the renderScaleY property.
final Scene	getScene()	Gets the value of the scene property.
Object	getUserData()	Returns a previously set Object property, or null if no such property has been set using the Window.setUserData(java.lang.Object) method.
final double	getWidth()	Gets the value of the width property.
static ObservableList<Window>	getWindows()	Returns a list containing a reference to the currently showing JavaFX windows.
final double	getX()	Gets the value of the x property.
final double	getY()	Gets the value of the y property.
boolean	hasProperties()	Tests if Window has properties.
final ReadOnlyDoubleProperty	heightProperty()	The height of this Window.
final boolean	isFocused()	Gets the value of the focused property.
final boolean	isForceIntegerRenderScale()	Gets the value of the forceIntegerRenderScale property.
final boolean	isShowing()	Gets the value of the showing property.
final ObjectProperty<EventHandler<WindowEvent>>	onCloseRequestProperty()	Called when there is an external request to close this Window.
final ObjectProperty<EventHandler<WindowEvent>>	onHiddenProperty()	Called just after the Window has been hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onHidingProperty()	Called just prior to the Window being hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onShowingProperty()	Called just prior to the Window being shown.
final ObjectProperty<EventHandler<WindowEvent>>	onShownProperty()	Called just after the Window is shown.
final DoubleProperty	opacityProperty()	Defines the opacity of the Window as a value between 0.0 and 1.0.
final ReadOnlyDoubleProperty	outputScaleXProperty()	The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final ReadOnlyDoubleProperty	outputScaleYProperty()	The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final <T extends Event> void	removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Unregisters a previously registered event filter from this target.
final <T extends Event> void	removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Unregisters a previously registered event handler from this target.
final DoubleProperty	renderScaleXProperty()	The horizontal scale that the Window will use when rendering its Scene to the rendering buffer.
final DoubleProperty	renderScaleYProperty()	The vertical scale that the Window will use when rendering its Scene to the rendering buffer.
final void	requestFocus()	Requests that this Window get the input focus.
final ReadOnlyObjectProperty<Scene>	sceneProperty()	The Scene to be rendered on this Window.
final void	setEventDispatcher(EventDispatcher value)	Sets the value of the eventDispatcher property.
protected final <T extends Event> void	setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Sets the handler to use for this event type.
final void	setForceIntegerRenderScale(boolean forced)	Sets the value of the forceIntegerRenderScale property.
final void	setHeight(double value)	Sets the value of the height property.
final void	setOnCloseRequest(EventHandler<WindowEvent> value)	Sets the value of the onCloseRequest property.
final void	setOnHidden(EventHandler<WindowEvent> value)	Sets the value of the onHidden property.
final void	setOnHiding(EventHandler<WindowEvent> value)	Sets the value of the onHiding property.
final void	setOnShowing(EventHandler<WindowEvent> value)	Sets the value of the onShowing property.
final void	setOnShown(EventHandler<WindowEvent> value)	Sets the value of the onShown property.
final void	setOpacity(double value)	Sets the value of the opacity property.
final void	setRenderScaleX(double scale)	Sets the value of the renderScaleX property.
final void	setRenderScaleY(double scale)	Sets the value of the renderScaleY property.
void	setUserData(Object value)	Convenience method for setting a single Object property that can be retrieved at a later date.
final void	setWidth(double value)	Sets the value of the width property.
final void	setX(double value)	Sets the value of the x property.
final void	setY(double value)	Sets the value of the y property.
protected void	show()	Attempts to show this Window by setting visibility to true
final ReadOnlyBooleanProperty	showingProperty()	Whether or not this Window is showing (that is, open on the user's system).
void	sizeToScene()	Set the width and height of this Window to match the size of the content of this Window's Scene.
final ReadOnlyDoubleProperty	widthProperty()	The width of this Window.
final ReadOnlyDoubleProperty	xProperty()	The horizontal location of this Window on the screen.
final ReadOnlyDoubleProperty	yProperty()	The vertical location of this Window on the screen.

Methods declared in class Object

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

Methods declared in interface Styleable

getStyleableNode

Modifier and Type	Method	Description
default Node	getStyleableNode()	Returns the Node that represents this Styleable object.

Property Details

text

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.

See Also:

• getText()
• setText(String)
• textProperty()

textAlignment

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.

See Also:

• getTextAlignment()
• setTextAlignment(TextAlignment)
• textAlignmentProperty()

textOverrun

public final ObjectProperty<OverrunStyle> textOverrunProperty

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

See Also:

• getTextOverrun()
• setTextOverrun(OverrunStyle)
• textOverrunProperty()

wrapText

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.

See Also:

• isWrapText()
• setWrapText(boolean)
• wrapTextProperty()

font

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.

See Also:

• getFont()
• setFont(Font)
• fontProperty()

showDelay

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.

Default value:

1000ms

Since:

9

See Also:

• getShowDelay()
• setShowDelay(Duration)
• showDelayProperty()

showDuration

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.

Default value:

5000ms

Since:

9

See Also:

• getShowDuration()
• setShowDuration(Duration)
• showDurationProperty()

hideDelay

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.

Default value:

200ms

Since:

9

See Also:

• getHideDelay()
• setHideDelay(Duration)
• hideDelayProperty()

graphic

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.

See Also:

• getGraphic()
• setGraphic(Node)
• graphicProperty()

contentDisplay

public final ObjectProperty<ContentDisplay> contentDisplayProperty

Specifies the positioning of the graphic relative to the text.

See Also:

• getContentDisplay()
• setContentDisplay(ContentDisplay)
• contentDisplayProperty()

graphicTextGap

public final DoubleProperty graphicTextGapProperty

The amount of space between the graphic and text

See Also:

• getGraphicTextGap()
• setGraphicTextGap(double)
• graphicTextGapProperty()

activated

public final ReadOnlyBooleanProperty activatedProperty

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.

See Also:

• isActivated()
• activatedProperty()

Constructor Details

Tooltip

public Tooltip()

Creates a tooltip with an empty string for its text.

Tooltip

public Tooltip(String text)

Creates a tooltip with the specified text.

Parameters:

text - A text string for the tooltip.

Method Details

install

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 - the node

t - the tooltip

See Also:

• Tooltip

uninstall

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 - the node

t - the tooltip

See Also:

• Tooltip

textProperty

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:

the text property

See Also:

• getText()
• setText(String)

setText

public final void setText(String value)

Sets the value of the text property.

Property description:

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.

Parameters:

value - the value for the text property

See Also:

• getText()
• textProperty()

getText

public final String getText()

Gets the value of the text property.

Property description:

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:

the value of the text property

See Also:

• setText(String)
• textProperty()

textAlignmentProperty

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:

the text alignment property

See Also:

• getTextAlignment()
• setTextAlignment(TextAlignment)

setTextAlignment

public final void setTextAlignment(TextAlignment value)

Sets the value of the textAlignment property.

Property description:

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.

Parameters:

value - the value for the textAlignment property

See Also:

• getTextAlignment()
• textAlignmentProperty()

getTextAlignment

public final TextAlignment getTextAlignment()

Gets the value of the textAlignment property.

Property description:

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:

the value of the textAlignment property

See Also:

• setTextAlignment(TextAlignment)
• textAlignmentProperty()

textOverrunProperty

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:

the text overrun property

See Also:

• getTextOverrun()
• setTextOverrun(OverrunStyle)

setTextOverrun

public final void setTextOverrun(OverrunStyle value)

Sets the value of the textOverrun property.

Property description:

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

Parameters:

value - the value for the textOverrun property

See Also:

• getTextOverrun()
• textOverrunProperty()

getTextOverrun

public final OverrunStyle getTextOverrun()

Gets the value of the textOverrun property.

Property description:

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

Returns:

the value of the textOverrun property

See Also:

• setTextOverrun(OverrunStyle)
• textOverrunProperty()

wrapTextProperty

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:

the wrap text property

See Also:

• isWrapText()
• setWrapText(boolean)

setWrapText

public final void setWrapText(boolean value)

Sets the value of the wrapText property.

Property description:

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

Parameters:

value - the value for the wrapText property

See Also:

• isWrapText()
• wrapTextProperty()

isWrapText

public final boolean isWrapText()

Gets the value of the wrapText property.

Property description:

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

Returns:

the value of the wrapText property

See Also:

• setWrapText(boolean)
• wrapTextProperty()

fontProperty

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:

the font property

See Also:

• getFont()
• setFont(Font)

setFont

public final void setFont(Font value)

Sets the value of the font property.

Property description:

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.

Parameters:

value - the value for the font property

See Also:

• getFont()
• fontProperty()

getFont

public final Font getFont()

Gets the value of the font property.

Property description:

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:

the value of the font property

See Also:

• setFont(Font)
• fontProperty()

showDelayProperty

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.

Default value:

1000ms

Returns:

show delay property

Since:

9

See Also:

• getShowDelay()
• setShowDelay(Duration)

setShowDelay

public final void setShowDelay(Duration showDelay)

Sets the value of the showDelay property.

Property description:

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.

Default value:

1000ms

Parameters:

showDelay - the value for the showDelay property

Since:

9

See Also:

• getShowDelay()
• showDelayProperty()

getShowDelay

public final Duration getShowDelay()

Gets the value of the showDelay property.

Property description:

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.

Default value:

1000ms

Returns:

the value of the showDelay property

Since:

9

See Also:

• setShowDelay(Duration)
• showDelayProperty()

showDurationProperty

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.

Default value:

5000ms

Returns:

the show duration property

Since:

9

See Also:

• getShowDuration()
• setShowDuration(Duration)

setShowDuration

public final void setShowDuration(Duration showDuration)

Sets the value of the showDuration property.

Property description:

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.

Default value:

5000ms

Parameters:

showDuration - the value for the showDuration property

Since:

9

See Also:

• getShowDuration()
• showDurationProperty()

getShowDuration

public final Duration getShowDuration()

Gets the value of the showDuration property.

Property description:

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.

Default value:

5000ms

Returns:

the value of the showDuration property

Since:

9

See Also:

• setShowDuration(Duration)
• showDurationProperty()

hideDelayProperty

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.

Default value:

200ms

Returns:

the hide delay property

Since:

9

See Also:

• getHideDelay()
• setHideDelay(Duration)

setHideDelay

public final void setHideDelay(Duration hideDelay)

Sets the value of the hideDelay property.

Property description:

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.

Default value:

200ms

Parameters:

hideDelay - the value for the hideDelay property

Since:

9

See Also:

• getHideDelay()
• hideDelayProperty()

getHideDelay

public final Duration getHideDelay()

Gets the value of the hideDelay property.

Property description:

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.

Default value:

200ms

Returns:

the value of the hideDelay property

Since:

9

See Also:

• setHideDelay(Duration)
• hideDelayProperty()

graphicProperty

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:

the graphic property

See Also:

• getGraphic()
• setGraphic(Node)

setGraphic

public final void setGraphic(Node value)

Sets the value of the graphic property.

Property description:

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.

Parameters:

value - the value for the graphic property

See Also:

• getGraphic()
• graphicProperty()

getGraphic

public final Node getGraphic()

Gets the value of the graphic property.

Property description:

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:

the value of the graphic property

See Also:

• setGraphic(Node)
• graphicProperty()

contentDisplayProperty

public final ObjectProperty<ContentDisplay> contentDisplayProperty()

Specifies the positioning of the graphic relative to the text.

Returns:

the content display property

See Also:

• getContentDisplay()
• setContentDisplay(ContentDisplay)

setContentDisplay

public final void setContentDisplay(ContentDisplay value)

Sets the value of the contentDisplay property.

Property description:

Specifies the positioning of the graphic relative to the text.

Parameters:

value - the value for the contentDisplay property

See Also:

• getContentDisplay()
• contentDisplayProperty()

getContentDisplay

public final ContentDisplay getContentDisplay()

Gets the value of the contentDisplay property.

Property description:

Specifies the positioning of the graphic relative to the text.

Returns:

the value of the contentDisplay property

See Also:

• setContentDisplay(ContentDisplay)
• contentDisplayProperty()

graphicTextGapProperty

public final DoubleProperty graphicTextGapProperty()

The amount of space between the graphic and text

Returns:

the graphic text gap property

See Also:

• getGraphicTextGap()
• setGraphicTextGap(double)

setGraphicTextGap

public final void setGraphicTextGap(double value)

Sets the value of the graphicTextGap property.

Property description:

The amount of space between the graphic and text

Parameters:

value - the value for the graphicTextGap property

See Also:

• getGraphicTextGap()
• graphicTextGapProperty()

getGraphicTextGap

public final double getGraphicTextGap()

Gets the value of the graphicTextGap property.

Property description:

The amount of space between the graphic and text

Returns:

the value of the graphicTextGap property

See Also:

• setGraphicTextGap(double)
• graphicTextGapProperty()

isActivated

public final boolean isActivated()

Gets the value of the activated property.

Property description:

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.

Returns:

the value of the activated property

See Also:

• activatedProperty()

activatedProperty

public final ReadOnlyBooleanProperty activatedProperty()

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.

Returns:

the activated property

See Also:

• isActivated()

getClassCssMetaData

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

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

Returns:

the CssMetaData

Since:

JavaFX 8.0

getCssMetaData

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

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

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class PopupControl

Returns:

the CssMetaData

Since:

JavaFX 8.0