Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXTooltip

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

javafx.scene.control.PopupControl

io.github.palexdev.materialfx.controls.MFXPopup

io.github.palexdev.materialfx.controls.MFXTooltip

All Implemented Interfaces:

MFXStyleablePopup, Styleable, EventTarget, Skinnable

public class MFXTooltip
extends MFXPopup

MFXTooltip is a special case of MFXPopup. The content is determined by its skin, and also has a userAgentStylesheet to define the default style for all MFXTooltips.

This tooltip also allows you to add an icon!

This popup adds an handler to the owner node to track the mouse location on the node and then uses those coordinated to show itself.

This is the default behavior but it can be easily changed by setting the showActionProperty().

NOTE that since the content of the context menu is entirely determined by its skin, the MFXPopup.contentProperty() will always be null. As a result methods involving Alignment, HPos or VPos will fail with a NullPointerException.

Property Summary

Properties

Type	Property	Description
ObjectProperty<Node>	icon	Specifies the tooltip's icon.
ConsumerProperty<PositionBean>	showAction	This consumer allows the user to decide how to show the tooltip.
StringProperty	text	Specifies the tooltip's text.

Properties inherited from class io.github.palexdev.materialfx.controls.MFXPopup

content, hover

Properties inherited from class javafx.scene.control.PopupControl

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

Properties inherited from class javafx.stage.PopupWindow

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

Properties inherited from class javafx.stage.Window

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

Nested Class Summary

Nested classes/interfaces inherited from class io.github.palexdev.materialfx.controls.MFXPopup

MFXPopup.MFXPopupEvent

Nested classes/interfaces inherited from class javafx.scene.control.PopupControl

PopupControl.CSSBridge

Nested classes/interfaces inherited from class javafx.stage.PopupWindow

PopupWindow.AnchorLocation

Field Summary

Fields inherited from class javafx.scene.control.PopupControl

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor	Description
MFXTooltip(Node owner)
MFXTooltip(Node owner, String text)

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
void	dispose()	Calls uninstall() but also sets all the handlers and the owner node to null, making this context menu not usable anymore.
static void	disposeFor(Node node)	Convenience method to remove a MFXTooltip from the given node.
Duration	getHideAfter()
Node	getIcon()	Gets the value of the property icon.
PositionBean	getMousePosition()
Node	getOwner()
Consumer<PositionBean>	getShowAction()	Gets the value of the property showAction.
Duration	getShowDelay()
String	getText()	Gets the value of the property text.
String	getUserAgentStylesheet()	This method works just like Region.getUserAgentStylesheet().
ObjectProperty<Node>	iconProperty()	Specifies the tooltip's icon.
MFXTooltip	install()	Adds the needed handlers on the owner node.
static MFXTooltip	of(Node owner, String text)	Static method to create a new MFXTooltip with the given parameters.
void	setHideAfter(Duration hideAfter)	Sets the amount of time after which the tooltip is automatically hidden.
void	setIcon(Node icon)	Sets the value of the property icon.
void	setShowAction(Consumer<PositionBean> showAction)	Sets the value of the property showAction.
void	setShowDelay(Duration showDelay)	Sets the amount of time after which the tooltip is shown
void	setText(String text)	Sets the value of the property text.
ConsumerProperty<PositionBean>	showActionProperty()	This consumer allows the user to decide how to show the tooltip.
StringProperty	textProperty()	Specifies the tooltip's text.
void	uninstall()	Removes any added handler from the owner node.

Methods inherited from class io.github.palexdev.materialfx.controls.MFXPopup

computePosition, contentProperty, fixPosition, getAnimationProvider, getContent, getPopupStyleableParent, getPosition, getStyleableParent, getStyleSheets, hide, hoverProperty, isAnimated, isFixPosition, isHover, reposition, setAnimated, setAnimationProvider, setContent, setHover, setPopupStyleableParent, show, show, show, show

Methods inherited from class javafx.scene.control.PopupControl

getClassCssMetaData, getCssMetaData, getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleableNode, 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

