JavaFX 24 · javafx.scene.text.Text · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	Text.StyleableProperties
private class	Text.TextAttribute

Modifier and Type	Field and Description
private Text.TextAttribute	attributes
private ObjectProperty<TextBoundsType>	boundsType Determines how the bounds of the text node are calculated.
private static final TextBoundsType	DEFAULT_BOUNDS_TYPE
private static final boolean	DEFAULT_CARET_BIAS
private static final int	DEFAULT_CARET_POSITION
private static final double	DEFAULT_LINE_SPACING
private static final int	DEFAULT_SELECTION_END
private static final Color	DEFAULT_SELECTION_FILL
private static final int	DEFAULT_SELECTION_START
private static final boolean	DEFAULT_STRIKETHROUGH
private static final TextAlignment	DEFAULT_TEXT_ALIGNMENT
private static final VPos	DEFAULT_TEXT_ORIGIN
private static final boolean	DEFAULT_UNDERLINE
private static final PathElement[]	EMPTY_PATH_ELEMENT_ARRAY
private ObjectProperty<Font>	font Defines the font of text.
private ObjectProperty<FontSmoothingType>	fontSmoothingType Specifies a requested font smoothing type: gray or LCD.
private boolean	isSpan
private TextLayout	layout
private BaseBounds	spanBounds
private boolean	spanBoundsInvalid
private StringProperty	text Defines text string that is to be displayed.
private GlyphList[]	textRuns
private TextSpan	textSpan
private DoubleProperty	wrappingWidth Defines a width constraint for the text in user space coordinates.
private DoubleProperty	x Defines the X coordinate of text origin.
private DoubleProperty	y Defines the Y coordinate of text origin.

Access	Constructor and Description
public	Text() Creates an empty instance of Text.
public	Text(String text to be contained in the instance text) Creates an instance of Text containing the given string.
public	Text(double the horizontal position of the text x, double the vertical position of the text y, String text to be contained in the instance text) Creates an instance of Text on the given coordinates containing the given string.

Method Summary

