Package javafx.scene.text

Class Text

java.lang.Object

javafx.scene.Node

javafx.scene.shape.Shape

javafx.scene.text.Text

All Implemented Interfaces:

LayoutMeasurable, LayoutMeasurableMixin, HasBlendModeProperty, HasClipProperty, HasEffectProperty, HasFillProperty, HasFontProperty, HasLayoutXProperty, HasLayoutYProperty, HasManagedProperty, HasMouseTransparentProperty, HasOnMouseClickedProperty, HasOpacityProperty, HasParentProperty, HasSmoothProperty, HasStrokeDashOffsetProperty, HasStrokeLineCapProperty, HasStrokeLineJoinProperty, HasStrokeMiterLimitProperty, HasStrokeProperty, HasStrokeTypeProperty, HasStrokeWidthProperty, HasTextAlignmentProperty, HasTextOriginProperty, HasTextProperty, HasVisibleProperty, HasWrappingWidthProperty, HasXProperty, HasYProperty, Styleable, EventTarget, INode

Direct Known Subclasses:

LabeledText

public class Text
extends Shape
implements HasXProperty, HasYProperty, HasTextProperty, HasTextOriginProperty, HasTextAlignmentProperty, HasWrappingWidthProperty, HasFontProperty

Author:

Bruno Salmon

Property Summary

Properties

Type	Property	Description
final Property<TextBoundsType>	boundsType	Determines how the bounds of the text node are calculated.
Property<Font>	font
DoubleProperty	lineSpacing
final BooleanProperty	strikethrough	Defines if each line of text should have a line through it.
Property<TextAlignment>	textAlignment
Property<VPos>	textOrigin
StringProperty	text
DoubleProperty	wrappingWidth
DoubleProperty	x
DoubleProperty	y

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, cacheHint, cache, clip, cursor, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, layoutBounds, layoutX, layoutY, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onScroll, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, opacity, parent, pressed, rotate, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, visible

Field Summary

Fields inherited from interface javafx.scene.INode

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
Text()
Text(double x, double y, String text)
Text(String text)

Method Summary

Modifier and Type	Method	Description
final Property<TextBoundsType>	boundsTypeProperty()	Determines how the bounds of the text node are calculated.
Property<Font>	fontProperty()
double	getBaselineOffset()	The 'alphabetic' (or 'roman') baseline offset from the node's layoutBounds.minY location that should be used when this node is being vertically aligned by baseline with other nodes.
final TextBoundsType	getBoundsType()	Gets the value of the boundsType property.
double	getLineSpacing()	Gets the value of the lineSpacing property.
BaseBounds	impl_computeGeomBounds(BaseBounds bounds, BaseTransform tx)	Computes the geometric bounds for this Node.
final boolean	isStrikethrough()	Gets the value of the strikethrough property.
DoubleProperty	lineSpacingProperty()
final void	setBoundsType(TextBoundsType value)	Sets the value of the boundsType property.
void	setLineSpacing(double lineSpacing)	Sets the value of the lineSpacing property.
final void	setStrikethrough(boolean value)	Sets the value of the strikethrough property.
final BooleanProperty	strikethroughProperty()	Defines if each line of text should have a line through it.
Property<TextAlignment>	textAlignmentProperty()
Property<VPos>	textOriginProperty()
StringProperty	textProperty()
DoubleProperty	wrappingWidthProperty()
DoubleProperty	xProperty()
DoubleProperty	yProperty()

Methods inherited from class javafx.scene.shape.Shape

fillProperty, getStrokeDashArray, smoothProperty, strokeDashOffsetProperty, strokeLineCapProperty, strokeLineJoinProperty, strokeMiterLimitProperty, strokeProperty, strokeTypeProperty, strokeWidthProperty, subtract

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, createLayoutMeasurable, cursorProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAllNodeTransforms, getBoundsInLocal, getCacheHint, getCursor, getEventDispatcher, getId, getLayoutMeasurable, getNodePeer, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseDragged, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnScroll, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOrCreateAndBindNodePeer, getProperties, getRotate, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getUserData, hasProperties, hoverProperty, idProperty, impl_computeLayoutBounds, impl_getLayoutBounds, impl_isTreeVisible, impl_maxHeight, impl_maxWidth, impl_minHeight, impl_minWidth, impl_prefHeight, impl_prefWidth, impl_traverse, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isPressed, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToScene, localToScene, localToScreen, localToScreen, localToScreen, localToScreen, managedProperty, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDraggedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onNodePeerReady, onPeerSizeChanged, onScrollProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, opacityProperty, parentProperty, parentToLocal, pressedProperty, removeEventFilter, removeEventHandler, requestFocus, requestPeerFocus, rotateProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setCache, setCacheHint, setCursor, setDisable, setDisabled, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setNodePeer, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseDragged, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnScroll, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setPressed, setRotate, setScaleX, setScaleY, setScaleZ, setScene, setStyle, setTranslateX, setTranslateY, setUserData, shouldUseLayoutMeasurable, snapshot, startDragAndDrop, styleProperty, toBack, toFront, translateXProperty, translateYProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasBlendModeProperty

getBlendMode, setBlendMode

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasClipProperty

getClip, setClip

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasEffectProperty

getEffect, setEffect

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasFillProperty

getFill, setFill

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasFontProperty

getFont, setFont

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasLayoutXProperty

getLayoutX, setLayoutX

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasLayoutYProperty

getLayoutY, setLayoutY

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasManagedProperty

isManaged, setManaged

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMouseTransparentProperty

isMouseTransparent, setMouseTransparent

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasOnMouseClickedProperty

getOnMouseClicked, setOnMouseClicked

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasOpacityProperty

getOpacity, setOpacity

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasParentProperty

getParent, setParent

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasSmoothProperty

isSmooth, setSmooth

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeDashOffsetProperty

getStrokeDashOffset, setStrokeDashOffset

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeLineCapProperty

getStrokeLineCap, setStrokeLineCap

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeLineJoinProperty

getStrokeLineJoin, setStrokeLineJoin

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeMiterLimitProperty

getStrokeMiterLimit, setStrokeMiterLimit

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeProperty

getStroke, setStroke

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeTypeProperty

getStrokeType, setStrokeType

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasStrokeWidthProperty

getStrokeWidth, setStrokeWidth

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasTextAlignmentProperty

getTextAlignment, setTextAlignment

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasTextOriginProperty

getTextOrigin, setTextOrigin

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasTextProperty

getText, setText

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasVisibleProperty

isVisible, setVisible

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasWrappingWidthProperty

getWrappingWidth, setWrappingWidth

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasXProperty

getX, setX

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasYProperty

getY, setY

Methods inherited from interface javafx.scene.INode

getContentBias, isResizable, relocate, resize, resizeRelocate

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.emul_coupling.LayoutMeasurableMixin

clearCache, getLayoutBounds, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth

Property Details

x

public DoubleProperty xProperty

Specified by:

xProperty in interface HasXProperty

Returns:

the x property

See Also:

• xProperty()

textOrigin

public Property<VPos> textOriginProperty

Specified by:

textOriginProperty in interface HasTextOriginProperty

Returns:

the textOrigin property

See Also:

• textOriginProperty()

textAlignment

public Property<TextAlignment> textAlignmentProperty

Specified by:

textAlignmentProperty in interface HasTextAlignmentProperty

Returns:

the textAlignment property

See Also:

• textAlignmentProperty()

wrappingWidth

public DoubleProperty wrappingWidthProperty

Specified by:

wrappingWidthProperty in interface HasWrappingWidthProperty

Returns:

the wrappingWidth property

See Also:

• wrappingWidthProperty()

lineSpacing

public DoubleProperty lineSpacingProperty

See Also:

• getLineSpacing()
• setLineSpacing(double)
• lineSpacingProperty()

y

public DoubleProperty yProperty

Specified by:

yProperty in interface HasYProperty

Returns:

the y property

See Also:

• yProperty()

text

public StringProperty textProperty

Specified by:

textProperty in interface HasTextProperty

Returns:

the text property

See Also:

• textProperty()

font

public Property<Font> fontProperty

Specified by:

fontProperty in interface HasFontProperty

Returns:

the font property

See Also:

• fontProperty()

boundsType

public final Property<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)
• boundsTypeProperty()

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)
• strikethroughProperty()

Constructor Details

Text

public Text()

Text

public Text(String text)

Text

public Text(double x,
 double y,
 String text)

Method Details

xProperty

public DoubleProperty xProperty()

Specified by:

xProperty in interface HasXProperty

Returns:

the x property

See Also:

• HasXProperty.getX()
• HasXProperty.setX(Number)

textOriginProperty

public Property<VPos> textOriginProperty()

Specified by:

