class: Tooltip

[112:7] extends: FxObj

The Tooltip class wraps the JavaFX Tooltip control, a small popup that displays informational text when the user hovers the mouse pointer over an attached node. Tooltips support plain text, an optional graphic image, text wrapping, and configurable show/hide timing through CSS duration properties. A Tooltip is a PopupControl rather than a standard scene-graph node, but it still supports Control, Region, and Node CSS properties through its PopupControl base class. Use the install method to attach a Tooltip to any scene-graph node.

CSS Properties -- Tooltip

Property	Values	Default	Description
`-fx-text-alignment`	`left \| center \| right \| justify`	`left`	Horizontal alignment of text within the tooltip.
`-fx-text-overrun`	`center-ellipsis \| center-word-ellipsis \| clip \| ellipsis \| leading-ellipsis \| leading-word-ellipsis \| word-ellipsis`	`ellipsis`	Behavior when tooltip text is too long to fit.
`-fx-wrap-text`	`true \| false`	`false`	When true, text wraps to additional lines instead of being truncated.
`-fx-graphic`	`<uri>`	`null`	URI of an image to display alongside the tooltip text.
`-fx-content-display`	`top \| right \| bottom \| left \| center \| graphic-only \| text-only`	`left`	Position of the graphic relative to the text.
`-fx-graphic-text-gap`	`<size>`	`4`	Pixel gap between the graphic and the text.
`-fx-font`	`<font>`	Font.DEFAULT (inherits)	Font used to render the tooltip text. Inherits from parent by default.
`-fx-show-delay`	`<duration>`	`1000ms`	Delay before the tooltip appears after the cursor enters the node.
`-fx-show-duration`	`<duration>`	`5000ms`	How long the tooltip remains visible before automatically hiding.
`-fx-hide-delay`	`<duration>`	`200ms`	Delay before the tooltip disappears after the cursor leaves the node.

CSS Properties -- Control

Property	Values	Default	Description
`-fx-skin`	`<string>`	`null`	Fully qualified class name of the Skin to use for rendering this control.
`-fx-focus-traversable`	`true \| false`	`true`	When true, the control participates in focus traversal via the keyboard Tab key.

CSS Properties -- Region

Background fills

Property	Values	Default	Description
`-fx-background-color`	`<paint> [, <paint>]*`	`transparent`	One or more paint values for background fill layers, rendered back to front.
`-fx-background-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`0 0 0 0`	Insets from the region edges for each background fill layer.
`-fx-background-radius`	`<size> [/ <size>]* [, ...]*`	`0 0 0 0`	Corner radii for each background fill layer.

Background images

Property	Values	Default	Description
`-fx-background-image`	`<uri> [, <uri>]*`	`null`	One or more image URIs for background image layers.
`-fx-background-position`	`<bg-position> [, ...]*`	`0% 0%`	Position of each background image within the region. Accepts keywords or size values.
`-fx-background-repeat`	`<repeat-style> [, ...]*`	`repeat repeat`	Tiling behavior for each background image. Values: repeat, no-repeat, round, space applied per axis.
`-fx-background-size`	`<bg-size> [, ...]*`	`auto auto`	Dimensions for each background image. Supports cover, contain, stretch, or explicit sizes.

Stroked borders

Property	Values	Default	Description
`-fx-border-color`	`<paint>` or `<t> <r> <b> <l>` [, ...]*	`null`	Paint colors for the border stroke layers.
`-fx-border-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`null`	Insets from region edges for each border layer.
`-fx-border-radius`	`<size> [, ...]*`	`null`	Corner radii for border stroke layers.
`-fx-border-style`	`<border-style> [, ...]*`	`null`	Border line style (solid, dotted, dashed) plus phase and line cap/join options per layer.
`-fx-border-width`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`null`	Thickness of each border stroke layer, per side.

Border images

Property	Values	Default	Description
`-fx-border-image-source`	`<uri> [, <uri>]*`	`null`	Image URIs used to paint the border.
`-fx-border-image-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`0 0 0 0`	Insets for each border image layer.
`-fx-border-image-repeat`	`<repeat-style> [, ...]*`	`repeat repeat`	Tiling behavior for each border image.
`-fx-border-image-slice`	`<size>` or `<t> <r> <b> <l>` [fill] [, ...]*	`100%`	Divides each border image into nine regions. Adding fill preserves the center region.
`-fx-border-image-width`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`1 1 1 1`	Width of each border image slice per side.

Other Region properties

Property	Values	Default	Description
`-fx-padding`	`<size>` or `<t> <r> <b> <l>`	`0 0 0 0`	Interior padding between the region border and its content.
`-fx-shape`	`<string>`	`null`	SVG path string that defines a custom clip shape for the region.
`-fx-scale-shape`	`true \| false`	`true`	When true, the shape is scaled to fit the region.
`-fx-position-shape`	`true \| false`	`true`	When true, the shape is centered within the region.
`-fx-snap-to-pixel`	`true \| false`	`true`	When true, positions and sizes are rounded to whole pixel boundaries.
`-fx-min-width`	`<size>`	`-1`	Minimum width. -1 uses the computed minimum.
`-fx-pref-width`	`<size>`	`-1`	Preferred width. -1 uses the computed preferred.
`-fx-max-width`	`<size>`	`-1`	Maximum width. -1 uses the computed maximum.
`-fx-min-height`	`<size>`	`-1`	Minimum height. -1 uses the computed minimum.
`-fx-pref-height`	`<size>`	`-1`	Preferred height. -1 uses the computed preferred.
`-fx-max-height`	`<size>`	`-1`	Maximum height. -1 uses the computed maximum.

CSS Properties -- Node

Property	Values	Default	Description
`-fx-blend-mode`	`add \| blue \| color-burn \| color-dodge \| darken \| difference \| exclusion \| green \| hard-light \| lighten \| multiply \| overlay \| red \| screen \| soft-light \| src-atop \| src-in \| src-out \| src-over`	`null`	Blend mode used when compositing this node with nodes beneath it.
`-fx-cursor`	`null \| crosshair \| default \| hand \| move \| e-resize \| h-resize \| ne-resize \| nw-resize \| n-resize \| se-resize \| sw-resize \| s-resize \| w-resize \| v-resize \| text \| wait \| <url>`	`null` (inherits)	Mouse cursor shape shown when the pointer is over this node. Inherits from parent by default.
`-fx-effect`	`<effect>`	`null`	A visual effect (e.g. DropShadow, InnerShadow) applied to the rendered node.
`-fx-focus-traversable`	`true \| false`	`false`	Whether this node participates in focus traversal. Overridden to `true` by Control.
`-fx-view-order`	`<number>`	`0`	Adjusts rendering and hit-test order within the parent without changing the scene graph order.
`-fx-opacity`	`<number> [0.0 - 1.0]`	`1`	Opacity of the node. 0 is fully transparent, 1 is fully opaque.
`-fx-rotate`	`<number>`	`0`	Rotation angle in degrees applied around the node's center point. Positive values are clockwise.
`-fx-scale-x`	`<number>`	`1`	Scale factor along the X axis about the node's center.
`-fx-scale-y`	`<number>`	`1`	Scale factor along the Y axis about the node's center.
`-fx-scale-z`	`<number>`	`1`	Scale factor along the Z axis about the node's center.
`-fx-translate-x`	`<number>`	`0`	Translation offset along the X axis in pixels.
`-fx-translate-y`	`<number>`	`0`	Translation offset along the Y axis in pixels.
`-fx-translate-z`	`<number>`	`0`	Translation offset along the Z axis in pixels.
`visibility`	`visible \| hidden \| collapse \| inherit`	`visible`	Controls whether the node is rendered and participates in layout. `collapse` removes it from layout; `hidden` keeps the space.
`-fx-managed`	`true \| false`	`true`	When false, the parent layout does not manage this node's position or size.

Methods

Tooltip (string Val)

Initializes a new Tooltip instance with the specified text.
- @p Val Val is a string to set as the text of the tooltip.
- @r this object
getText ()

Returns the text currently displayed by this Tooltip.
- @r A string with the tooltip text.
setText (string Text)

Sets the text displayed by this Tooltip.
- @p Text is a string with the tooltip text.
- @r this object for chaining
setGraphic (object GraphicNode)

Sets a graphic node to display alongside the tooltip text.
- @p GraphicNode is a Node object to use as the graphic.
- @r this object for chaining
setFont (object FontObj)

Sets the font used to render the tooltip text.
- @p FontObj is a Font object to apply.
- @r this object for chaining
setWrapText (bool Wrap)

Sets whether the tooltip text wraps to additional lines when too long.
- @p Wrap is a bool with true to enable text wrapping.
- @r this object for chaining
setShowDelay (double DurationMs)

Sets the delay before the tooltip appears after the cursor enters the node.
- @p DurationMs is a double with the delay in milliseconds.
- @r this object for chaining
setHideDelay (double DurationMs)

Sets the delay before the tooltip disappears after the cursor leaves the node.
- @p DurationMs is a double with the delay in milliseconds.
- @r this object for chaining
setShowDuration (double DurationMs)

Sets how long the tooltip remains visible before automatically hiding.
- @p DurationMs is a double with the duration in milliseconds.
- @r this object for chaining
setAnchorLocation (string Location)

Sets the anchor location that determines how the tooltip is positioned relative to the cursor.
- @p Location is a string with the AnchorLocation constant name.
- @r this object for chaining
install (InstallTo)

Installs the Tooltip on a specified node, so it displays when the user hovers over that node.
- @p InstallTo The node object to which the tooltip should be attached.
- @r this object for chaining
uninstall (UninstallFrom)

Removes the Tooltip from the specified node.
- @p UninstallFrom is the Node object from which to remove the tooltip.
- @r this object for chaining