java.lang.Object
javafx.scene.Node
javafx.scene.shape.Shape
javafx.scene.text.Text
- All Implemented Interfaces:
Styleable
,EventTarget
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");
- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionfinal ReadOnlyDoubleProperty
The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.final ObjectProperty<TextBoundsType>
Determines how the bounds of the text node are calculated.final BooleanProperty
The type of caret bias in the content.final IntegerProperty
The caret index in the content.final ReadOnlyObjectProperty<PathElement[]>
The shape of caret, in local coordinates.final ObjectProperty<Font>
Defines the font of text.final ObjectProperty<FontSmoothingType>
Specifies a requested font smoothing type: gray or LCD.final DoubleProperty
Defines the vertical space in pixel between lines.final IntegerProperty
The end index of the selection in the content.final ObjectProperty<Paint>
The fill color of selected text.final ReadOnlyObjectProperty<PathElement[]>
The shape of the selection in local coordinates.final IntegerProperty
The start index of the selection in the content.final BooleanProperty
Defines if each line of text should have a line through it.final IntegerProperty
The size of a tab stop in spaces.final ObjectProperty<TextAlignment>
Defines horizontal text alignment in the bounding box.final ObjectProperty<VPos>
Defines the origin of text coordinate system in local coordinates.final StringProperty
Defines text string that is to be displayed.final BooleanProperty
Defines if each line of text should have a line below it.final DoubleProperty
Defines a width constraint for the text in user space coordinates.final DoubleProperty
Defines the X coordinate of text origin.final DoubleProperty
Defines the Y coordinate of text origin.Properties declared in class javafx.scene.shape.Shape
fill, smooth, strokeDashOffset, strokeLineCap, strokeLineJoin, strokeMiterLimit, stroke, strokeType, strokeWidth
Properties declared in class javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, 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, viewOrder, visible
-
Field Summary
Fields declared in class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ReadOnlyDoubleProperty
The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.final ObjectProperty<TextBoundsType>
Determines how the bounds of the text node are calculated.final BooleanProperty
The type of caret bias in the content.final IntegerProperty
The caret index in the content.final PathElement[]
caretShape
(int charIndex, boolean caretBias) Returns the shape for the caret at the given index and bias.final ReadOnlyObjectProperty<PathElement[]>
The shape of caret, in local coordinates.final ObjectProperty<Font>
Defines the font of text.final ObjectProperty<FontSmoothingType>
Specifies a requested font smoothing type: gray or LCD.final double
Gets the value of the property baselineOffset.final TextBoundsType
Gets the value of the property boundsType.final int
Gets the value of the property caretPosition.final PathElement[]
Gets the value of the property caretShape.static List<CssMetaData<? extends Styleable,
?>> Gets theCssMetaData
associated with this class, which may include theCssMetaData
of its superclasses.List<CssMetaData<? extends Styleable,
?>> This method should delegate toNode.getClassCssMetaData()
so that a Node's CssMetaData can be accessed without the need for reflection.final Font
getFont()
Gets the value of the property font.final FontSmoothingType
Gets the value of the property fontSmoothingType.final double
Gets the value of the property lineSpacing.final int
Gets the value of the property selectionEnd.final Paint
Gets the value of the property selectionFill.final PathElement[]
Gets the value of the property selectionShape.final int
Gets the value of the property selectionStart.final int
Gets the value of the property tabSize.final String
getText()
Gets the value of the property text.final TextAlignment
Gets the value of the property textAlignment.final VPos
Gets the value of the property textOrigin.final double
Gets the value of the property wrappingWidth.final double
getX()
Gets the value of the property x.final double
getY()
Gets the value of the property y.final HitInfo
Maps local point to index in the content.final boolean
Gets the value of the property caretBias.final boolean
Gets the value of the property strikethrough.final boolean
Gets the value of the property underline.final DoubleProperty
Defines the vertical space in pixel between lines.final PathElement[]
rangeShape
(int start, int end) Returns the shape for the range of the text in local coordinates.final IntegerProperty
The end index of the selection in the content.final ObjectProperty<Paint>
The fill color of selected text.final ReadOnlyObjectProperty<PathElement[]>
The shape of the selection in local coordinates.final IntegerProperty
The start index of the selection in the content.final void
setBoundsType
(TextBoundsType value) Sets the value of the property boundsType.final void
setCaretBias
(boolean value) Sets the value of the property caretBias.final void
setCaretPosition
(int value) Sets the value of the property caretPosition.final void
Sets the value of the property font.final void
Sets the value of the property fontSmoothingType.final void
setLineSpacing
(double spacing) Sets the value of the property lineSpacing.final void
setSelectionEnd
(int value) Sets the value of the property selectionEnd.final void
setSelectionFill
(Paint paint) Sets the value of the property selectionFill.final void
setSelectionStart
(int value) Sets the value of the property selectionStart.final void
setStrikethrough
(boolean value) Sets the value of the property strikethrough.final void
setTabSize
(int spaces) Sets the value of the property tabSize.final void
Sets the value of the property text.final void
setTextAlignment
(TextAlignment value) Sets the value of the property textAlignment.final void
setTextOrigin
(VPos value) Sets the value of the property textOrigin.final void
setUnderline
(boolean value) Sets the value of the property underline.final void
setWrappingWidth
(double value) Sets the value of the property wrappingWidth.final void
setX
(double value) Sets the value of the property x.final void
setY
(double value) Sets the value of the property y.final BooleanProperty
Defines if each line of text should have a line through it.final IntegerProperty
The size of a tab stop in spaces.final ObjectProperty<TextAlignment>
Defines horizontal text alignment in the bounding box.final ObjectProperty<VPos>
Defines the origin of text coordinate system in local coordinates.final StringProperty
Defines text string that is to be displayed.toString()
Returns a string representation of thisText
object.final BooleanProperty
Defines if each line of text should have a line below it.final PathElement[]
underlineShape
(int start, int end) Returns the shape for the underline in local coordinates.final DoubleProperty
Defines a width constraint for the text in user space coordinates.final DoubleProperty
Defines the X coordinate of text origin.final DoubleProperty
Defines the Y coordinate of text origin.Methods declared in 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 declared in class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, 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, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, maxHeight, maxWidth, minHeight, minWidth, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, parentToLocal, parentToLocal, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods declared in interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
text
Defines text string that is to be displayed.- Default value:
- empty string
- See Also:
-
x
Defines the X coordinate of text origin.- Default value:
- 0
- See Also:
-
y
Defines the Y coordinate of text origin.- Default value:
- 0
- See Also:
-
font
Defines the font of text.- Default value:
- Font{}
- See Also:
-
textOrigin
Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are renderedVPos.BASELINE
andVPos.TOP
define the origin of the top row whileVPos.BOTTOM
defines the origin of the bottom row.- Default value:
- VPos.BASELINE
- See Also:
-
boundsType
Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. SeeTextBoundsType
for more information.- Default value:
- TextBoundsType.LOGICAL
- See Also:
-
wrappingWidth
Defines a width constraint for the text in user space coordinates. The width is measured in pixels (and 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:
-
underline
Defines if each line of text should have a line below it.- Default value:
- false
- See Also:
-
strikethrough
Defines if each line of text should have a line through it.- Default value:
- false
- See Also:
-
textAlignment
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:
-
lineSpacing
Defines the vertical space in pixel between lines.- Default value:
- 0
- Since:
- JavaFX 8.0
- See Also:
-
baselineOffset
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:
-
fontSmoothingType
Specifies a requested font smoothing type: gray or LCD.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
- Since:
- JavaFX 2.1
- See Also:
-
selectionShape
The shape of the selection in local coordinates.- Since:
- 9
- See Also:
-
selectionStart
The start index of the selection in the content. If the value is -1, the selection is unset.- Default value:
- -1
- Since:
- 9
- See Also:
-
selectionEnd
The end index of the selection in the content. If the value is -1, the selection is unset.- Default value:
- -1
- Since:
- 9
- See Also:
-
selectionFill
The fill color of selected text.- Since:
- 9
- See Also:
-
caretShape
The shape of caret, in local coordinates.- Since:
- 9
- See Also:
-
caretPosition
The caret index in the content. If the value is -1, the caret is unset.- Default value:
- -1
- Since:
- 9
- See Also:
-
caretBias
The type of caret bias in the content. Iftrue
, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge.- Default value:
true
- Since:
- 9
- See Also:
-
tabSize
The size of a tab stop in spaces. Values less than 1 are treated as 1.- Default value:
- 8
- Since:
- 14
- See Also:
-
-
Constructor Details
-
Text
public Text()Creates an empty instance of Text. -
Text
Creates an instance of Text containing the given string.- Parameters:
text
- text to be contained in the instance
-
Text
Creates an instance of Text on the given coordinates containing the given string.- Parameters:
x
- the horizontal position of the texty
- the vertical position of the texttext
- text to be contained in the instance
-
-
Method Details
-
setText
Sets the value of the property text.- Property description:
- Defines text string that is to be displayed.
- Default value:
- empty string
-
getText
Gets the value of the property text.- Property description:
- Defines text string that is to be displayed.
- Default value:
- empty string
-
textProperty
Defines text string that is to be displayed.- Default value:
- empty string
- See Also:
-
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
Defines the X coordinate of text origin.- Default value:
- 0
- See Also:
-
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
Defines the Y coordinate of text origin.- Default value:
- 0
- See Also:
-
setFont
Sets the value of the property font.- Property description:
- Defines the font of text.
- Default value:
- Font{}
-
getFont
Gets the value of the property font.- Property description:
- Defines the font of text.
- Default value:
- Font{}
-
fontProperty
Defines the font of text.- Default value:
- Font{}
- See Also:
-
setTextOrigin
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
andVPos.TOP
define the origin of the top row whileVPos.BOTTOM
defines the origin of the bottom row. - Default value:
- VPos.BASELINE
-
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
andVPos.TOP
define the origin of the top row whileVPos.BOTTOM
defines the origin of the bottom row. - Default value:
- VPos.BASELINE
-
textOriginProperty
Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are renderedVPos.BASELINE
andVPos.TOP
define the origin of the top row whileVPos.BOTTOM
defines the origin of the bottom row.- Default value:
- VPos.BASELINE
- See Also:
-
setBoundsType
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
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
Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. SeeTextBoundsType
for more information.- Default value:
- TextBoundsType.LOGICAL
- See Also:
-
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.
The width is measured in pixels (and 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.
The width is measured in pixels (and 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
Defines a width constraint for the text in user space coordinates. The width is measured in pixels (and 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:
-
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
Defines if each line of text should have a line below it.- Default value:
- false
- See Also:
-
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
Defines if each line of text should have a line through it.- Default value:
- false
- See Also:
-
setTextAlignment
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
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
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:
-
setLineSpacing
public final void setLineSpacing(double spacing) Sets the value of the property lineSpacing.- Property description:
- Defines the vertical space in pixel between lines.
- Default value:
- 0
- Since:
- JavaFX 8.0
-
getLineSpacing
public final double getLineSpacing()Gets the value of the property lineSpacing.- Property description:
- Defines the vertical space in pixel between lines.
- Default value:
- 0
- Since:
- JavaFX 8.0
-
lineSpacingProperty
Defines the vertical space in pixel between lines.- Default value:
- 0
- Since:
- JavaFX 8.0
- See Also:
-
getBaselineOffset
public final double getBaselineOffset()Gets the value of the property baselineOffset.- Overrides:
getBaselineOffset
in classNode
- 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.
- Returns:
- offset of text baseline from layoutBounds.minY for non-resizable Nodes or
Node.BASELINE_OFFSET_SAME_AS_HEIGHT
otherwise
-
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:
-
setFontSmoothingType
Sets the value of the property fontSmoothingType.- Property description:
- Specifies a requested font smoothing type: gray or LCD.
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
- Since:
- JavaFX 2.1
-
getFontSmoothingType
Gets the value of the property fontSmoothingType.- Property description:
- Specifies a requested font smoothing type: gray or LCD.
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
- Since:
- JavaFX 2.1
-
fontSmoothingTypeProperty
Specifies a requested font smoothing type: gray or LCD.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
- Since:
- JavaFX 2.1
- See Also:
-
getSelectionShape
Gets the value of the property selectionShape.- Property description:
- The shape of the selection in local coordinates.
- Since:
- 9
-
selectionShapeProperty
The shape of the selection in local coordinates.- Since:
- 9
- See Also:
-
setSelectionStart
public final void setSelectionStart(int value) Sets the value of the property selectionStart.- Property description:
- The start index of the selection in the content. If the value is -1, the selection is unset.
- Default value:
- -1
- Since:
- 9
-
getSelectionStart
public final int getSelectionStart()Gets the value of the property selectionStart.- Property description:
- The start index of the selection in the content. If the value is -1, the selection is unset.
- Default value:
- -1
- Since:
- 9
-
selectionStartProperty
The start index of the selection in the content. If the value is -1, the selection is unset.- Default value:
- -1
- Since:
- 9
- See Also:
-
setSelectionEnd
public final void setSelectionEnd(int value) Sets the value of the property selectionEnd.- Property description:
- The end index of the selection in the content. If the value is -1, the selection is unset.
- Default value:
- -1
- Since:
- 9
-
getSelectionEnd
public final int getSelectionEnd()Gets the value of the property selectionEnd.- Property description:
- The end index of the selection in the content. If the value is -1, the selection is unset.
- Default value:
- -1
- Since:
- 9
-
selectionEndProperty
The end index of the selection in the content. If the value is -1, the selection is unset.- Default value:
- -1
- Since:
- 9
- See Also:
-
selectionFillProperty
The fill color of selected text.- Since:
- 9
- See Also:
-
setSelectionFill
Sets the value of the property selectionFill.- Property description:
- The fill color of selected text.
- Since:
- 9
-
getSelectionFill
Gets the value of the property selectionFill.- Property description:
- The fill color of selected text.
- Since:
- 9
-
getCaretShape
Gets the value of the property caretShape.- Property description:
- The shape of caret, in local coordinates.
- Since:
- 9
-
caretShapeProperty
The shape of caret, in local coordinates.- Since:
- 9
- See Also:
-
setCaretPosition
public final void setCaretPosition(int value) Sets the value of the property caretPosition.- Property description:
- The caret index in the content. If the value is -1, the caret is unset.
- Default value:
- -1
- Since:
- 9
-
getCaretPosition
public final int getCaretPosition()Gets the value of the property caretPosition.- Property description:
- The caret index in the content. If the value is -1, the caret is unset.
- Default value:
- -1
- Since:
- 9
-
caretPositionProperty
The caret index in the content. If the value is -1, the caret is unset.- Default value:
- -1
- Since:
- 9
- See Also:
-
setCaretBias
public final void setCaretBias(boolean value) Sets the value of the property caretBias.- Property description:
- The type of caret bias in the content. If
true
, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge. - Default value:
true
- Since:
- 9
-
isCaretBias
public final boolean isCaretBias()Gets the value of the property caretBias.- Property description:
- The type of caret bias in the content. If
true
, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge. - Default value:
true
- Since:
- 9
-
caretBiasProperty
The type of caret bias in the content. Iftrue
, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge.- Default value:
true
- Since:
- 9
- See Also:
-
hitTest
Maps local point to index in the content.- Parameters:
point
- the specified point to be tested- Returns:
- a
HitInfo
representing the character index found - Since:
- 9
-
caretShape
Returns the shape for the caret at the given index and bias.- Parameters:
charIndex
- the character index for the caretcaretBias
- whether the caret is biased on the leading edge of the character- Returns:
- an array of
PathElement
which can be used to create aShape
- Since:
- 9
-
rangeShape
Returns the shape for the range of the text in local coordinates.- Parameters:
start
- the beginning character index for the rangeend
- the end character index (non-inclusive) for the range- Returns:
- an array of
PathElement
which can be used to create aShape
- Since:
- 9
-
underlineShape
Returns the shape for the underline in local coordinates.- Parameters:
start
- the beginning character index for the rangeend
- the end character index (non-inclusive) for the range- Returns:
- an array of
PathElement
which can be used to create aShape
- Since:
- 9
-
tabSizeProperty
The size of a tab stop in spaces. Values less than 1 are treated as 1.- Default value:
- 8
- Since:
- 14
- See Also:
-
getTabSize
public final int getTabSize()Gets the value of the property tabSize.- Property description:
- The size of a tab stop in spaces. Values less than 1 are treated as 1.
- Default value:
- 8
- Since:
- 14
-
setTabSize
public final void setTabSize(int spaces) Sets the value of the property tabSize.- Property description:
- The size of a tab stop in spaces. Values less than 1 are treated as 1.
- Default value:
- 8
- Since:
- 14
-
getClassCssMetaData
Gets theCssMetaData
associated with this class, which may include theCssMetaData
of its superclasses.- Returns:
- the
CssMetaData
- Since:
- JavaFX 8.0
-
getCssMetaData
This method should delegate toNode.getClassCssMetaData()
so that a Node's CssMetaData can be accessed without the need for reflection.- Specified by:
getCssMetaData
in interfaceStyleable
- Overrides:
getCssMetaData
in classShape
- Returns:
- The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.
- Since:
- JavaFX 8.0
-
toString
Returns a string representation of thisText
object.
-