textOriginProperty in interface HasTextOriginProperty

Returns:

the textOrigin property

See Also:

• HasTextOriginProperty.getTextOrigin()
• HasTextOriginProperty.setTextOrigin(VPos)

textAlignmentProperty

public Property<TextAlignment> textAlignmentProperty()

Specified by:

textAlignmentProperty in interface HasTextAlignmentProperty

Returns:

the textAlignment property

See Also:

• HasTextAlignmentProperty.getTextAlignment()
• HasTextAlignmentProperty.setTextAlignment(TextAlignment)

wrappingWidthProperty

public DoubleProperty wrappingWidthProperty()

Specified by:

wrappingWidthProperty in interface HasWrappingWidthProperty

Returns:

the wrappingWidth property

See Also:

• HasWrappingWidthProperty.getWrappingWidth()
• HasWrappingWidthProperty.setWrappingWidth(Number)

lineSpacingProperty

public DoubleProperty lineSpacingProperty()

Returns:

the lineSpacing property

See Also:

• getLineSpacing()
• setLineSpacing(double)

getLineSpacing

public double getLineSpacing()

Gets the value of the lineSpacing property.

Property description:

Returns:

the value of the lineSpacing property

See Also:

• setLineSpacing(double)
• lineSpacingProperty()

setLineSpacing

public void setLineSpacing(double lineSpacing)

Sets the value of the lineSpacing property.

Property description:

Parameters:

lineSpacing - the value for the lineSpacing property

See Also:

• getLineSpacing()
• lineSpacingProperty()

yProperty

public DoubleProperty yProperty()

Specified by:

yProperty in interface HasYProperty

Returns:

the y property

See Also:

• HasYProperty.getY()
• HasYProperty.setY(Number)

textProperty

public StringProperty textProperty()

Specified by:

textProperty in interface HasTextProperty

Returns:

the text property

See Also:

• HasTextProperty.getText()
• HasTextProperty.setText(String)

fontProperty

public Property<Font> fontProperty()

Specified by:

fontProperty in interface HasFontProperty

Returns:

the font property

See Also:

• HasFontProperty.getFont()
• HasFontProperty.setFont(Font)

setBoundsType

public final void setBoundsType(TextBoundsType value)

Sets the value of the boundsType property.

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

Parameters:

value - the value for the boundsType property

See Also:

• getBoundsType()
• boundsTypeProperty()

getBoundsType

public final TextBoundsType getBoundsType()

Gets the value of the boundsType property.

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

Returns:

the value of the boundsType property

See Also:

• setBoundsType(TextBoundsType)
• boundsTypeProperty()

boundsTypeProperty

public final Property<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

Returns:

the boundsType property

See Also:

• getBoundsType()
• setBoundsType(TextBoundsType)

strikethroughProperty

public final BooleanProperty strikethroughProperty()

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

Default value:

false

Returns:

if each line of text should have a line through it

See Also:

• isStrikethrough()
• setStrikethrough(boolean)

setStrikethrough

public final void setStrikethrough(boolean value)

Sets the value of the strikethrough property.

Property description:

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

Default value:

false

Parameters:

value - the value for the strikethrough property

See Also:

• isStrikethrough()
• strikethroughProperty()

isStrikethrough

public final boolean isStrikethrough()

Gets the value of the strikethrough property.

Property description:

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

Default value:

false

Returns:

the value of the strikethrough property

See Also:

• setStrikethrough(boolean)
• strikethroughProperty()

getBaselineOffset

public double getBaselineOffset()

Description copied from interface: INode

The 'alphabetic' (or 'roman') baseline offset from the node's layoutBounds.minY location that should be used when this node is being vertically aligned by baseline with other nodes. By default this returns INode.BASELINE_OFFSET_SAME_AS_HEIGHT for resizable Nodes and layoutBounds height for non-resizable. Subclasses which contain text should override this method to return their actual text baseline offset.

Specified by:

getBaselineOffset in interface INode

Returns:

offset of text baseline from layoutBounds.minY for non-resizable Nodes or INode.BASELINE_OFFSET_SAME_AS_HEIGHT otherwise

impl_computeGeomBounds

public BaseBounds impl_computeGeomBounds(BaseBounds bounds,
 BaseTransform tx)

Description copied from class: Node

Computes the geometric bounds for this Node. This method is abstract and must be implemented by each Node subclass.

Specified by:

impl_computeGeomBounds in class Node