jidefx.scene.control.popup

Class TooltipEx

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

javafx.scene.control.PopupControl

jidefx.scene.control.popup.TooltipEx

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class TooltipEx
extends javafx.scene.control.PopupControl

Copied from Tooltip (jdk8 ea build 96) to support tooltip position. The code changes are tagged by // Added in JideFX. This class is not intended to be a public API. We might remove this class in the future if JavaFX tooltip supports the tooltip position or we find a better solution.

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyBooleanProperty	activated Typically, the tooltip is "activated" when the mouse moves over a Control.
javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay>	contentDisplay Specifies the positioning of the graphic relative to the text.
javafx.beans.property.ObjectProperty<javafx.scene.text.Font>	font The default font to use for text in the Tooltip.
javafx.beans.property.ObjectProperty<javafx.scene.Node>	graphic An optional icon for the Tooltip.
javafx.beans.property.DoubleProperty	graphicTextGap The amount of space between the graphic and text
javafx.beans.property.ObjectProperty<javafx.geometry.Pos>	pos
javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment>	textAlignment Specifies the behavior for lines of text when text is multiline.
javafx.beans.property.ObjectProperty<javafx.scene.control.OverrunStyle>	textOverrun Specifies the behavior to use if the text of the Tooltip exceeds the available space for rendering the text.
javafx.beans.property.StringProperty	text The text to display in the tooltip.
javafx.beans.property.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 inherited from class javafx.scene.control.PopupControl

idProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, prefHeightProperty, prefWidthProperty, skinProperty, styleProperty

Properties inherited from class javafx.stage.PopupWindow

alignWithContentOriginProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, hideOnEscapeProperty, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty

Properties inherited from class javafx.stage.Window

eventDispatcherProperty, focusedProperty, heightProperty, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, sceneProperty, showingProperty, widthProperty, xProperty, yProperty

Field Summary

Fields inherited from class javafx.scene.control.PopupControl

bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.stage.Window

impl_peer, peerListener

Constructor Summary

Constructors

Constructor and Description
TooltipEx() Creates a tooltip with an empty string for its text.
TooltipEx(java.lang.String text) Creates a tooltip with the specified text.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyBooleanProperty	activatedProperty() Typically, the tooltip is "activated" when the mouse moves over a Control.
javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay>	contentDisplayProperty() Specifies the positioning of the graphic relative to the text.
protected javafx.scene.control.Skin<?>	createDefaultSkin()
javafx.beans.property.ObjectProperty<javafx.scene.text.Font>	fontProperty() The default font to use for text in the Tooltip.
static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData()
javafx.scene.control.ContentDisplay	getContentDisplay() Gets the value of the property contentDisplay.
java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getCssMetaData()
javafx.scene.text.Font	getFont() Gets the value of the property font.
javafx.scene.Node	getGraphic() Gets the value of the property graphic.
double	getGraphicTextGap() Gets the value of the property graphicTextGap.
javafx.geometry.Pos	getPos() Gets the value of the property pos.
javafx.css.Styleable	getStyleableParent()
java.lang.String	getText() Gets the value of the property text.
javafx.scene.text.TextAlignment	getTextAlignment() Gets the value of the property textAlignment.
javafx.scene.control.OverrunStyle	getTextOverrun() Gets the value of the property textOverrun.
javafx.beans.property.ObjectProperty<javafx.scene.Node>	graphicProperty() An optional icon for the Tooltip.
javafx.beans.property.DoubleProperty	graphicTextGapProperty() The amount of space between the graphic and text
static void	install(javafx.scene.Node node, TooltipEx t) Associates the given TooltipEx with the given <code>Node</code>.
boolean	isActivated() Gets the value of the property activated.
boolean	isWrapText() Gets the value of the property wrapText.
javafx.beans.property.ObjectProperty<javafx.geometry.Pos>	posProperty()
void	setContentDisplay(javafx.scene.control.ContentDisplay value) Sets the value of the property contentDisplay.
void	setFont(javafx.scene.text.Font value) Sets the value of the property font.
void	setGraphic(javafx.scene.Node value) Sets the value of the property graphic.
void	setGraphicTextGap(double value) Sets the value of the property graphicTextGap.
void	setPos(javafx.geometry.Pos pos) Sets the value of the property pos.
void	setText(java.lang.String value) Sets the value of the property text.
void	setTextAlignment(javafx.scene.text.TextAlignment value) Sets the value of the property textAlignment.
void	setTextOverrun(javafx.scene.control.OverrunStyle value) Sets the value of the property textOverrun.
void	setWrapText(boolean value) Sets the value of the property wrapText.
javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment>	textAlignmentProperty() Specifies the behavior for lines of text when text is multiline.
javafx.beans.property.ObjectProperty<javafx.scene.control.OverrunStyle>	textOverrunProperty() Specifies the behavior to use if the text of the Tooltip exceeds the available space for rendering the text.
javafx.beans.property.StringProperty	textProperty() The text to display in the tooltip.
static void	uninstall(javafx.scene.Node node, TooltipEx t) Removes the association of the given TooltipEx on the specified <code>Node</code>.
javafx.beans.property.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 inherited from class javafx.scene.control.PopupControl

getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleClass, getTypeSelector, idProperty, impl_styleableGetNode, 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

alignWithContentOriginProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, getConsumeAutoHidingEvents, getContent, getOnAutoHide, getOwnerNode, getOwnerWindow, hide, hideOnEscapeProperty, impl_visibleChanged, impl_visibleChanging, isAlignWithContentOrigin, isAutoFix, isAutoHide, isHideOnEscape, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty, setAlignWithContentOrigin, setAutoFix, setAutoHide, setConsumeAutoHidingEvents, setHideOnEscape, setOnAutoHide, setScene, show, show, show

Methods inherited from class javafx.stage.Window

addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getScene, getWidth, getX, getY, heightProperty, impl_getMXWindowType, impl_getPeer, impl_getWindows, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setFocused, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, 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 Detail

text

public final javafx.beans.property.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)

textAlignment

public final javafx.beans.property.ObjectProperty<javafx.scene.text.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)

textOverrun

public final javafx.beans.property.ObjectProperty<javafx.scene.control.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)

wrapText

public final javafx.beans.property.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)

font

public final javafx.beans.property.ObjectProperty<javafx.scene.text.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)

graphic

public final javafx.beans.property.ObjectProperty<javafx.scene.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 <code>Node</code> for more detail.

See Also:

getGraphic(), setGraphic(Node)

contentDisplay

public final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay> contentDisplayProperty

Specifies the positioning of the graphic relative to the text.

See Also:

getContentDisplay(), setContentDisplay(ContentDisplay)

graphicTextGap

public final javafx.beans.property.DoubleProperty graphicTextGapProperty

The amount of space between the graphic and text

See Also:

getGraphicTextGap(), setGraphicTextGap(double)

activated

public final javafx.beans.property.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()

pos

public javafx.beans.property.ObjectProperty<javafx.geometry.Pos> posProperty

See Also:

getPos(), setPos(Pos)

Constructor Detail

TooltipEx

public TooltipEx()

Creates a tooltip with an empty string for its text.

TooltipEx

public TooltipEx(java.lang.String text)

Creates a tooltip with the specified text.

Parameters:

text - A text string for the tooltip.

Method Detail

install

public static void install(javafx.scene.Node node,
                           TooltipEx t)

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

See Also:

TooltipEx

uninstall

public static void uninstall(javafx.scene.Node node,
                             TooltipEx t)

Removes the association of the given TooltipEx on the specified <code>Node</code>. Hence hovering on the node will no longer result in showing of the tooltip.

See Also:

TooltipEx

textProperty

public final javafx.beans.property.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)

setText

public final void setText(java.lang.String value)

Sets the value of the property text.

getText

public final java.lang.String getText()

Gets the value of the property text.

setTextAlignment

public final void setTextAlignment(javafx.scene.text.TextAlignment value)

Sets the value of the property textAlignment.

getTextAlignment

public final javafx.scene.text.TextAlignment getTextAlignment()

Gets the value of the property textAlignment.

textAlignmentProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.text.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)

setTextOverrun

public final void setTextOverrun(javafx.scene.control.OverrunStyle value)

Sets the value of the property textOverrun.

getTextOverrun

public final javafx.scene.control.OverrunStyle getTextOverrun()

Gets the value of the property textOverrun.

textOverrunProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.control.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)

setWrapText

public final void setWrapText(boolean value)

Sets the value of the property wrapText.

isWrapText

public final boolean isWrapText()

Gets the value of the property wrapText.

wrapTextProperty

public final javafx.beans.property.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)

setFont

public final void setFont(javafx.scene.text.Font value)

Sets the value of the property font.

getFont

public final javafx.scene.text.Font getFont()

Gets the value of the property font.

fontProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.text.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)

setGraphic

public final void setGraphic(javafx.scene.Node value)

Sets the value of the property graphic.

getGraphic

public final javafx.scene.Node getGraphic()

Gets the value of the property graphic.

graphicProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.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 <code>Node</code> for more detail.

See Also:

getGraphic(), setGraphic(Node)

setContentDisplay

public final void setContentDisplay(javafx.scene.control.ContentDisplay value)

Sets the value of the property contentDisplay.

getContentDisplay

public final javafx.scene.control.ContentDisplay getContentDisplay()

Gets the value of the property contentDisplay.

contentDisplayProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay> contentDisplayProperty()

Specifies the positioning of the graphic relative to the text.

See Also:

getContentDisplay(), setContentDisplay(ContentDisplay)

setGraphicTextGap

public final void setGraphicTextGap(double value)

Sets the value of the property graphicTextGap.

getGraphicTextGap

public final double getGraphicTextGap()

Gets the value of the property graphicTextGap.

graphicTextGapProperty

public final javafx.beans.property.DoubleProperty graphicTextGapProperty()

The amount of space between the graphic and text

See Also:

getGraphicTextGap(), setGraphicTextGap(double)

isActivated

public final boolean isActivated()

Gets the value of the property activated.

activatedProperty

public final javafx.beans.property.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()

createDefaultSkin

protected javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.PopupControl

getClassCssMetaData

public static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()

Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its super classes.

getCssMetaData

public java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getCssMetaData()

Specified by:

getCssMetaData in interface javafx.css.Styleable

Overrides:

getCssMetaData in class javafx.scene.control.PopupControl

getStyleableParent

public javafx.css.Styleable getStyleableParent()

Specified by:

getStyleableParent in interface javafx.css.Styleable

Overrides:

getStyleableParent in class javafx.scene.control.PopupControl

posProperty

public javafx.beans.property.ObjectProperty<javafx.geometry.Pos> posProperty()

See Also:

getPos(), setPos(Pos)

getPos

public javafx.geometry.Pos getPos()

Gets the value of the property pos.

setPos

public void setPos(javafx.geometry.Pos pos)

Sets the value of the property pos.