Methods inherited from class javafx.stage.PopupWindow

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

Methods inherited from class 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

Methods inherited from class java.lang.Object

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

Property Details

showAction

public ConsumerProperty<PositionBean> showActionProperty

This consumer allows the user to decide how to show the tooltip. The consumer carries the tracked mouse position, see getMousePosition().

By default, calls MFXPopup.show(Node, double, double).

See Also:

• getShowAction()
• setShowAction(Consumer)

icon

public ObjectProperty<Node> iconProperty

Specifies the tooltip's icon.

See Also:

• getIcon()
• setIcon(Node)

text

public StringProperty textProperty

Specifies the tooltip's text.

See Also:

• getText()
• setText(String)

Constructor Details

MFXTooltip

public MFXTooltip(Node owner)

MFXTooltip

public MFXTooltip(Node owner,
 String text)

Method Details

of

public static MFXTooltip of(Node owner,
 String text)

Static method to create a new MFXTooltip with the given parameters.

disposeFor

public static void disposeFor(Node node)

Convenience method to remove a MFXTooltip from the given node.

install

public MFXTooltip install()

Adds the needed handlers on the owner node.

uninstall

public void uninstall()

Removes any added handler from the owner node.

dispose

public void dispose()

Calls uninstall() but also sets all the handlers and the owner node to null, making this context menu not usable anymore.

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class MFXPopup

getUserAgentStylesheet

public String getUserAgentStylesheet()

Description copied from interface: MFXStyleablePopup

This method works just like Region.getUserAgentStylesheet().

Any MFXStyleablePopup should offer the possibility of setting a base stylesheet. It's up to the skin on how to use it though (an example can be found here MFXContextMenuSkin).

Specified by:

getUserAgentStylesheet in interface MFXStyleablePopup

Overrides:

getUserAgentStylesheet in class MFXPopup

getOwner

public Node getOwner()

Returns:

this context menu's owner

getMousePosition

public PositionBean getMousePosition()

getShowAction

public Consumer<PositionBean> getShowAction()

Gets the value of the property showAction.

Property description:

This consumer allows the user to decide how to show the tooltip. The consumer carries the tracked mouse position, see getMousePosition().

By default, calls MFXPopup.show(Node, double, double).

showActionProperty

public ConsumerProperty<PositionBean> showActionProperty()

This consumer allows the user to decide how to show the tooltip. The consumer carries the tracked mouse position, see getMousePosition().

By default, calls MFXPopup.show(Node, double, double).

See Also:

• getShowAction()
• setShowAction(Consumer)

setShowAction

public void setShowAction(Consumer<PositionBean> showAction)

Sets the value of the property showAction.

Property description:

This consumer allows the user to decide how to show the tooltip. The consumer carries the tracked mouse position, see getMousePosition().

By default, calls MFXPopup.show(Node, double, double).

getIcon

public Node getIcon()

Gets the value of the property icon.

Property description:

Specifies the tooltip's icon.

iconProperty

public ObjectProperty<Node> iconProperty()

Specifies the tooltip's icon.

See Also:

• getIcon()
• setIcon(Node)

setIcon

public void setIcon(Node icon)

Sets the value of the property icon.

Property description:

Specifies the tooltip's icon.

getText

public String getText()

Gets the value of the property text.

Property description:

Specifies the tooltip's text.

textProperty

public StringProperty textProperty()

Specifies the tooltip's text.

See Also:

• getText()
• setText(String)

setText

public void setText(String text)

Sets the value of the property text.

Property description:

Specifies the tooltip's text.

getShowDelay

public Duration getShowDelay()

Returns:

the amount of time after which the tooltip is shown

setShowDelay

public void setShowDelay(Duration showDelay)

Sets the amount of time after which the tooltip is shown

getHideAfter

public Duration getHideAfter()

Returns:

the amount of time after which the tooltip is automatically hidden

setHideAfter

public void setHideAfter(Duration hideAfter)

Sets the amount of time after which the tooltip is automatically hidden.