< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/Tooltip.java
Print this page
@@ -128,20 +128,24 @@
/**
* Associates the given {@link Tooltip} with the given {@link Node}. The tooltip
* can then behave similar to when it is set on any {@link Control}. A single
* tooltip can be associated with multiple nodes.
+ * @param node the node
+ * @param t the tooltip
* @see Tooltip
*/
public static void install(Node node, Tooltip t) {
BEHAVIOR.install(node, t);
}
/**
* Removes the association of the given {@link Tooltip} on the specified
* {@link Node}. Hence hovering on the node will no longer result in showing of the
* tooltip.
+ * @param node the node
+ * @param t the tooltip
* @see Tooltip
*/
public static void uninstall(Node node, Tooltip t) {
BEHAVIOR.uninstall(node);
}
@@ -178,10 +182,11 @@
* *
**************************************************************************/
/**
* 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.
+ * @return the text property
*/
public final StringProperty textProperty() { return text; }
public final void setText(String value) {
textProperty().setValue(value);
}
@@ -202,10 +207,11 @@
/**
* Specifies the behavior for lines of text <em>when text is multiline</em>.
* Unlike {@link #contentDisplayProperty() contentDisplay} which affects the
* graphic and text, this setting only affects multiple lines of text
* relative to the text bounds.
+ * @return the text alignment property
*/
public final ObjectProperty<TextAlignment> textAlignmentProperty() {
return textAlignment;
}
public final void setTextAlignment(TextAlignment value) {
@@ -218,10 +224,11 @@
new SimpleStyleableObjectProperty<>(TEXT_ALIGNMENT, this, "textAlignment", TextAlignment.LEFT);;
/**
* Specifies the behavior to use if the text of the {@code Tooltip}
* exceeds the available space for rendering the text.
+ * @return the text overrun property
*/
public final ObjectProperty<OverrunStyle> textOverrunProperty() {
return textOverrun;
}
public final void setTextOverrun(OverrunStyle value) {
@@ -234,10 +241,11 @@
new SimpleStyleableObjectProperty<OverrunStyle>(TEXT_OVERRUN, this, "textOverrun", OverrunStyle.ELLIPSIS);
/**
* If a run of text exceeds the width of the Tooltip, then this variable
* indicates whether the text should wrap onto another line.
+ * @return the wrap text property
*/
public final BooleanProperty wrapTextProperty() {
return wrapText;
}
public final void setWrapText(boolean value) {
@@ -253,10 +261,11 @@
/**
* 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.
+ * @return the font property
*/
public final ObjectProperty<Font> fontProperty() {
return font;
}
public final void setFont(Font value) {
@@ -315,12 +324,13 @@
/**
* 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.
*
+ * @return show delay property
* @since 9
- * @defaultvalue 1000ms
+ * @defaultValue 1000ms
*/
public final ObjectProperty<Duration> showDelayProperty() {
return showDelayProperty;
}
public final void setShowDelay(Duration showDelay) {
@@ -337,12 +347,13 @@
* 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 {@link #hideDelayProperty()}, even if the remaining time of the showDuration
* is less than the hideDelay duration. The default value is 5000ms.
*
+ * @return the show duration property
* @since 9
- * @defaultvalue 5000ms
+ * @defaultValue 5000ms
*/
public final ObjectProperty<Duration> showDurationProperty() {
return showDurationProperty;
}
public final void setShowDuration(Duration showDuration) {
@@ -357,12 +368,13 @@
/**
* 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.
*
+ * @return the hide delay property
* @since 9
- * @defaultvalue 200ms
+ * @defaultValue 200ms
*/
public final ObjectProperty<Duration> hideDelayProperty() {
return hideDelayProperty;
}
public final void setHideDelay(Duration hideDelay) {
@@ -380,10 +392,11 @@
* text by using the {@link #contentDisplayProperty() content display}
* property.
* The node specified for this variable cannot appear elsewhere in the
* scene graph, otherwise the {@code IllegalArgumentException} is thrown.
* See the class description of {@link javafx.scene.Node Node} for more detail.
+ * @return the graphic property
*/
public final ObjectProperty<Node> graphicProperty() {
return graphic;
}
public final void setGraphic(Node value) {
@@ -508,10 +521,11 @@
private StyleableStringProperty imageUrl = null;
/**
* Specifies the positioning of the graphic relative to the text.
+ * @return the content display property
*/
public final ObjectProperty<ContentDisplay> contentDisplayProperty() {
return contentDisplay;
}
public final void setContentDisplay(ContentDisplay value) {
@@ -523,10 +537,11 @@
private final ObjectProperty<ContentDisplay> contentDisplay =
new SimpleStyleableObjectProperty<>(CONTENT_DISPLAY, this, "contentDisplay", ContentDisplay.LEFT);
/**
* The amount of space between the graphic and text
+ * @return the graphic text gap property
*/
public final DoubleProperty graphicTextGapProperty() {
return graphicTextGap;
}
public final void setGraphicTextGap(double value) {
< prev index next >