javafx.scene.text

Class Text

java.lang.Object

javafx.scene.Node

javafx.scene.shape.Shape

javafx.scene.text.Text

All Implemented Interfaces:

EventTarget

@DefaultProperty(value="text")
public class Text
extends Shape

The Text class defines a node that displays a text. Paragraphs are separated by '\n' and the text is wrapped on paragraph boundaries.

import javafx.scene.text.*;

Text t = new Text(10, 50, "This is a test");
t.setFont(new Font(20));

import javafx.scene.text.*;

Text t = new Text();
text.setFont(new Font(20));
text.setText("First row\nSecond row");

import javafx.scene.text.*;

Text t = new Text();
text.setFont(new Font(20));
text.setWrappingWidth(200);
text.setTextAlignment(TextAlignment.JUSTIFY)
text.setText("The quick brown fox jumps over the lazy dog");

Property Summary

Properties

Type	Property and Description
ReadOnlyDoubleProperty	baselineOffset The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.
ObjectProperty<TextBoundsType>	boundsType Determines how the bounds of the text node are calculated.
ObjectProperty<Font>	font Defines the font of text.
ObjectProperty<FontSmoothingType>	fontSmoothingType Specifies a requested font smoothing type : gray or LCD.
BooleanProperty	strikethrough Defines if each line of text should have a line through it.
ObjectProperty<TextAlignment>	textAlignment Defines horizontal text alignment in the bounding box.
ObjectProperty<VPos>	textOrigin Defines the origin of text coordinate system in local coordinates.
StringProperty	text Defines text string that is to be displayed.
BooleanProperty	underline Defines if each line of text should have a line below it.
DoubleProperty	wrappingWidth Defines a width constraint for the text in user space coordinates, e.g.
DoubleProperty	x Defines the X coordinate of text origin.
DoubleProperty	y Defines the Y coordinate of text origin.

Properties inherited from class javafx.scene.shape.Shape

fill, smooth, strokeDashOffset, strokeLineCap, strokeLineJoin, strokeMiterLimit, stroke, strokeType, strokeWidth

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Constructor Summary

Constructors

Constructor and Description
Text() Creates an empty instance of Text.
Text(double x, double y, java.lang.String text) Creates an instance of Text on the given coordinates containing the given string.
Text(java.lang.String text) Creates an instance of Text containing the given string.

Method Summary

Methods

Modifier and Type	Method and Description
ReadOnlyDoubleProperty	baselineOffsetProperty() The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.
ObjectProperty<TextBoundsType>	boundsTypeProperty() Determines how the bounds of the text node are calculated.
ObjectProperty<Font>	fontProperty() Defines the font of text.
ObjectProperty<FontSmoothingType>	fontSmoothingTypeProperty() Specifies a requested font smoothing type : gray or LCD.
double	getBaselineOffset() Gets the value of the property baselineOffset.
TextBoundsType	getBoundsType() Gets the value of the property boundsType.
Font	getFont() Gets the value of the property font.
FontSmoothingType	getFontSmoothingType() Gets the value of the property fontSmoothingType.
java.lang.String	getText() Gets the value of the property text.
TextAlignment	getTextAlignment() Gets the value of the property textAlignment.
VPos	getTextOrigin() Gets the value of the property textOrigin.
double	getWrappingWidth() Gets the value of the property wrappingWidth.
double	getX() Gets the value of the property x.
double	getY() Gets the value of the property y.
boolean	isStrikethrough() Gets the value of the property strikethrough.
boolean	isUnderline() Gets the value of the property underline.
void	setBoundsType(TextBoundsType value) Sets the value of the property boundsType.
void	setFont(Font value) Sets the value of the property font.
void	setFontSmoothingType(FontSmoothingType value) Sets the value of the property fontSmoothingType.
void	setStrikethrough(boolean value) Sets the value of the property strikethrough.
void	setText(java.lang.String value) Sets the value of the property text.
void	setTextAlignment(TextAlignment value) Sets the value of the property textAlignment.
void	setTextOrigin(VPos value) Sets the value of the property textOrigin.
void	setUnderline(boolean value) Sets the value of the property underline.
void	setWrappingWidth(double value) Sets the value of the property wrappingWidth.
void	setX(double value) Sets the value of the property x.
void	setY(double value) Sets the value of the property y.
BooleanProperty	strikethroughProperty() Defines if each line of text should have a line through it.
ObjectProperty<TextAlignment>	textAlignmentProperty() Defines horizontal text alignment in the bounding box.
ObjectProperty<VPos>	textOriginProperty() Defines the origin of text coordinate system in local coordinates.
StringProperty	textProperty() Defines text string that is to be displayed.
BooleanProperty	underlineProperty() Defines if each line of text should have a line below it.
DoubleProperty	wrappingWidthProperty() Defines a width constraint for the text in user space coordinates, e.g.
DoubleProperty	xProperty() Defines the X coordinate of text origin.
DoubleProperty	yProperty() Defines the Y coordinate of text origin.

Methods inherited from class javafx.scene.shape.Shape

fillProperty, getFill, getStroke, getStrokeDashArray, getStrokeDashOffset, getStrokeLineCap, getStrokeLineJoin, getStrokeMiterLimit, getStrokeType, getStrokeWidth, intersect, isSmooth, setFill, setSmooth, setStroke, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeType, setStrokeWidth, smoothProperty, strokeDashOffsetProperty, strokeLineCapProperty, strokeLineJoinProperty, strokeMiterLimitProperty, strokeProperty, strokeTypeProperty, strokeWidthProperty, subtract, union

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookup, lookupAll, managedProperty, maxHeight, maxWidth, minHeight, minWidth, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

text

public final StringProperty textProperty

Defines text string that is to be displayed.

Default value:

empty string

See Also:

getText(), setText(String)

x

public final DoubleProperty xProperty

Defines the X coordinate of text origin.

Default value:

0

See Also:

getX(), setX(double)

y

public final DoubleProperty yProperty

Defines the Y coordinate of text origin.

Default value:

0

See Also:

getY(), setY(double)

font

public final ObjectProperty<Font> fontProperty

Defines the font of text.

Default value:

Font{}

See Also:

getFont(), setFont(Font)

textOrigin

public final ObjectProperty<VPos> textOriginProperty

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

See Also:

getTextOrigin(), setTextOrigin(VPos)

boundsType

public final ObjectProperty<TextBoundsType> boundsTypeProperty

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

See Also:

getBoundsType(), setBoundsType(TextBoundsType)

wrappingWidth

public final DoubleProperty wrappingWidthProperty

Defines a width constraint for the text in user space coordinates, e.g. pixels, not glyph or character count. If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

See Also:

getWrappingWidth(), setWrappingWidth(double)

underline

public final BooleanProperty underlineProperty

Defines if each line of text should have a line below it.

Default value:

false

See Also:

isUnderline(), setUnderline(boolean)

strikethrough

public final BooleanProperty strikethroughProperty

Defines if each line of text should have a line through it.

Default value:

false

See Also:

isStrikethrough(), setStrikethrough(boolean)

textAlignment

public final ObjectProperty<TextAlignment> textAlignmentProperty

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

See Also:

getTextAlignment(), setTextAlignment(TextAlignment)

baselineOffset

public final ReadOnlyDoubleProperty baselineOffsetProperty

The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location. The value typically corresponds to the max ascent of the font.

See Also:

getBaselineOffset()

fontSmoothingType

public final ObjectProperty<FontSmoothingType> fontSmoothingTypeProperty

Specifies a requested font smoothing type : gray or LCD. The width of the bounding box is defined by the widest row. Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

See Also:

getFontSmoothingType(), setFontSmoothingType(FontSmoothingType)

Constructor Detail

Text

public Text()

Creates an empty instance of Text.

Text

public Text(java.lang.String text)

Creates an instance of Text containing the given string.

Parameters:

text - text to be contained in the instance

Text

public Text(double x,
    double y,
    java.lang.String text)

Creates an instance of Text on the given coordinates containing the given string.

Parameters:

x - the horizontal position of the text

y - the vertical position of the text

text - text to be contained in the instance

Method Detail

setText

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

Sets the value of the property text.

Property description:

Defines text string that is to be displayed.

Default value:

empty string

getText

public final java.lang.String getText()

Gets the value of the property text.

Property description:

Defines text string that is to be displayed.

Default value:

empty string

textProperty

public final StringProperty textProperty()

Defines text string that is to be displayed.

Default value:

empty string

See Also:

getText(), setText(String)

setX

public final void setX(double value)

Sets the value of the property x.

Property description:

Defines the X coordinate of text origin.

Default value:

0

getX

public final double getX()

Gets the value of the property x.

Property description:

Defines the X coordinate of text origin.

Default value:

0

xProperty

public final DoubleProperty xProperty()

Defines the X coordinate of text origin.

Default value:

0

See Also:

getX(), setX(double)

setY

public final void setY(double value)

Sets the value of the property y.

Property description:

Defines the Y coordinate of text origin.

Default value:

0

getY

public final double getY()

Gets the value of the property y.

Property description:

Defines the Y coordinate of text origin.

Default value:

0

yProperty

public final DoubleProperty yProperty()

Defines the Y coordinate of text origin.

Default value:

0

See Also:

getY(), setY(double)

setFont

public final void setFont(Font value)

Sets the value of the property font.

Property description:

Defines the font of text.

Default value:

Font{}

getFont

public final Font getFont()

Gets the value of the property font.

Property description:

Defines the font of text.

Default value:

Font{}

fontProperty

public final ObjectProperty<Font> fontProperty()

Defines the font of text.

Default value:

Font{}

See Also:

getFont(), setFont(Font)

setTextOrigin

public final void setTextOrigin(VPos value)

Sets the value of the property textOrigin.

Property description:

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

getTextOrigin

public final VPos getTextOrigin()

Gets the value of the property textOrigin.

Property description:

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

textOriginProperty

public final ObjectProperty<VPos> textOriginProperty()

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

See Also:

getTextOrigin(), setTextOrigin(VPos)

setBoundsType

public final void setBoundsType(TextBoundsType value)

Sets the value of the property boundsType.

Property description:

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

getBoundsType

public final TextBoundsType getBoundsType()

Gets the value of the property boundsType.

Property description:

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

boundsTypeProperty

public final ObjectProperty<TextBoundsType> boundsTypeProperty()

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

See Also:

getBoundsType(), setBoundsType(TextBoundsType)

setWrappingWidth

public final void setWrappingWidth(double value)

Sets the value of the property wrappingWidth.

Property description:

Defines a width constraint for the text in user space coordinates, e.g. pixels, not glyph or character count. If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

getWrappingWidth

public final double getWrappingWidth()

Gets the value of the property wrappingWidth.

Property description:

Defines a width constraint for the text in user space coordinates, e.g. pixels, not glyph or character count. If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

wrappingWidthProperty

public final DoubleProperty wrappingWidthProperty()

Defines a width constraint for the text in user space coordinates, e.g. pixels, not glyph or character count. If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

See Also:

getWrappingWidth(), setWrappingWidth(double)

setUnderline

public final void setUnderline(boolean value)

Sets the value of the property underline.

Property description:

Defines if each line of text should have a line below it.

Default value:

false

isUnderline

public final boolean isUnderline()

Gets the value of the property underline.

Property description:

Defines if each line of text should have a line below it.

Default value:

false

underlineProperty

public final BooleanProperty underlineProperty()

Defines if each line of text should have a line below it.

Default value:

false

See Also:

isUnderline(), setUnderline(boolean)

setStrikethrough

public final void setStrikethrough(boolean value)

Sets the value of the property strikethrough.

Property description:

Defines if each line of text should have a line through it.

Default value:

false

isStrikethrough

public final boolean isStrikethrough()

Gets the value of the property strikethrough.

Property description:

Defines if each line of text should have a line through it.

Default value:

false

strikethroughProperty

public final BooleanProperty strikethroughProperty()

Defines if each line of text should have a line through it.

Default value:

false

See Also:

isStrikethrough(), setStrikethrough(boolean)

setTextAlignment

public final void setTextAlignment(TextAlignment value)

Sets the value of the property textAlignment.

Property description:

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

getTextAlignment

public final TextAlignment getTextAlignment()

Gets the value of the property textAlignment.

Property description:

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

textAlignmentProperty

public final ObjectProperty<TextAlignment> textAlignmentProperty()

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

See Also:

getTextAlignment(), setTextAlignment(TextAlignment)

getBaselineOffset

public final double getBaselineOffset()

Gets the value of the property baselineOffset.

Overrides:

getBaselineOffset in class Node

Returns:

offset of text baseline from layoutBounds.minY

Property description:

The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location. The value typically corresponds to the max ascent of the font.

baselineOffsetProperty

public final ReadOnlyDoubleProperty baselineOffsetProperty()

The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location. The value typically corresponds to the max ascent of the font.

See Also:

getBaselineOffset()

setFontSmoothingType

public final void setFontSmoothingType(FontSmoothingType value)

Sets the value of the property fontSmoothingType.

Property description:

Specifies a requested font smoothing type : gray or LCD. The width of the bounding box is defined by the widest row. Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

getFontSmoothingType

public final FontSmoothingType getFontSmoothingType()

Gets the value of the property fontSmoothingType.

Property description:

Specifies a requested font smoothing type : gray or LCD. The width of the bounding box is defined by the widest row. Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

fontSmoothingTypeProperty

public final ObjectProperty<FontSmoothingType> fontSmoothingTypeProperty()

Specifies a requested font smoothing type : gray or LCD. The width of the bounding box is defined by the widest row. Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

See Also:

getFontSmoothingType(), setFontSmoothingType(FontSmoothingType)