Modifier and Type	Method and Description
public final ReadOnlyDoubleProperty	Returns: the baseline offset from this text node baselineOffsetProperty() The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.
public final ObjectProperty<TextBoundsType>	boundsTypeProperty()
public final BooleanProperty	Returns: the `caretBias` property caretBiasProperty() The type of caret bias in the content.
public final IntegerProperty	Returns: the `caretPosition` property caretPositionProperty() The caret index in the content.
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` caretShape(int the character index for the caret charIndex, boolean whether the caret is biased on the leading edge of the character caretBias) Returns the shape for the caret at the given index and bias.
public final ReadOnlyObjectProperty<PathElement[]>	Returns: the `caretShape` property caretShapeProperty() The shape of caret, in local coordinates.
private void	checkOrientation()
private void	checkSpan()
private boolean	doComputeContains(double localX, double localY) Hides javafx.scene.shape.Shape.doComputeContains.
private BaseBounds	doComputeGeomBounds(BaseBounds bounds, BaseTransform tx) Hides javafx.scene.shape.Shape.doComputeGeomBounds.
private Bounds	doComputeLayoutBounds() Hides javafx.scene.Node.doComputeLayoutBounds.
private Shape	doConfigShape()
private NGNode	doCreatePeer()
private void	doGeomChanged() Hides javafx.scene.Node.doGeomChanged.
private void	doUpdatePeer() Hides javafx.scene.shape.Shape.doUpdatePeer.
private int	findFirstRunStart()
public final ObjectProperty<Font>	fontProperty()
public final ObjectProperty<FontSmoothingType>	fontSmoothingTypeProperty()
public final double	getBaselineOffset() Overrides javafx.scene.Node.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.
public final TextBoundsType	getBoundsType()
public final int	getCaretPosition()
public final PathElement[]	getCaretShape()
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.shape.Shape.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.shape.Shape.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public final Font	getFont()
private Object	Returns: the font getFontInternal() Internally used safe version of getFont which never returns null.
public final FontSmoothingType	getFontSmoothingType()
public final double	getLineSpacing()
private BaseBounds	getLogicalBounds()
private PathElement[]	getRange(int start, int end, int type)
private GlyphList[]	getRuns()
public final int	getSelectionEnd()
public final Paint	getSelectionFill()
public final PathElement[]	getSelectionShape()
public final int	getSelectionStart()
private Shape	getShape()
pack-priv BaseBounds	getSpanBounds()
public final int	getTabSize()
public final String	getText()
public final TextAlignment	getTextAlignment()
private Text.TextAttribute	getTextAttribute()
private String	getTextInternal()
private TextLayout	getTextLayout()
public final VPos	getTextOrigin()
pack-priv TextSpan	getTextSpan()
private BaseBounds	getVisualBounds()
public final double	getWrappingWidth()
public final double	getX()
public final double	getY()
private float	getYAdjustment(BaseBounds bounds)
private float	getYRendering()
public final HitInfo	Returns: a `HitInfo` representing the character index found hitTest(Point2D the specified point to be tested point) Maps local point to `HitInfo` in the content.
public final boolean	isCaretBias()
private boolean	isSpan()
public final boolean	isStrikethrough()
public final boolean	isUnderline()
pack-priv void	layoutSpan(GlyphList[] runs)
public final DoubleProperty	Returns: the vertical space in pixel between lines lineSpacingProperty() Defines the vertical space in pixel between lines.
private void	needsFullTextLayout()
private void	needsTextLayout()
public Object	queryAccessibleAttribute(AccessibleAttribute the requested attribute attribute, Object... optional list of parameters parameters) Overrides javafx.scene.Node.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` rangeShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end) Returns the shape for the range of the text in local coordinates.
public final IntegerProperty	Returns: the `selectionEnd` property selectionEndProperty() The end index of the selection in the content.
public final ObjectProperty<Paint>	Returns: the fill color of selected text selectionFillProperty() The fill color of selected text.
public final ReadOnlyObjectProperty<PathElement[]>	Returns: the `selectionShape` property selectionShapeProperty() The shape of the selection in local coordinates.
public final IntegerProperty	Returns: the `selectionStart` property selectionStartProperty() The start index of the selection in the content.
public final void	setBoundsType(TextBoundsType value)
public final void	setCaretBias(boolean value)
public final void	setCaretPosition(int value)
public final void	setFont(Font value)
public final void	setFontSmoothingType(FontSmoothingType value)
public final void	setLineSpacing(double spacing)
public final void	setSelectionEnd(int value)
public final void	setSelectionFill(Paint paint)
public final void	setSelectionStart(int value)
public final void	setStrikethrough(boolean value)
public final void	setTabSize(int spaces)
public final void	setText(String value)
public final void	setTextAlignment(TextAlignment value)
public final void	setTextOrigin(VPos value)
public final void	setUnderline(boolean value)
public final void	setWrappingWidth(double value)
public final void	setX(double value)
public final void	setY(double value)
public final BooleanProperty	Returns: if each line of text should have a line through it strikethroughProperty() Defines if each line of text should have a line through it.
public final IntegerProperty	Returns: the `tabSize` property tabSizeProperty() The size of a tab stop in spaces.
public final ObjectProperty<TextAlignment>	Returns: the horizontal text alignment in the bounding box textAlignmentProperty() Defines horizontal text alignment in the bounding box.
public final ObjectProperty<VPos>	Returns: the origin of text coordinate system in local coordinates textOriginProperty() Defines the origin of text coordinate system in local coordinates.
public final StringProperty	textProperty()
public String	Returns: a string representation of this `Text` object. toString() Overrides javafx.scene.Node.toString. Returns a string representation of this `Text` object.
public final BooleanProperty	Returns: if each line of text should have a line below it underlineProperty() Defines if each line of text should have a line below it.
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` underlineShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end) Returns the shape for the underline in local coordinates.
private void	updatePGText()
public boolean	usesMirroring() Overrides javafx.scene.Node.usesMirroring. Determines whether a node should be mirrored when node orientation is right-to-left.
public final DoubleProperty	wrappingWidthProperty()
public final DoubleProperty	xProperty()
public final DoubleProperty	yProperty()

public non-sealed Class Text

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary