Class RichTextArea

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

jfx.incubator.scene.control.richtext.RichTextArea

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

Direct Known Subclasses:

CodeArea

public class RichTextArea
extends Control

The RichTextArea control is designed for visualizing and editing rich text that can be styled in a variety of ways.

The RichTextArea control has a number of features, including:

• paragraph-oriented model, up to ~2 billion rows
• virtualized text cell flow
• support for text styling with an application stylesheet or inline attributes
• support for multiple views connected to the same model
• single selection
• input map which allows for easy behavior customization and extension

Creating a RichTextArea

The following example creates an editable control with the default RichTextModel:

   RichTextArea textArea = new RichTextArea();

The methods appendText(), insertText(), replaceText(), applyStyle(), setStyle(), or clear() can be used to modify text programmatically:

   // create styles
  StyleAttributeMap heading = StyleAttributeMap.builder().setBold(true).setUnderline(true).setFontSize(18).build();
  StyleAttributeMap mono = StyleAttributeMap.builder().setFontFamily("Monospaced").build();

  RichTextArea textArea = new RichTextArea();
  // build the content
  textArea.setUndoRedoEnabled(false);
  textArea.appendText("RichTextArea\n", heading);
  textArea.appendText("Example:\nText is ", StyleAttributeMap.EMPTY);
  textArea.appendText("monospaced.\n", mono);
  textArea.setUndoRedoEnabled(true);

Which results in the following visual representation:

A view-only information control requires a different model. The following example illustrates how to create a model that uses a stylesheet for styling:

    SimpleViewOnlyStyledModel m = new SimpleViewOnlyStyledModel();
    // add text segment using CSS style name (requires a stylesheet)
    m.addWithStyleNames("RichTextArea ", "HEADER");
    // add text segment using inline styles
    m.addWithInlineStyle("Demo", "-fx-font-size:200%; -fx-font-weight:bold;");
    // add newline
    m.nl();

    RichTextArea textArea = new RichTextArea(m);

Text Models

A number of standard models can be used with RichTextArea, each addressing a specific use case:

Standard Models

Model Class	Description
StyledTextModel	Base class (abstract)
├─ RichTextModel	Default model for RichTextArea
├─ BasicTextModel	Unstyled text model
│ └─ CodeTextModel	Default model for CodeArea
└─ StyledTextModelViewOnlyBase	Base class for a view-only model (abstract)
└─ SimpleViewOnlyStyledModel	In-memory view-only styled model

Selection

The RichTextArea control maintains a single contiguous selection segment as a part of the SelectionModel. Additionally, anchorPositionProperty() and caretPositionProperty() read-only properties are derived from the selectionProperty() for convenience.

Customizing

The RichTextArea control offers some degree of customization that does not require subclassing:

• customizing key bindings with the InputMap
• setting leftDecorator and rightDecorator properties

Since:

24

See Also:

• StyledTextModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RichTextArea.Tag	Function tags serve as identifiers of methods that can be customized via the InputMap.

Property Summary

Properties

Type	Property	Description
final ReadOnlyProperty<TextPos>	anchorPosition	Tracks the selection anchor position within the document.
final ObjectProperty<Duration>	caretBlinkPeriod	Determines the caret blink period.
final ReadOnlyProperty<TextPos>	caretPosition	Tracks the caret position within the document.
final ObjectProperty<Insets>	contentPadding	Specifies the padding for the RichTextArea content.
final BooleanProperty	displayCaret	This property controls whether caret will be displayed or not.
final ReadOnlyObjectProperty<Bounds>	documentArea	Provides the bounds to the document area in local coordinates.
final ReadOnlyProperty<TextPos>	dropTarget	This property indicates the target text position during drag-and-drop operations.
final BooleanProperty	editable	Indicates whether this RichTextArea can be edited by the user, provided the model is also writable.
final BooleanProperty	highlightCurrentParagraph	Indicates whether the current paragraph will be visually highlighted.
final ObjectProperty<StyleAttributeMap>	insertStyles	Specifies the styles to be in effect for the characters to be inserted via user input.
final ObjectProperty<SideDecorator>	leftDecorator	Specifies the left-side paragraph decorator.
final ObjectProperty<StyledTextModel>	model	Determines the StyledTextModel to use with this RichTextArea.
final ReadOnlyBooleanProperty	redoable	The property describes if it's currently possible to redo the latest change of the content that was undone.
final ObjectProperty<SideDecorator>	rightDecorator	Specifies the right-side paragraph decorator.
final ReadOnlyProperty<SelectionSegment>	selection	Tracks the current selection.
final ReadOnlyBooleanProperty	undoable	The property describes if it's currently possible to undo the latest change of the content that was done.
final BooleanProperty	useContentHeight	Determines whether the preferred height is the same as the content height.
final BooleanProperty	useContentWidth	Determines whether the preferred width is the same as the content width.
final BooleanProperty	wrapText	Indicates whether text should be wrapped in this RichTextArea.

Properties declared in class Control

contextMenu, skin, tooltip

Type	Property	Description
final ObjectProperty<ContextMenu>	contextMenu	The ContextMenu to show for this control.
final ObjectProperty<Skin<?>>	skin	Skin is responsible for rendering this Control.
final ObjectProperty<Tooltip>	tooltip	The ToolTip for this control.

Properties declared in class Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Type	Property	Description
final ObjectProperty<Background>	background	The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.
final ObjectProperty<Border>	border	The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.
final BooleanProperty	cacheShape	Defines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.
final BooleanProperty	centerShape	Defines whether the shape is centered within the Region's width and height.
final ReadOnlyDoubleProperty	height	The height of this resizable node.
final ReadOnlyObjectProperty<Insets>	insets	The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.
final DoubleProperty	maxHeight	Property for overriding the region's computed maximum height.
final DoubleProperty	maxWidth	Property for overriding the region's computed maximum width.
final DoubleProperty	minHeight	Property for overriding the region's computed minimum height.
final DoubleProperty	minWidth	Property for overriding the region's computed minimum width.
final ObjectProperty<Insets>	opaqueInsets	Defines the area of the region within which completely opaque pixels are drawn.
final ObjectProperty<Insets>	padding	The top, right, bottom, and left padding around the region's content.
final DoubleProperty	prefHeight	Property for overriding the region's computed preferred height.
final DoubleProperty	prefWidth	Property for overriding the region's computed preferred width.
final BooleanProperty	scaleShape	Specifies whether the shape, if defined, is scaled to match the size of the Region.
final ObjectProperty<Shape>	shape	When specified, the Shape will cause the region to be rendered as the specified shape rather than as a rounded rectangle.
final BooleanProperty	snapToPixel	Defines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.
final ReadOnlyDoubleProperty	width	The width of this resizable node.

Properties declared in class Parent

needsLayout

Type	Property	Description
final ReadOnlyBooleanProperty	needsLayout	Indicates that this Node and its subnodes requires a layout pass on the next pulse.

Properties declared in class Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragDone, 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

Type	Property	Description
final ObjectProperty<String>	accessibleHelp	The accessible help text for this Node.
final ObjectProperty<String>	accessibleRoleDescription	The role description of this Node.
final ObjectProperty<AccessibleRole>	accessibleRole	The accessible role for this Node.
final ObjectProperty<String>	accessibleText	The accessible text for this Node.
final ObjectProperty<BlendMode>	blendMode	The BlendMode used to blend this individual node into the scene behind it.
final ReadOnlyObjectProperty<Bounds>	boundsInLocal	The rectangular bounds of this Node in the node's untransformed local coordinate space.
final ReadOnlyObjectProperty<Bounds>	boundsInParent	The rectangular bounds of this Node in the parent coordinate system.
final ObjectProperty<CacheHint>	cacheHint	Additional hint for controlling bitmap caching.
final BooleanProperty	cache	A performance hint to the system to indicate that this Node should be cached as a bitmap.
final ObjectProperty<Node>	clip	Specifies a Node to use to define the clipping shape for this Node.
final ObjectProperty<Cursor>	cursor	Defines the mouse cursor for this Node and subnodes.
final ObjectProperty<DepthTest>	depthTest	Indicates whether depth testing is used when rendering this node.
final ReadOnlyBooleanProperty	disabled	Indicates whether or not this Node is disabled.
final BooleanProperty	disable	Defines the individual disabled state of this Node.
final ReadOnlyObjectProperty<NodeOrientation>	effectiveNodeOrientation	The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.
final ObjectProperty<Effect>	effect	Specifies an effect to apply to this Node.
final ObjectProperty<EventDispatcher>	eventDispatcher	Specifies the event dispatcher for this node.
final ReadOnlyBooleanProperty	focused	Indicates whether this Node currently has the input focus.
final BooleanProperty	focusTraversable	Specifies whether this Node should be a part of focus traversal cycle.
final ReadOnlyBooleanProperty	focusVisible	Indicates whether this Node should visibly indicate focus.
final ReadOnlyBooleanProperty	focusWithin	Indicates whether this Node or any of its descendants currently has the input focus.
final ReadOnlyBooleanProperty	hover	Whether or not this Node is being hovered over.
final StringProperty	id	The id of this Node.
final ObjectProperty<InputMethodRequests>	inputMethodRequests	Property holding InputMethodRequests.
final ReadOnlyObjectProperty<Bounds>	layoutBounds	The rectangular bounds that should be used for layout calculations for this node.
final DoubleProperty	layoutX	Defines the x coordinate of the translation that is added to this Node's transform for the purpose of layout.
final DoubleProperty	layoutY	Defines the y coordinate of the translation that is added to this Node's transform for the purpose of layout.
final ReadOnlyObjectProperty<Transform>	localToParentTransform	An affine transform that holds the computed local-to-parent transform.
final ReadOnlyObjectProperty<Transform>	localToSceneTransform	An affine transform that holds the computed local-to-scene transform.
final BooleanProperty	managed	Defines whether or not this node's layout will be managed by its parent.
final BooleanProperty	mouseTransparent	If true, this node (together with all its children) is completely transparent to mouse events.
final ObjectProperty<NodeOrientation>	nodeOrientation	Node orientation describes the flow of visual data within a node.
final ObjectProperty<EventHandler<? super ContextMenuEvent>>	onContextMenuRequested	Defines a function to be called when a context menu has been requested on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onDragDetected	Defines a function to be called when drag gesture has been detected.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDone	Defines a function to be called when this Node is a drag and drop gesture source after its data has been dropped on a drop target.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDropped	Defines a function to be called when the mouse button is released on this Node during drag and drop gesture.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragEntered	Defines a function to be called when drag gesture enters this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragExited	Defines a function to be called when drag gesture exits this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragOver	Defines a function to be called when drag gesture progresses within this Node.
final ObjectProperty<EventHandler<? super InputMethodEvent>>	onInputMethodTextChanged	Defines a function to be called when this Node has input focus and the input method text has changed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyPressed	Defines a function to be called when this Node or its child Node has input focus and a key has been pressed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyReleased	Defines a function to be called when this Node or its child Node has input focus and a key has been released.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyTyped	Defines a function to be called when this Node or its child Node has input focus and a key has been typed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseClicked	Defines a function to be called when a mouse button has been clicked (pressed and released) on this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragDone	Defines a function to be called when a full press-drag-release gesture ends with this node as its source.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragEntered	Defines a function to be called when a full press-drag-release gesture enters this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragExited	Defines a function to be called when a full press-drag-release gesture leaves this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseDragged	Defines a function to be called when a mouse button is pressed on this Node and then dragged.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragOver	Defines a function to be called when a full press-drag-release gesture progresses within this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragReleased	Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseEntered	Defines a function to be called when the mouse enters this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseExited	Defines a function to be called when the mouse exits this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseMoved	Defines a function to be called when mouse cursor moves within this Node but no buttons have been pushed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMousePressed	Defines a function to be called when a mouse button has been pressed on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseReleased	Defines a function to be called when a mouse button has been released on this Node.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotate	Defines a function to be called when user performs a rotation action.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationFinished	Defines a function to be called when a rotation gesture ends.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationStarted	Defines a function to be called when a rotation gesture is detected.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollFinished	Defines a function to be called when a scrolling gesture ends.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScroll	Defines a function to be called when user performs a scrolling action.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollStarted	Defines a function to be called when a scrolling gesture is detected.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeDown	Defines a function to be called when a downward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeLeft	Defines a function to be called when a leftward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeRight	Defines a function to be called when an rightward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeUp	Defines a function to be called when an upward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchMoved	Defines a function to be called when a touch point is moved.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchPressed	Defines a function to be called when a new touch point is pressed.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchReleased	Defines a function to be called when a touch point is released.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchStationary	Defines a function to be called when a touch point stays pressed and still.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomFinished	Defines a function to be called when a zooming gesture ends.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoom	Defines a function to be called when user performs a zooming action.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomStarted	Defines a function to be called when a zooming gesture is detected.
final DoubleProperty	opacity	Specifies how opaque (that is, solid) the Node appears.
final ReadOnlyObjectProperty<Parent>	parent	The parent of this Node.
final BooleanProperty	pickOnBounds	Defines how the picking computation is done for this node when triggered by a MouseEvent or a contains function call.
final ReadOnlyBooleanProperty	pressed	Whether or not the Node is pressed.
final DoubleProperty	rotate	Defines the angle of rotation about the Node's center, measured in degrees.
final ObjectProperty<Point3D>	rotationAxis	Defines the axis of rotation of this Node.
final DoubleProperty	scaleX	Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node.
final DoubleProperty	scaleY	Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node.
final DoubleProperty	scaleZ	Defines the factor by which coordinates are scaled about the center of the object along the Z axis of this Node.
final ReadOnlyObjectProperty<Scene>	scene	The Scene that this Node is part of.
final StringProperty	style	A string representation of the CSS style associated with this specific Node.
final DoubleProperty	translateX	Defines the x coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateY	Defines the y coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateZ	Defines the Z coordinate of the translation that is added to the transformed coordinates of this Node.
final DoubleProperty	viewOrder	Defines the rendering and picking order of this Node within its parent.
final BooleanProperty	visible	Specifies whether this Node and any subnodes should be rendered as part of the scene graph.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final StyleHandlerRegistry	styleHandlerRegistry	The style handler registry instance, made available for use by subclasses to add support for new style attributes.

Fields declared in class Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Modifier and Type	Field	Description
static final double	USE_COMPUTED_SIZE	Sentinel value which can be passed to a region's setMinWidth, setMinHeight, setPrefWidth, setPrefHeight, setMaxWidth, setMaxHeight methods to reset the region's size constraint back to it's intrinsic size returned by computeMinWidth, computeMinHeight, computePrefWidth, computePrefHeight, computeMaxWidth, or computeMaxHeight.
static final double	USE_PREF_SIZE	Sentinel value which can be passed to a region's setMinWidth, setMinHeight, setMaxWidth or setMaxHeight methods to indicate that the preferred dimension should be used for that max and/or min constraint.

Fields declared in class Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Modifier and Type	Field	Description
static final double	BASELINE_OFFSET_SAME_AS_HEIGHT	This is a special value that might be returned by Node.getBaselineOffset().

Constructor Summary

Constructors

Constructor	Description
RichTextArea()	Creates the instance with the in-memory model RichTextModel.
RichTextArea(StyledTextModel model)	Creates the instance using the specified model.

Method Summary

Modifier and Type	Method	Description
final ReadOnlyProperty<TextPos>	anchorPositionProperty()	Tracks the selection anchor position within the document.
final TextPos	appendText(String text)	Appends the styled text to the end of the document.
final TextPos	appendText(String text, StyleAttributeMap attrs)	Appends the styled text to the end of the document.
final TextPos	appendText(StyledInput in)	Appends the styled content to the end of the document.
void	applyStyle(TextPos start, TextPos end, StyleAttributeMap attrs)	Applies the specified style to the selected range.
void	backspace()	When selection exists, deletes selected text.
final ObjectProperty<Duration>	caretBlinkPeriodProperty()	Determines the caret blink period.
final ReadOnlyProperty<TextPos>	caretPositionProperty()	Tracks the caret position within the document.
final void	clear()	Clears the document.
final void	clearDropTarget()	Sets the value of the dropTarget property to null.
final void	clearSelection()	Clears existing selection, if any.
final void	clearUndoRedo()	Clears the undo-redo stack of the underlying model.
final ObjectProperty<Insets>	contentPaddingProperty()	Specifies the padding for the RichTextArea content.
void	copy()	When selection exists, copies the selected rich text to the clipboard in all the formats supported by the model.
final void	copy(DataFormat format)	Copies the selected text in the specified format to the clipboard.
protected RichTextAreaSkin	createDefaultSkin()	Create a new instance of the default skin for this control.
void	cut()	Transfers the currently selected text to the clipboard, removing the current selection.
void	delete()	When selection exists, deletes selected text.
void	deleteParagraph()	When selection exists, deletes selected paragraphs.
void	deleteParagraphStart()	Deletes text from the caret position to the start of the paragraph, ignoring existing selection.
void	deleteWordNextEnd()	Deletes from the caret positon to the end of next word, ignoring existing selection.
void	deleteWordNextStart()	Deletes from the caret positon to the start of next word, ignoring existing selection.
void	deleteWordPrevious()	Deletes (multiple) empty paragraphs or text from the caret position to the start of the previous word, ignoring existing selection.
void	deselect()	Clears the selected text range by moving anchor to the caret position.
final BooleanProperty	displayCaretProperty()	This property controls whether caret will be displayed or not.
final ReadOnlyObjectProperty<Bounds>	documentAreaProperty()	Provides the bounds to the document area in local coordinates.
final ReadOnlyProperty<TextPos>	dropTargetProperty()	This property indicates the target text position during drag-and-drop operations.
final BooleanProperty	editableProperty()	Indicates whether this RichTextArea can be edited by the user, provided the model is also writable.
void	errorFeedback()	Provides audio and/or visual error feedback.
final void	execute(FunctionTag tag)	Executes a function mapped to the specified function tag.
final void	executeDefault(FunctionTag tag)	Executes the default function mapped to the specified tag.
final void	extendSelection(TextPos pos)	Extends selection to the specified position.
final StyleAttributeMap	getActiveStyleAttributeMap()	Returns StyleAttributeMap which contains character and paragraph attributes.
final TextPos	getAnchorPosition()	Gets the value of the anchorPosition property.
final Duration	getCaretBlinkPeriod()	Gets the value of the caretBlinkPeriod property.
final TextPos	getCaretPosition()	Gets the value of the caretPosition property.
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
final Insets	getContentPadding()	Gets the value of the contentPadding property.
List<CssMetaData<? extends Styleable, ?>>	getControlCssMetaData()	Gets the unmodifiable list of the control's CSS-styleable properties.
final Bounds	getDocumentArea()	Gets the value of the documentArea property.
final TextPos	getDocumentEnd()	Returns a TextPos corresponding to the end of the document.
final TextPos	getDropTarget()	Gets the value of the dropTarget property.
final InputMap	getInputMap()	Returns the input map instance.
final StyleAttributeMap	getInsertStyles()	Gets the value of the insertStyles property.
final SideDecorator	getLeftDecorator()	Gets the value of the leftDecorator property.
final LineEnding	getLineEnding()	Convenience method which delegates to StyledTextModel.getLineEnding().
final StyledTextModel	getModel()	Gets the value of the model property.
final int	getParagraphCount()	Returns the number of paragraphs in the model.
final TextPos	getParagraphEnd(int index)	Returns a TextPos corresponding to the end of paragraph.
final String	getPlainText(int index)	Returns the plain text at the specified paragraph index.
final SideDecorator	getRightDecorator()	Gets the value of the rightDecorator property.
final SelectionSegment	getSelection()	Gets the value of the selection property.
final StyleAttributeMap	getStyleAttributeMap(TextPos pos, boolean forInsert)	Returns the StyleAttributeMap of the character at the specified position's charIndex.
StyleHandlerRegistry	getStyleHandlerRegistry()	Returns the style handler registry for this control.
final TextPos	getTextPosition(double screenX, double screenY)	Finds a text position corresponding to the specified screen coordinates.
final boolean	hasNonEmptySelection()	This convenience method returns true when a non-empty selection exists.
final BooleanProperty	highlightCurrentParagraphProperty()	Indicates whether the current paragraph will be visually highlighted.
void	insertLineBreak()	Inserts a line break at the caret.
final ObjectProperty<StyleAttributeMap>	insertStylesProperty()	Specifies the styles to be in effect for the characters to be inserted via user input.
void	insertTab()	Inserts a tab symbol at the caret.
final TextPos	insertText(TextPos pos, String text, StyleAttributeMap attrs)	Inserts the styled text at the specified position.
final TextPos	insertText(TextPos pos, StyledInput in)	Inserts the styled content at the specified position.
final boolean	isDisplayCaret()	Gets the value of the displayCaret property.
final boolean	isEditable()	Gets the value of the editable property.
final boolean	isHighlightCurrentParagraph()	Gets the value of the highlightCurrentParagraph property.
final boolean	isRedoable()	Gets the value of the redoable property.
final boolean	isUndoable()	Gets the value of the undoable property.
final boolean	isUndoRedoEnabled()	Indicates whether undo/redo functionality is enabled in the model.
final boolean	isUseContentHeight()	Gets the value of the useContentHeight property.
final boolean	isUseContentWidth()	Gets the value of the useContentWidth property.
final boolean	isWrapText()	Gets the value of the wrapText property.
final ObjectProperty<SideDecorator>	leftDecoratorProperty()	Specifies the left-side paragraph decorator.
final ObjectProperty<StyledTextModel>	modelProperty()	Determines the StyledTextModel to use with this RichTextArea.
void	moveDocumentEnd()	Moves the caret to after the last character of the text, clearing an existing selection.
void	moveDocumentStart()	Moves the caret to before the first character of the text, clearing an existing selection.
void	moveDown()	Moves the caret one visual line down, clearing an existing selection.
void	moveLeft()	Moves the caret left, clearing an existing selection range.
void	moveLineEnd()	Moves the caret to the end of the visual text line at caret, clearing an existing selection.
void	moveLineStart()	Moves the caret to the start of the visual text line at caret, clearing an existing selection.
void	moveParagraphDown()	Moves the caret to the end of the current paragraph, or, if already there, to the end of the next paragraph.
void	moveParagraphEnd()	Moves the caret to the end of the paragraph at caret, clearing an existing selection.
void	moveParagraphStart()	Moves the caret to the start of the current paragraph, clearing an existing selection.
void	moveParagraphUp()	Moves the caret to the start of the current paragraph, or, if already there, to the start of the previous paragraph.
void	moveRight()	Moves the caret to the next symbol, clearing an existing selection.
void	moveUp()	Moves the caret one visual line up, clearing an existing selection.
void	moveWordLeft()	Moves the caret to the beginning of previous word in a left-to-right setting (or the beginning of the next word in a right-to-left setting), clearing an existing selection.
void	moveWordNextEnd()	Moves the caret to the end of the next word, clearing an existing selection.
void	moveWordNextStart()	Moves the caret to the start of next word, clearing an existing selection.
void	moveWordPrevious()	Moves the caret to the beginning of previous word, clearing an existing selection.
void	moveWordRight()	Moves the caret to the beginning of next word in a left-to-right setting (or the beginning of the previous word in a right-to-left setting), clearing an existing selection.
void	pageDown()	Move caret one visual page down, clearing an existing selection.
void	pageUp()	Move caret one visual page up, clearing an existing selection.
void	paste()	Pastes the clipboard content at the caret, or, if selection exists, replacing the selected text.
void	paste(DataFormat format)	Pastes the clipboard content at the caret, or, if selection exists, replacing the selected text.
final void	pastePlainText()	Pastes the plain text clipboard content at the caret, or, if selection exists, replacing the selected text.
final void	read(InputStream in)	Calls the model to replace the current document with the content read from the input stream.
final void	read(DataFormat f, InputStream in)	Calls the model to replace the current document with the content read from the stream using the specified DataFormat.
void	redo()	If possible, redoes the last undone modification.
final ReadOnlyBooleanProperty	redoableProperty()	The property describes if it's currently possible to redo the latest change of the content that was undone.
final TextPos	replaceText(TextPos start, TextPos end, String text)	Replaces the specified range with the new text.
final TextPos	replaceText(TextPos start, TextPos end, StyledInput in)	Replaces the specified range with the new input.
final ObjectProperty<SideDecorator>	rightDecoratorProperty()	Specifies the right-side paragraph decorator.
final void	select(TextPos pos)	Moves both the caret and the anchor to the specified position, clearing any existing selection.
final void	select(TextPos anchor, TextPos caret)	Selects the specified range and places the caret at the new position.
void	selectAll()	Selects all the text in the document: the anchor is set at the document start, while the caret is positioned at the end of the document.
void	selectDown()	Extends selection one visual text line down.
final ReadOnlyProperty<SelectionSegment>	selectionProperty()	Tracks the current selection.
void	selectLeft()	Extends selection one symbol to the left.
void	selectPageDown()	Extends selection one visible page down.
void	selectPageUp()	Extends selection one visible page up.
void	selectParagraph()	Selects the current paragraph.
void	selectParagraphDown()	Extends selection to the end of the current paragraph, or, if already at the end, to the end of the next paragraph.
void	selectParagraphEnd()	Selects from the current position to the paragraph end.
void	selectParagraphStart()	Selects from the current position to the paragraph start.
void	selectParagraphUp()	Extends selection to the start of the current paragraph, or, if already at the start, to the start of the previous paragraph.
void	selectRight()	Extends selection one symbol (or grapheme cluster) to the right.
void	selectToDocumentEnd()	Extends selection to the end of the document.
void	selectToDocumentStart()	Extends selection to the start of the document.
void	selectToLineEnd()	Extends selection to the end of the visual text line at caret.
void	selectToLineStart()	Extends selection to the start of the visual text line at caret.
void	selectUp()	Extends selection one visual text line up.
void	selectWord()	Selects a word at the caret position.
void	selectWordLeft()	Moves the caret to the beginning of previous word in a left-to-right setting, or to the beginning of the next word in a right-to-left setting.
void	selectWordNextEnd()	Extends selection to the end of the next word.
void	selectWordNextStart()	Moves the caret to the start of the next word.
void	selectWordPrevious()	Moves the caret to the beginning of previous word.
void	selectWordRight()	Moves the caret to the beginning of next word in a left-to-right setting, or to the beginning of the previous word in a right-to-left setting.
final void	setCaretBlinkPeriod(Duration period)	Sets the value of the caretBlinkPeriod property.
final void	setContentPadding(Insets value)	Sets the value of the contentPadding property.
final void	setDisplayCaret(boolean on)	Sets the value of the displayCaret property.
final void	setDropTarget(double screenX, double screenY)	Attempts to set the drop target position at the specified screen coordinates.
final void	setEditable(boolean on)	Sets the value of the editable property.
final void	setHighlightCurrentParagraph(boolean on)	Sets the value of the highlightCurrentParagraph property.
final void	setInsertStyles(StyleAttributeMap v)	Sets the value of the insertStyles property.
final void	setLeftDecorator(SideDecorator d)	Sets the value of the leftDecorator property.
final void	setLineEnding(LineEnding value)	Sets the model's line ending characters.
final void	setModel(StyledTextModel m)	Sets the value of the model property.
final void	setRightDecorator(SideDecorator d)	Sets the value of the rightDecorator property.
final void	setStyle(TextPos start, TextPos end, StyleAttributeMap attrs)	Sets the specified style to the selected range.
final void	setUndoRedoEnabled(boolean on)	Controls whether undo/redo functionality is enabled in the model.
final void	setUseContentHeight(boolean on)	Sets the value of the useContentHeight property.
final void	setUseContentWidth(boolean on)	Sets the value of the useContentWidth property.
final void	setWrapText(boolean value)	Sets the value of the wrapText property.
void	undo()	If possible, undoes the last modification.
final ReadOnlyBooleanProperty	undoableProperty()	The property describes if it's currently possible to undo the latest change of the content that was done.
final BooleanProperty	useContentHeightProperty()	Determines whether the preferred height is the same as the content height.
final BooleanProperty	useContentWidthProperty()	Determines whether the preferred width is the same as the content width.
protected void	validateModel(StyledTextModel m)	Validates the model property value.
final BooleanProperty	wrapTextProperty()	Indicates whether text should be wrapped in this RichTextArea.
final void	write(OutputStream out)	Calls the model to write the current document to the output stream, using the highest priority DataFormat as determined by the model.
final void	write(DataFormat f, OutputStream out)	Calls the model to writes the current document to the output stream using the specified DataFormat.

Methods declared in class Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, contextMenuProperty, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Modifier and Type	Method	Description
protected double	computeMaxHeight(double width)	Computes the maximum allowable height of the Control, based on the provided width.
protected double	computeMaxWidth(double height)	Computes the maximum allowable width of the Control, based on the provided height.
protected double	computeMinHeight(double width)	Computes the minimum allowable height of the Control, based on the provided width.
protected double	computeMinWidth(double height)	Computes the minimum allowable width of the Control, based on the provided height.
final ObjectProperty<ContextMenu>	contextMenuProperty()	The ContextMenu to show for this control.
final ContextMenu	getContextMenu()	Gets the value of the contextMenu property.
final List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	This method returns a List containing all CssMetaData for both this Control (returned from Control.getControlCssMetaData() and its Skin, assuming the skin property is a SkinBase.
protected Boolean	getInitialFocusTraversable()	Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
final Skin<?>	getSkin()	Gets the value of the skin property.
final Tooltip	getTooltip()	Gets the value of the tooltip property.
boolean	isResizable()	Returns true since all Controls are resizable.
final void	setContextMenu(ContextMenu value)	Sets the value of the contextMenu property.
final void	setSkin(Skin<?> value)	Sets the value of the skin property.
final void	setTooltip(Tooltip value)	Sets the value of the tooltip property.
final ObjectProperty<Skin<?>>	skinProperty()	Skin is responsible for rendering this Control.
final ObjectProperty<Tooltip>	tooltipProperty()	The ToolTip for this control.

Methods declared in class Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Modifier and Type	Method	Description
final ObjectProperty<Background>	backgroundProperty()	The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.
final ObjectProperty<Border>	borderProperty()	The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.
final BooleanProperty	cacheShapeProperty()	Defines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.
final BooleanProperty	centerShapeProperty()	Defines whether the shape is centered within the Region's width and height.
protected double	computePrefHeight(double width)	Computes the preferred height of this region for the specified width.
protected double	computePrefWidth(double height)	Computes the preferred width of this region for the specified height.
final Background	getBackground()	Gets the value of the background property.
final Border	getBorder()	Gets the value of the border property.
final double	getHeight()	Gets the value of the height property.
final Insets	getInsets()	Gets the value of the insets property.
final double	getMaxHeight()	Gets the value of the maxHeight property.
final double	getMaxWidth()	Gets the value of the maxWidth property.
final double	getMinHeight()	Gets the value of the minHeight property.
final double	getMinWidth()	Gets the value of the minWidth property.
final Insets	getOpaqueInsets()	Gets the value of the opaqueInsets property.
final Insets	getPadding()	Gets the value of the padding property.
final double	getPrefHeight()	Gets the value of the prefHeight property.
final double	getPrefWidth()	Gets the value of the prefWidth property.
final Shape	getShape()	Gets the value of the shape property.
String	getUserAgentStylesheet()	An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
final double	getWidth()	Gets the value of the width property.
final ReadOnlyDoubleProperty	heightProperty()	The height of this resizable node.
final ReadOnlyObjectProperty<Insets>	insetsProperty()	The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.
final boolean	isCacheShape()	Gets the value of the cacheShape property.
final boolean	isCenterShape()	Gets the value of the centerShape property.
final boolean	isScaleShape()	Gets the value of the scaleShape property.
final boolean	isSnapToPixel()	Gets the value of the snapToPixel property.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this region defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this region defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
static void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment, boolean isSnapToPixel)	Utility method which lays out the child within an area of it's parent defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this region defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
final double	maxHeight(double width)	Called during layout to determine the maximum height for this node.
final DoubleProperty	maxHeightProperty()	Property for overriding the region's computed maximum height.
final double	maxWidth(double height)	Called during layout to determine the maximum width for this node.
final DoubleProperty	maxWidthProperty()	Property for overriding the region's computed maximum width.
final double	minHeight(double width)	Called during layout to determine the minimum height for this node.
final DoubleProperty	minHeightProperty()	Property for overriding the region's computed minimum height.
final double	minWidth(double height)	Called during layout to determine the minimum width for this node.
final DoubleProperty	minWidthProperty()	Property for overriding the region's computed minimum width.
final ObjectProperty<Insets>	opaqueInsetsProperty()	Defines the area of the region within which completely opaque pixels are drawn.
final ObjectProperty<Insets>	paddingProperty()	The top, right, bottom, and left padding around the region's content.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this region defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
static void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment, boolean isSnapToPixel)	Utility method which positions the child within an area of this region defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
final double	prefHeight(double width)	Called during layout to determine the preferred height for this node.
final DoubleProperty	prefHeightProperty()	Property for overriding the region's computed preferred height.
final double	prefWidth(double height)	Called during layout to determine the preferred width for this node.
final DoubleProperty	prefWidthProperty()	Property for overriding the region's computed preferred width.
void	resize(double width, double height)	Invoked by the region's parent during layout to set the region's width and height.
final BooleanProperty	scaleShapeProperty()	Specifies whether the shape, if defined, is scaled to match the size of the Region.
final void	setBackground(Background value)	Sets the value of the background property.
final void	setBorder(Border value)	Sets the value of the border property.
final void	setCacheShape(boolean value)	Sets the value of the cacheShape property.
final void	setCenterShape(boolean value)	Sets the value of the centerShape property.
protected void	setHeight(double value)	Sets the value of the height property.
final void	setMaxHeight(double value)	Sets the value of the maxHeight property.
void	setMaxSize(double maxWidth, double maxHeight)	Convenience method for overriding the region's computed maximum width and height.
final void	setMaxWidth(double value)	Sets the value of the maxWidth property.
final void	setMinHeight(double value)	Sets the value of the minHeight property.
void	setMinSize(double minWidth, double minHeight)	Convenience method for overriding the region's computed minimum width and height.
final void	setMinWidth(double value)	Sets the value of the minWidth property.
final void	setOpaqueInsets(Insets value)	Sets the value of the opaqueInsets property.
final void	setPadding(Insets value)	Sets the value of the padding property.
final void	setPrefHeight(double value)	Sets the value of the prefHeight property.
void	setPrefSize(double prefWidth, double prefHeight)	Convenience method for overriding the region's computed preferred width and height.
final void	setPrefWidth(double value)	Sets the value of the prefWidth property.
final void	setScaleShape(boolean value)	Sets the value of the scaleShape property.
final void	setShape(Shape value)	Sets the value of the shape property.
final void	setSnapToPixel(boolean value)	Sets the value of the snapToPixel property.
protected void	setWidth(double value)	Sets the value of the width property.
final ObjectProperty<Shape>	shapeProperty()	When specified, the Shape will cause the region to be rendered as the specified shape rather than as a rounded rectangle.
final double	snappedBottomInset()	Utility method to get the bottom inset which includes padding and border inset.
final double	snappedLeftInset()	Utility method to get the left inset which includes padding and border inset.
final double	snappedRightInset()	Utility method to get the right inset which includes padding and border inset.
final double	snappedTopInset()	Utility method to get the top inset which includes padding and border inset.
protected double	snapPosition(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapPositionX() and snapPositionY()
double	snapPositionX(double value)	If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.
double	snapPositionY(double value)	If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.
protected double	snapSize(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSizeX() and snapSizeY()
double	snapSizeX(double value)	If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the horizontal direction, else returns the same value.
double	snapSizeY(double value)	If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the vertical direction, else returns the same value.
protected double	snapSpace(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSpaceX() and snapSpaceY()
double	snapSpaceX(double value)	If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.
double	snapSpaceY(double value)	If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.
final BooleanProperty	snapToPixelProperty()	Defines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.
final ReadOnlyDoubleProperty	widthProperty()	The width of this resizable node.

Methods declared in class Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Modifier and Type	Method	Description
double	getBaselineOffset()	Calculates the baseline offset based on the first managed child.
protected ObservableList<Node>	getChildren()	Gets the list of children of this Parent.
ObservableList<Node>	getChildrenUnmodifiable()	Gets the list of children of this Parent as a read-only list.
protected <E extends Node> List<E>	getManagedChildren()	Gets the list of all managed children of this Parent.
final ObservableList<String>	getStylesheets()	Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.
final boolean	isNeedsLayout()	Gets the value of the needsLayout property.
final void	layout()	Executes a top-down layout pass on the scene graph under this parent.
protected void	layoutChildren()	Invoked by Parent.layout() during a layout pass to position and resize the managed children.
final ReadOnlyBooleanProperty	needsLayoutProperty()	Indicates that this Node and its subnodes requires a layout pass on the next pulse.
void	requestLayout()	Requests a layout pass to be performed before the next scene is rendered.
protected final void	requestParentLayout()	Requests a layout pass of the parent to be performed before the next scene is rendered.
protected final void	setNeedsLayout(boolean value)	Sets the value of the needsLayout property.
protected void	updateBounds()	Updates the bounds of this Parent and its children.

Methods declared in class 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, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragDone, 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, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, 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, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragDoneProperty, 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, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, 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, setOnMouseDragDone, 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, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Modifier and Type	Method	Description
final ObjectProperty<String>	accessibleHelpProperty()	The accessible help text for this Node.
final ObjectProperty<String>	accessibleRoleDescriptionProperty()	The role description of this Node.
final ObjectProperty<AccessibleRole>	accessibleRoleProperty()	The accessible role for this Node.
final ObjectProperty<String>	accessibleTextProperty()	The accessible text for this Node.
final <T extends Event> void	addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Registers an event filter for this target.
final <T extends Event> void	addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Registers an event handler for this target.
final void	applyCss()	If required, apply styles to this Node and its children, if any.
final void	autosize()	If the node is resizable, will set its layout bounds to its current preferred width and height.
final ObjectProperty<BlendMode>	blendModeProperty()	The BlendMode used to blend this individual node into the scene behind it.
final ReadOnlyObjectProperty<Bounds>	boundsInLocalProperty()	The rectangular bounds of this Node in the node's untransformed local coordinate space.
final ReadOnlyObjectProperty<Bounds>	boundsInParentProperty()	The rectangular bounds of this Node in the parent coordinate system.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)	Construct an event dispatch chain for this target.
final ObjectProperty<CacheHint>	cacheHintProperty()	Additional hint for controlling bitmap caching.
final BooleanProperty	cacheProperty()	A performance hint to the system to indicate that this Node should be cached as a bitmap.
final ObjectProperty<Node>	clipProperty()	Specifies a Node to use to define the clipping shape for this Node.
double	computeAreaInScreen()	Returns the area of this Node projected onto the physical screen in pixel units.
boolean	contains(double localX, double localY)	Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.
boolean	contains(Point2D localPoint)	Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.
final ObjectProperty<Cursor>	cursorProperty()	Defines the mouse cursor for this Node and subnodes.
final ObjectProperty<DepthTest>	depthTestProperty()	Indicates whether depth testing is used when rendering this node.
final ReadOnlyBooleanProperty	disabledProperty()	Indicates whether or not this Node is disabled.
final BooleanProperty	disableProperty()	Defines the individual disabled state of this Node.
final ReadOnlyObjectProperty<NodeOrientation>	effectiveNodeOrientationProperty()	The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.
final ObjectProperty<Effect>	effectProperty()	Specifies an effect to apply to this Node.
final ObjectProperty<EventDispatcher>	eventDispatcherProperty()	Specifies the event dispatcher for this node.
void	executeAccessibleAction(AccessibleAction action, Object... parameters)	This method is called by the assistive technology to request the action indicated by the argument should be executed.
final void	fireEvent(Event event)	Fires the specified event.
final ReadOnlyBooleanProperty	focusedProperty()	Indicates whether this Node currently has the input focus.
final BooleanProperty	focusTraversableProperty()	Specifies whether this Node should be a part of focus traversal cycle.
final ReadOnlyBooleanProperty	focusVisibleProperty()	Indicates whether this Node should visibly indicate focus.
final ReadOnlyBooleanProperty	focusWithinProperty()	Indicates whether this Node or any of its descendants currently has the input focus.
final String	getAccessibleHelp()	Gets the value of the accessibleHelp property.
final AccessibleRole	getAccessibleRole()	Gets the value of the accessibleRole property.
final String	getAccessibleRoleDescription()	Gets the value of the accessibleRoleDescription property.
final String	getAccessibleText()	Gets the value of the accessibleText property.
final BlendMode	getBlendMode()	Gets the value of the blendMode property.
final Bounds	getBoundsInLocal()	Gets the value of the boundsInLocal property.
final Bounds	getBoundsInParent()	Gets the value of the boundsInParent property.
final CacheHint	getCacheHint()	Gets the value of the cacheHint property.
final Node	getClip()	Gets the value of the clip property.
Orientation	getContentBias()	Returns the orientation of a node's resizing bias for layout purposes.
final Cursor	getCursor()	Gets the value of the cursor property.
final DepthTest	getDepthTest()	Gets the value of the depthTest property.
final Effect	getEffect()	Gets the value of the effect property.
final NodeOrientation	getEffectiveNodeOrientation()	Gets the value of the effectiveNodeOrientation property.
final EventDispatcher	getEventDispatcher()	Gets the value of the eventDispatcher property.
final String	getId()	The id of this Node.
protected Cursor	getInitialCursor()	Returns the initial cursor state of this node, for use by the JavaFX CSS engine to correctly set its initial value.
final InputMethodRequests	getInputMethodRequests()	Gets the value of the inputMethodRequests property.
final Bounds	getLayoutBounds()	Gets the value of the layoutBounds property.
final double	getLayoutX()	Gets the value of the layoutX property.
final double	getLayoutY()	Gets the value of the layoutY property.
final Transform	getLocalToParentTransform()	Gets the value of the localToParentTransform property.
final Transform	getLocalToSceneTransform()	Gets the value of the localToSceneTransform property.
final NodeOrientation	getNodeOrientation()	Gets the value of the nodeOrientation property.
final EventHandler<? super ContextMenuEvent>	getOnContextMenuRequested()	Gets the value of the onContextMenuRequested property.
final EventHandler<? super MouseEvent>	getOnDragDetected()	Gets the value of the onDragDetected property.
final EventHandler<? super DragEvent>	getOnDragDone()	Gets the value of the onDragDone property.
final EventHandler<? super DragEvent>	getOnDragDropped()	Gets the value of the onDragDropped property.
final EventHandler<? super DragEvent>	getOnDragEntered()	Gets the value of the onDragEntered property.
final EventHandler<? super DragEvent>	getOnDragExited()	Gets the value of the onDragExited property.
final EventHandler<? super DragEvent>	getOnDragOver()	Gets the value of the onDragOver property.
final EventHandler<? super InputMethodEvent>	getOnInputMethodTextChanged()	Gets the value of the onInputMethodTextChanged property.
final EventHandler<? super KeyEvent>	getOnKeyPressed()	Gets the value of the onKeyPressed property.
final EventHandler<? super KeyEvent>	getOnKeyReleased()	Gets the value of the onKeyReleased property.
final EventHandler<? super KeyEvent>	getOnKeyTyped()	Gets the value of the onKeyTyped property.
final EventHandler<? super MouseEvent>	getOnMouseClicked()	Gets the value of the onMouseClicked property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragDone()	Gets the value of the onMouseDragDone property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragEntered()	Gets the value of the onMouseDragEntered property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragExited()	Gets the value of the onMouseDragExited property.
final EventHandler<? super MouseEvent>	getOnMouseDragged()	Gets the value of the onMouseDragged property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragOver()	Gets the value of the onMouseDragOver property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragReleased()	Gets the value of the onMouseDragReleased property.
final EventHandler<? super MouseEvent>	getOnMouseEntered()	Gets the value of the onMouseEntered property.
final EventHandler<? super MouseEvent>	getOnMouseExited()	Gets the value of the onMouseExited property.
final EventHandler<? super MouseEvent>	getOnMouseMoved()	Gets the value of the onMouseMoved property.
final EventHandler<? super MouseEvent>	getOnMousePressed()	Gets the value of the onMousePressed property.
final EventHandler<? super MouseEvent>	getOnMouseReleased()	Gets the value of the onMouseReleased property.
final EventHandler<? super RotateEvent>	getOnRotate()	Gets the value of the onRotate property.
final EventHandler<? super RotateEvent>	getOnRotationFinished()	Gets the value of the onRotationFinished property.
final EventHandler<? super RotateEvent>	getOnRotationStarted()	Gets the value of the onRotationStarted property.
final EventHandler<? super ScrollEvent>	getOnScroll()	Gets the value of the onScroll property.
final EventHandler<? super ScrollEvent>	getOnScrollFinished()	Gets the value of the onScrollFinished property.
final EventHandler<? super ScrollEvent>	getOnScrollStarted()	Gets the value of the onScrollStarted property.
final EventHandler<? super SwipeEvent>	getOnSwipeDown()	Gets the value of the onSwipeDown property.
final EventHandler<? super SwipeEvent>	getOnSwipeLeft()	Gets the value of the onSwipeLeft property.
final EventHandler<? super SwipeEvent>	getOnSwipeRight()	Gets the value of the onSwipeRight property.
final EventHandler<? super SwipeEvent>	getOnSwipeUp()	Gets the value of the onSwipeUp property.
final EventHandler<? super TouchEvent>	getOnTouchMoved()	Gets the value of the onTouchMoved property.
final EventHandler<? super TouchEvent>	getOnTouchPressed()	Gets the value of the onTouchPressed property.
final EventHandler<? super TouchEvent>	getOnTouchReleased()	Gets the value of the onTouchReleased property.
final EventHandler<? super TouchEvent>	getOnTouchStationary()	Gets the value of the onTouchStationary property.
final EventHandler<? super ZoomEvent>	getOnZoom()	Gets the value of the onZoom property.
final EventHandler<? super ZoomEvent>	getOnZoomFinished()	Gets the value of the onZoomFinished property.
final EventHandler<? super ZoomEvent>	getOnZoomStarted()	Gets the value of the onZoomStarted property.
final double	getOpacity()	Gets the value of the opacity property.
final Parent	getParent()	Gets the value of the parent property.
final ObservableMap<Object,Object>	getProperties()	Returns an observable map of properties on this node for use primarily by application developers.
final ObservableSet<PseudoClass>	getPseudoClassStates()	Return the pseudo-class state of this Styleable.
final double	getRotate()	Gets the value of the rotate property.
final Point3D	getRotationAxis()	Gets the value of the rotationAxis property.
final double	getScaleX()	Gets the value of the scaleX property.
final double	getScaleY()	Gets the value of the scaleY property.
final double	getScaleZ()	Gets the value of the scaleZ property.
final Scene	getScene()	Gets the value of the scene property.
final String	getStyle()	A string representation of the CSS style associated with this specific Node.
Styleable	getStyleableParent()	Return the parent of this Styleable, or null if there is no parent.
final ObservableList<String>	getStyleClass()	A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
final ObservableList<Transform>	getTransforms()	The ObservableList of custom Transforms to be applied to this Node.
final double	getTranslateX()	Gets the value of the translateX property.
final double	getTranslateY()	Gets the value of the translateY property.
final double	getTranslateZ()	Gets the value of the translateZ property.
String	getTypeSelector()	The type of this Styleable that is to be used in selector matching.
Object	getUserData()	Returns a previously set Object property, or null if no such property has been set using the Node.setUserData(java.lang.Object) method.
final double	getViewOrder()	Gets the value of the viewOrder property.
boolean	hasProperties()	Tests if Node has properties.
final ReadOnlyBooleanProperty	hoverProperty()	Whether or not this Node is being hovered over.
final StringProperty	idProperty()	The id of this Node.
final ObjectProperty<InputMethodRequests>	inputMethodRequestsProperty()	Property holding InputMethodRequests.
boolean	intersects(double localX, double localY, double localWidth, double localHeight)	Returns true if the given rectangle (specified in the local coordinate space of this Node) intersects the shape of this Node.
boolean	intersects(Bounds localBounds)	Returns true if the given bounds (specified in the local coordinate space of this Node) intersects the shape of this Node.
final boolean	isCache()	Gets the value of the cache property.
final boolean	isDisable()	Gets the value of the disable property.
final boolean	isDisabled()	Gets the value of the disabled property.
final boolean	isFocused()	Gets the value of the focused property.
final boolean	isFocusTraversable()	Gets the value of the focusTraversable property.
final boolean	isFocusVisible()	Gets the value of the focusVisible property.
final boolean	isFocusWithin()	Gets the value of the focusWithin property.
final boolean	isHover()	Gets the value of the hover property.
final boolean	isManaged()	Gets the value of the managed property.
final boolean	isMouseTransparent()	Gets the value of the mouseTransparent property.
final boolean	isPickOnBounds()	Gets the value of the pickOnBounds property.
final boolean	isPressed()	Gets the value of the pressed property.
final boolean	isVisible()	Gets the value of the visible property.
final ReadOnlyObjectProperty<Bounds>	layoutBoundsProperty()	The rectangular bounds that should be used for layout calculations for this node.
final DoubleProperty	layoutXProperty()	Defines the x coordinate of the translation that is added to this Node's transform for the purpose of layout.
final DoubleProperty	layoutYProperty()	Defines the y coordinate of the translation that is added to this Node's transform for the purpose of layout.
Point2D	localToParent(double localX, double localY)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
Point3D	localToParent(double x, double y, double z)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
Bounds	localToParent(Bounds localBounds)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its parent.
Point2D	localToParent(Point2D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
Point3D	localToParent(Point3D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
final ReadOnlyObjectProperty<Transform>	localToParentTransformProperty()	An affine transform that holds the computed local-to-parent transform.
Point2D	localToScene(double localX, double localY)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point2D	localToScene(double x, double y, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(double x, double y, double z)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(double x, double y, double z, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Bounds	localToScene(Bounds localBounds)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its scene.
Bounds	localToScene(Bounds localBounds, boolean rootScene)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its scene.
Point2D	localToScene(Point2D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point2D	localToScene(Point2D localPoint, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(Point3D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(Point3D localPoint, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
final ReadOnlyObjectProperty<Transform>	localToSceneTransformProperty()	An affine transform that holds the computed local-to-scene transform.
Point2D	localToScreen(double localX, double localY)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Point2D	localToScreen(double localX, double localY, double localZ)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Bounds	localToScreen(Bounds localBounds)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its Screen.
Point2D	localToScreen(Point2D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Point2D	localToScreen(Point3D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Node	lookup(String selector)	Finds this Node, or the first sub-node, based on the given CSS selector.
Set<Node>	lookupAll(String selector)	Finds all Nodes, including this one and any children, which match the given CSS selector.
final BooleanProperty	managedProperty()	Defines whether or not this node's layout will be managed by its parent.
final BooleanProperty	mouseTransparentProperty()	If true, this node (together with all its children) is completely transparent to mouse events.
final ObjectProperty<NodeOrientation>	nodeOrientationProperty()	Node orientation describes the flow of visual data within a node.
final void	notifyAccessibleAttributeChanged(AccessibleAttribute attributes)	This method is called by the application to notify the assistive technology that the value for an attribute has changed.
final ObjectProperty<EventHandler<? super ContextMenuEvent>>	onContextMenuRequestedProperty()	Defines a function to be called when a context menu has been requested on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onDragDetectedProperty()	Defines a function to be called when drag gesture has been detected.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDoneProperty()	Defines a function to be called when this Node is a drag and drop gesture source after its data has been dropped on a drop target.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDroppedProperty()	Defines a function to be called when the mouse button is released on this Node during drag and drop gesture.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragEnteredProperty()	Defines a function to be called when drag gesture enters this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragExitedProperty()	Defines a function to be called when drag gesture exits this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragOverProperty()	Defines a function to be called when drag gesture progresses within this Node.
final ObjectProperty<EventHandler<? super InputMethodEvent>>	onInputMethodTextChangedProperty()	Defines a function to be called when this Node has input focus and the input method text has changed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyPressedProperty()	Defines a function to be called when this Node or its child Node has input focus and a key has been pressed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyReleasedProperty()	Defines a function to be called when this Node or its child Node has input focus and a key has been released.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyTypedProperty()	Defines a function to be called when this Node or its child Node has input focus and a key has been typed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseClickedProperty()	Defines a function to be called when a mouse button has been clicked (pressed and released) on this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragDoneProperty()	Defines a function to be called when a full press-drag-release gesture ends with this node as its source.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragEnteredProperty()	Defines a function to be called when a full press-drag-release gesture enters this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragExitedProperty()	Defines a function to be called when a full press-drag-release gesture leaves this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseDraggedProperty()	Defines a function to be called when a mouse button is pressed on this Node and then dragged.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragOverProperty()	Defines a function to be called when a full press-drag-release gesture progresses within this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragReleasedProperty()	Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseEnteredProperty()	Defines a function to be called when the mouse enters this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseExitedProperty()	Defines a function to be called when the mouse exits this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseMovedProperty()	Defines a function to be called when mouse cursor moves within this Node but no buttons have been pushed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMousePressedProperty()	Defines a function to be called when a mouse button has been pressed on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseReleasedProperty()	Defines a function to be called when a mouse button has been released on this Node.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotateProperty()	Defines a function to be called when user performs a rotation action.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationFinishedProperty()	Defines a function to be called when a rotation gesture ends.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationStartedProperty()	Defines a function to be called when a rotation gesture is detected.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollFinishedProperty()	Defines a function to be called when a scrolling gesture ends.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollProperty()	Defines a function to be called when user performs a scrolling action.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollStartedProperty()	Defines a function to be called when a scrolling gesture is detected.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeDownProperty()	Defines a function to be called when a downward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeLeftProperty()	Defines a function to be called when a leftward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeRightProperty()	Defines a function to be called when an rightward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeUpProperty()	Defines a function to be called when an upward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchMovedProperty()	Defines a function to be called when a touch point is moved.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchPressedProperty()	Defines a function to be called when a new touch point is pressed.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchReleasedProperty()	Defines a function to be called when a touch point is released.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchStationaryProperty()	Defines a function to be called when a touch point stays pressed and still.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomFinishedProperty()	Defines a function to be called when a zooming gesture ends.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomProperty()	Defines a function to be called when user performs a zooming action.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomStartedProperty()	Defines a function to be called when a zooming gesture is detected.
final DoubleProperty	opacityProperty()	Specifies how opaque (that is, solid) the Node appears.
final ReadOnlyObjectProperty<Parent>	parentProperty()	The parent of this Node.
Point2D	parentToLocal(double parentX, double parentY)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
Point3D	parentToLocal(double parentX, double parentY, double parentZ)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
Bounds	parentToLocal(Bounds parentBounds)	Transforms a rectangle from the coordinate space of the parent into the local coordinate space of this Node.
Point2D	parentToLocal(Point2D parentPoint)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
Point3D	parentToLocal(Point3D parentPoint)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
final BooleanProperty	pickOnBoundsProperty()	Defines how the picking computation is done for this node when triggered by a MouseEvent or a contains function call.
final ReadOnlyBooleanProperty	pressedProperty()	Whether or not the Node is pressed.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this Node has changed.
Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.
void	relocate(double x, double y)	Sets the node's layoutX and layoutY translation properties in order to relocate this node to the x,y location in the parent.
final <T extends Event> void	removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Unregisters a previously registered event filter from this target.
final <T extends Event> void	removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Unregisters a previously registered event handler from this target.
void	requestFocus()	Requests that this Node get the input focus, and that this Node's top-level ancestor become the focused window.
final boolean	requestFocusTraversal(TraversalDirection direction)	Requests to move the focus from this Node in the specified direction.
void	resizeRelocate(double x, double y, double width, double height)	If the node is resizable, will set its layout bounds to the specified width and height.
final DoubleProperty	rotateProperty()	Defines the angle of rotation about the Node's center, measured in degrees.
final ObjectProperty<Point3D>	rotationAxisProperty()	Defines the axis of rotation of this Node.
final DoubleProperty	scaleXProperty()	Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node.
final DoubleProperty	scaleYProperty()	Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node.
final DoubleProperty	scaleZProperty()	Defines the factor by which coordinates are scaled about the center of the object along the Z axis of this Node.
final ReadOnlyObjectProperty<Scene>	sceneProperty()	The Scene that this Node is part of.
Point2D	sceneToLocal(double sceneX, double sceneY)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	sceneToLocal(double x, double y, boolean rootScene)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point3D	sceneToLocal(double sceneX, double sceneY, double sceneZ)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Bounds	sceneToLocal(Bounds sceneBounds)	Transforms a rectangle from the coordinate space of the scene into the local coordinate space of this Node.
Bounds	sceneToLocal(Bounds bounds, boolean rootScene)	Transforms a bounds from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	sceneToLocal(Point2D scenePoint)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	sceneToLocal(Point2D point, boolean rootScene)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point3D	sceneToLocal(Point3D scenePoint)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	screenToLocal(double screenX, double screenY)	Transforms a point from the coordinate space of the Screen into the local coordinate space of this Node.
Bounds	screenToLocal(Bounds screenBounds)	Transforms a rectangle from the coordinate space of the Screen into the local coordinate space of this Node.
Point2D	screenToLocal(Point2D screenPoint)	Transforms a point from the coordinate space of the Screen into the local coordinate space of this Node.
final void	setAccessibleHelp(String value)	Sets the value of the accessibleHelp property.
final void	setAccessibleRole(AccessibleRole value)	Sets the value of the accessibleRole property.
final void	setAccessibleRoleDescription(String value)	Sets the value of the accessibleRoleDescription property.
final void	setAccessibleText(String value)	Sets the value of the accessibleText property.
final void	setBlendMode(BlendMode value)	Sets the value of the blendMode property.
final void	setCache(boolean value)	Sets the value of the cache property.
final void	setCacheHint(CacheHint value)	Sets the value of the cacheHint property.
final void	setClip(Node value)	Sets the value of the clip property.
final void	setCursor(Cursor value)	Sets the value of the cursor property.
final void	setDepthTest(DepthTest value)	Sets the value of the depthTest property.
final void	setDisable(boolean value)	Sets the value of the disable property.
protected final void	setDisabled(boolean value)	Sets the value of the disabled property.
final void	setEffect(Effect value)	Sets the value of the effect property.
final void	setEventDispatcher(EventDispatcher value)	Sets the value of the eventDispatcher property.
protected final <T extends Event> void	setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Sets the handler to use for this event type.
protected final void	setFocused(boolean value)	Sets the value of the focused property.
final void	setFocusTraversable(boolean value)	Sets the value of the focusTraversable property.
protected final void	setHover(boolean value)	Sets the value of the hover property.
final void	setId(String value)	Sets the value of the id property.
final void	setInputMethodRequests(InputMethodRequests value)	Sets the value of the inputMethodRequests property.
final void	setLayoutX(double value)	Sets the value of the layoutX property.
final void	setLayoutY(double value)	Sets the value of the layoutY property.
final void	setManaged(boolean value)	Sets the value of the managed property.
final void	setMouseTransparent(boolean value)	Sets the value of the mouseTransparent property.
final void	setNodeOrientation(NodeOrientation orientation)	Sets the value of the nodeOrientation property.
final void	setOnContextMenuRequested(EventHandler<? super ContextMenuEvent> value)	Sets the value of the onContextMenuRequested property.
final void	setOnDragDetected(EventHandler<? super MouseEvent> value)	Sets the value of the onDragDetected property.
final void	setOnDragDone(EventHandler<? super DragEvent> value)	Sets the value of the onDragDone property.
final void	setOnDragDropped(EventHandler<? super DragEvent> value)	Sets the value of the onDragDropped property.
final void	setOnDragEntered(EventHandler<? super DragEvent> value)	Sets the value of the onDragEntered property.
final void	setOnDragExited(EventHandler<? super DragEvent> value)	Sets the value of the onDragExited property.
final void	setOnDragOver(EventHandler<? super DragEvent> value)	Sets the value of the onDragOver property.
final void	setOnInputMethodTextChanged(EventHandler<? super InputMethodEvent> value)	Sets the value of the onInputMethodTextChanged property.
final void	setOnKeyPressed(EventHandler<? super KeyEvent> value)	Sets the value of the onKeyPressed property.
final void	setOnKeyReleased(EventHandler<? super KeyEvent> value)	Sets the value of the onKeyReleased property.
final void	setOnKeyTyped(EventHandler<? super KeyEvent> value)	Sets the value of the onKeyTyped property.
final void	setOnMouseClicked(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseClicked property.
final void	setOnMouseDragDone(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragDone property.
final void	setOnMouseDragEntered(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragEntered property.
final void	setOnMouseDragExited(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragExited property.
final void	setOnMouseDragged(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseDragged property.
final void	setOnMouseDragOver(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragOver property.
final void	setOnMouseDragReleased(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragReleased property.
final void	setOnMouseEntered(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseEntered property.
final void	setOnMouseExited(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseExited property.
final void	setOnMouseMoved(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseMoved property.
final void	setOnMousePressed(EventHandler<? super MouseEvent> value)	Sets the value of the onMousePressed property.
final void	setOnMouseReleased(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseReleased property.
final void	setOnRotate(EventHandler<? super RotateEvent> value)	Sets the value of the onRotate property.
final void	setOnRotationFinished(EventHandler<? super RotateEvent> value)	Sets the value of the onRotationFinished property.
final void	setOnRotationStarted(EventHandler<? super RotateEvent> value)	Sets the value of the onRotationStarted property.
final void	setOnScroll(EventHandler<? super ScrollEvent> value)	Sets the value of the onScroll property.
final void	setOnScrollFinished(EventHandler<? super ScrollEvent> value)	Sets the value of the onScrollFinished property.
final void	setOnScrollStarted(EventHandler<? super ScrollEvent> value)	Sets the value of the onScrollStarted property.
final void	setOnSwipeDown(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeDown property.
final void	setOnSwipeLeft(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeLeft property.
final void	setOnSwipeRight(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeRight property.
final void	setOnSwipeUp(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeUp property.
final void	setOnTouchMoved(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchMoved property.
final void	setOnTouchPressed(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchPressed property.
final void	setOnTouchReleased(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchReleased property.
final void	setOnTouchStationary(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchStationary property.
final void	setOnZoom(EventHandler<? super ZoomEvent> value)	Sets the value of the onZoom property.
final void	setOnZoomFinished(EventHandler<? super ZoomEvent> value)	Sets the value of the onZoomFinished property.
final void	setOnZoomStarted(EventHandler<? super ZoomEvent> value)	Sets the value of the onZoomStarted property.
final void	setOpacity(double value)	Sets the value of the opacity property.
final void	setPickOnBounds(boolean value)	Sets the value of the pickOnBounds property.
protected final void	setPressed(boolean value)	Sets the value of the pressed property.
final void	setRotate(double value)	Sets the value of the rotate property.
final void	setRotationAxis(Point3D value)	Sets the value of the rotationAxis property.
final void	setScaleX(double value)	Sets the value of the scaleX property.
final void	setScaleY(double value)	Sets the value of the scaleY property.
final void	setScaleZ(double value)	Sets the value of the scaleZ property.
final void	setStyle(String value)	A string representation of the CSS style associated with this specific Node.
final void	setTranslateX(double value)	Sets the value of the translateX property.
final void	setTranslateY(double value)	Sets the value of the translateY property.
final void	setTranslateZ(double value)	Sets the value of the translateZ property.
void	setUserData(Object value)	Convenience method for setting a single Object property that can be retrieved at a later date.
final void	setViewOrder(double value)	Sets the value of the viewOrder property.
final void	setVisible(boolean value)	Sets the value of the visible property.
WritableImage	snapshot(SnapshotParameters params, WritableImage image)	Takes a snapshot of this node and returns the rendered image when it is ready.
void	snapshot(Callback<SnapshotResult, Void> callback, SnapshotParameters params, WritableImage image)	Takes a snapshot of this node at the next frame and calls the specified callback method when the image is ready.
Dragboard	startDragAndDrop(TransferMode... transferModes)	Confirms a potential drag and drop gesture that is recognized over this Node.
void	startFullDrag()	Starts a full press-drag-release gesture with this node as gesture source.
final StringProperty	styleProperty()	A string representation of the CSS style associated with this specific Node.
void	toBack()	Moves this Node to the back of its sibling nodes in terms of z-order.
void	toFront()	Moves this Node to the front of its sibling nodes in terms of z-order.
String	toString()	Returns a string representation for the object.
final DoubleProperty	translateXProperty()	Defines the x coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateYProperty()	Defines the y coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateZProperty()	Defines the Z coordinate of the translation that is added to the transformed coordinates of this Node.
boolean	usesMirroring()	Determines whether a node should be mirrored when node orientation is right-to-left.
final DoubleProperty	viewOrderProperty()	Defines the rendering and picking order of this Node within its parent.
final BooleanProperty	visibleProperty()	Specifies whether this Node and any subnodes should be rendered as part of the scene graph.

Methods declared in class Object

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

Methods declared in interface Styleable

getStyleableNode

Modifier and Type	Method	Description
default Node	getStyleableNode()	Returns the Node that represents this Styleable object.

Property Details

anchorPosition

public final ReadOnlyProperty<TextPos> anchorPositionProperty

Tracks the selection anchor position within the document. This read-only property is derived from selection property. The value can be null.

Setting a SelectionSegment causes an update to both the anchor and the caret positions. A null selection segment results in both positions to become null, a non-null selection segment sets both to non-null values.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

See Also:

• getAnchorPosition()
• anchorPositionProperty()

caretBlinkPeriod

public final ObjectProperty<Duration> caretBlinkPeriodProperty

Determines the caret blink period. This property cannot be set to null.

This property can be styled with CSS using -fx-caret-blink-period name.

Default value:

1000 ms

See Also:

• getCaretBlinkPeriod()
• setCaretBlinkPeriod(Duration)
• caretBlinkPeriodProperty()

caretPosition

public final ReadOnlyProperty<TextPos> caretPositionProperty

Tracks the caret position within the document. This read-only property is derived from selection property. The value can be null.

Setting a SelectionSegment causes an update to both the anchor and the caret positions. A null selection segment results in both positions to become null, a non-null selection segment sets both to non-null values.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

See Also:

• getCaretPosition()
• caretPositionProperty()

contentPadding

public final ObjectProperty<Insets> contentPaddingProperty

Specifies the padding for the RichTextArea content. The content padding value can be null, which is treated as no padding.

This property can be styled with CSS using -fx-content-padding name.

Default value:

null

See Also:

• getContentPadding()
• setContentPadding(Insets)
• contentPaddingProperty()

displayCaret

public final BooleanProperty displayCaretProperty

This property controls whether caret will be displayed or not.

This property can be styled with CSS using -fx-display-caret name.

Default value:

true

See Also:

• isDisplayCaret()
• setDisplayCaret(boolean)
• displayCaretProperty()

dropTarget

public final ReadOnlyProperty<TextPos> dropTargetProperty

This property indicates the target text position during drag-and-drop operations.

Default value:

null

Since:

27

See Also:

• getDropTarget()
• dropTargetProperty()

editable

public final BooleanProperty editableProperty

Indicates whether this RichTextArea can be edited by the user, provided the model is also writable. Changing the value of this property with a view-only model or a null model has no effect.

Default value:

true

See Also:

• isEditable()
• setEditable(boolean)
• editableProperty()

highlightCurrentParagraph

public final BooleanProperty highlightCurrentParagraphProperty

Indicates whether the current paragraph will be visually highlighted.

This property can be styled with CSS using -fx-highlight-current-paragraph name.

Default value:

false

See Also:

• isHighlightCurrentParagraph()
• setHighlightCurrentParagraph(boolean)
• highlightCurrentParagraphProperty()

insertStyles

public final ObjectProperty<StyleAttributeMap> insertStylesProperty

Specifies the styles to be in effect for the characters to be inserted via user input. The value can be null, in which case the styles are determined by the model.

Default value:

null

Since:

26

See Also:

• getInsertStyles()
• setInsertStyles(StyleAttributeMap)
• insertStylesProperty()

leftDecorator

public final ObjectProperty<SideDecorator> leftDecoratorProperty

Specifies the left-side paragraph decorator. The value can be null.

Default value:

null

See Also:

• getLeftDecorator()
• setLeftDecorator(SideDecorator)
• leftDecoratorProperty()

model

public final ObjectProperty<StyledTextModel> modelProperty

Determines the StyledTextModel to use with this RichTextArea. The model can be null, which results in an empty, uneditable control.

Note: Subclasses may impose additional restrictions on the type of the model they require.

Default value:

an instance of RichTextModel

See Also:

• getModel()
• setModel(StyledTextModel)
• modelProperty()

redoable

public final ReadOnlyBooleanProperty redoableProperty

The property describes if it's currently possible to redo the latest change of the content that was undone.

Default value:

false

See Also:

• isRedoable()
• redoableProperty()

rightDecorator

public final ObjectProperty<SideDecorator> rightDecoratorProperty

Specifies the right-side paragraph decorator. The value can be null.

Default value:

null

See Also:

• getRightDecorator()
• setRightDecorator(SideDecorator)
• rightDecoratorProperty()

selection

public final ReadOnlyProperty<SelectionSegment> selectionProperty

Tracks the current selection. The SelectionSegment consists of two values - the caret and the anchor positions which may get changed independently. This property allows for tracking the selection as an single entity. A null value for the selection segment causes both the caret and the anchor positions to become null.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

See Also:

• getSelection()
• selectionProperty()

undoable

public final ReadOnlyBooleanProperty undoableProperty

The property describes if it's currently possible to undo the latest change of the content that was done.

Default value:

false

See Also:

• isUndoable()
• undoableProperty()

useContentHeight

public final BooleanProperty useContentHeightProperty

Determines whether the preferred height is the same as the content height. When set to true, the vertical scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-height name.

Default value:

false

See Also:

• isUseContentHeight()
• setUseContentHeight(boolean)
• useContentHeightProperty()

useContentWidth

public final BooleanProperty useContentWidthProperty

Determines whether the preferred width is the same as the content width. When set to true, the horizontal scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-width name.

Default value:

false

See Also:

• isUseContentWidth()
• setUseContentWidth(boolean)
• useContentWidthProperty()

wrapText

public final BooleanProperty wrapTextProperty

Indicates whether text should be wrapped in this RichTextArea. If a run of text exceeds the width of the RichTextArea, then this variable indicates whether the text should wrap onto another line. Setting this property to true hides the horizontal scroll bar.

This property can be styled with CSS using -fx-wrap-text name.

Default value:

false

See Also:

• isWrapText()
• setWrapText(boolean)
• wrapTextProperty()

documentArea

public final ReadOnlyObjectProperty<Bounds> documentAreaProperty

Provides the bounds to the document area in local coordinates. The bounds are determined by the skin, and may be null.

Default value:

null

Since:

27

See Also:

• getDocumentArea()
• documentAreaProperty()

Field Details

styleHandlerRegistry

protected static final StyleHandlerRegistry styleHandlerRegistry

The style handler registry instance, made available for use by subclasses to add support for new style attributes.

Constructor Details

RichTextArea

public RichTextArea()

Creates the instance with the in-memory model RichTextModel.

RichTextArea

public RichTextArea(StyledTextModel model)

Creates the instance using the specified model.

Multiple RichTextArea instances can work off a single model.

Parameters:

model - the model

Method Details

anchorPositionProperty

public final ReadOnlyProperty<TextPos> anchorPositionProperty()

Tracks the selection anchor position within the document. This read-only property is derived from selection property. The value can be null.

Setting a SelectionSegment causes an update to both the anchor and the caret positions. A null selection segment results in both positions to become null, a non-null selection segment sets both to non-null values.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

Returns:

the anchor position property

See Also:

• getAnchorPosition()

getAnchorPosition

public final TextPos getAnchorPosition()

Gets the value of the anchorPosition property.

Property description:

Tracks the selection anchor position within the document. This read-only property is derived from selection property. The value can be null.

Setting a SelectionSegment causes an update to both the anchor and the caret positions. A null selection segment results in both positions to become null, a non-null selection segment sets both to non-null values.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

Returns:

the value of the anchorPosition property

See Also:

• anchorPositionProperty()

caretBlinkPeriodProperty

public final ObjectProperty<Duration> caretBlinkPeriodProperty()

Determines the caret blink period. This property cannot be set to null.

This property can be styled with CSS using -fx-caret-blink-period name.

Default value:

1000 ms

Returns:

the caret blink period property

See Also:

• getCaretBlinkPeriod()
• setCaretBlinkPeriod(Duration)

setCaretBlinkPeriod

public final void setCaretBlinkPeriod(Duration period)

Sets the value of the caretBlinkPeriod property.

Property description:

Determines the caret blink period. This property cannot be set to null.

This property can be styled with CSS using -fx-caret-blink-period name.

Default value:

1000 ms

Parameters:

period - the value for the caretBlinkPeriod property

See Also:

• getCaretBlinkPeriod()
• caretBlinkPeriodProperty()

getCaretBlinkPeriod

public final Duration getCaretBlinkPeriod()

Gets the value of the caretBlinkPeriod property.

Property description:

Determines the caret blink period. This property cannot be set to null.

This property can be styled with CSS using -fx-caret-blink-period name.

Default value:

1000 ms

Returns:

the value of the caretBlinkPeriod property

See Also:

• setCaretBlinkPeriod(Duration)
• caretBlinkPeriodProperty()

caretPositionProperty

public final ReadOnlyProperty<TextPos> caretPositionProperty()

Tracks the caret position within the document. This read-only property is derived from selection property. The value can be null.

Setting a SelectionSegment causes an update to both the anchor and the caret positions. A null selection segment results in both positions to become null, a non-null selection segment sets both to non-null values.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

Returns:

the caret position property

See Also:

• getCaretPosition()

getCaretPosition

public final TextPos getCaretPosition()

Gets the value of the caretPosition property.

Property description:

Tracks the caret position within the document. This read-only property is derived from selection property. The value can be null.

Setting a SelectionSegment causes an update to both the anchor and the caret positions. A null selection segment results in both positions to become null, a non-null selection segment sets both to non-null values.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

Returns:

the value of the caretPosition property

See Also:

• caretPositionProperty()

contentPaddingProperty

public final ObjectProperty<Insets> contentPaddingProperty()

Specifies the padding for the RichTextArea content. The content padding value can be null, which is treated as no padding.

This property can be styled with CSS using -fx-content-padding name.

Default value:

null

Returns:

the content padding property

See Also:

• getContentPadding()
• setContentPadding(Insets)

setContentPadding

public final void setContentPadding(Insets value)

Sets the value of the contentPadding property.

Property description:

Specifies the padding for the RichTextArea content. The content padding value can be null, which is treated as no padding.

This property can be styled with CSS using -fx-content-padding name.

Default value:

null

Parameters:

value - the value for the contentPadding property

See Also:

• getContentPadding()
• contentPaddingProperty()

getContentPadding

public final Insets getContentPadding()

Gets the value of the contentPadding property.

Property description:

Specifies the padding for the RichTextArea content. The content padding value can be null, which is treated as no padding.

This property can be styled with CSS using -fx-content-padding name.

Default value:

null

Returns:

the value of the contentPadding property

See Also:

• setContentPadding(Insets)
• contentPaddingProperty()

displayCaretProperty

public final BooleanProperty displayCaretProperty()

This property controls whether caret will be displayed or not.

This property can be styled with CSS using -fx-display-caret name.

Default value:

true

Returns:

the display caret property

See Also:

• isDisplayCaret()
• setDisplayCaret(boolean)

setDisplayCaret

public final void setDisplayCaret(boolean on)

Sets the value of the displayCaret property.

Property description:

This property controls whether caret will be displayed or not.

This property can be styled with CSS using -fx-display-caret name.

Default value:

true

Parameters:

on - the value for the displayCaret property

See Also:

• isDisplayCaret()
• displayCaretProperty()

isDisplayCaret

public final boolean isDisplayCaret()

Gets the value of the displayCaret property.

Property description:

This property controls whether caret will be displayed or not.

This property can be styled with CSS using -fx-display-caret name.

Default value:

true

Returns:

the value of the displayCaret property

See Also:

• setDisplayCaret(boolean)
• displayCaretProperty()

dropTargetProperty

public final ReadOnlyProperty<TextPos> dropTargetProperty()

This property indicates the target text position during drag-and-drop operations.

Default value:

null

Returns:

the drop target property

Since:

27

See Also:

• getDropTarget()

getDropTarget

public final TextPos getDropTarget()

Gets the value of the dropTarget property.

Property description:

This property indicates the target text position during drag-and-drop operations.

Default value:

null

Returns:

the value of the dropTarget property

Since:

27

See Also:

• dropTargetProperty()

setDropTarget

public final void setDropTarget(double screenX,
 double screenY)

Attempts to set the drop target position at the specified screen coordinates. If the drop target is visible, the value of the dropTarget property will be updated to reflect the insertion point in the model, otherwise it will be set to null.

Parameters:

screenX - the screen x coordinate

screenY - the screen y coordinate

Since:

27

clearDropTarget

public final void clearDropTarget()

Sets the value of the dropTarget property to null.

Since:

27

editableProperty

public final BooleanProperty editableProperty()

Indicates whether this RichTextArea can be edited by the user, provided the model is also writable. Changing the value of this property with a view-only model or a null model has no effect.

Default value:

true

Returns:

the editable property

See Also:

• isEditable()
• setEditable(boolean)

isEditable

public final boolean isEditable()

Gets the value of the editable property.

Property description:

Indicates whether this RichTextArea can be edited by the user, provided the model is also writable. Changing the value of this property with a view-only model or a null model has no effect.

Default value:

true

Returns:

the value of the editable property

See Also:

• setEditable(boolean)
• editableProperty()

setEditable

public final void setEditable(boolean on)

Sets the value of the editable property.

Property description:

Indicates whether this RichTextArea can be edited by the user, provided the model is also writable. Changing the value of this property with a view-only model or a null model has no effect.

Default value:

true

Parameters:

on - the value for the editable property

See Also:

• isEditable()
• editableProperty()

highlightCurrentParagraphProperty

public final BooleanProperty highlightCurrentParagraphProperty()

Indicates whether the current paragraph will be visually highlighted.

This property can be styled with CSS using -fx-highlight-current-paragraph name.

Default value:

false

Returns:

the highlight current paragraph property

See Also:

• isHighlightCurrentParagraph()
• setHighlightCurrentParagraph(boolean)

isHighlightCurrentParagraph

public final boolean isHighlightCurrentParagraph()

Gets the value of the highlightCurrentParagraph property.

Property description:

Indicates whether the current paragraph will be visually highlighted.

This property can be styled with CSS using -fx-highlight-current-paragraph name.

Default value:

false

Returns:

the value of the highlightCurrentParagraph property

See Also:

• setHighlightCurrentParagraph(boolean)
• highlightCurrentParagraphProperty()

setHighlightCurrentParagraph

public final void setHighlightCurrentParagraph(boolean on)

Sets the value of the highlightCurrentParagraph property.

Property description:

Indicates whether the current paragraph will be visually highlighted.

This property can be styled with CSS using -fx-highlight-current-paragraph name.

Default value:

false

Parameters:

on - the value for the highlightCurrentParagraph property

See Also:

• isHighlightCurrentParagraph()
• highlightCurrentParagraphProperty()

insertStylesProperty

public final ObjectProperty<StyleAttributeMap> insertStylesProperty()

Specifies the styles to be in effect for the characters to be inserted via user input. The value can be null, in which case the styles are determined by the model.

Default value:

null

Returns:

the insert styles property

Since:

26

See Also:

• getInsertStyles()
• setInsertStyles(StyleAttributeMap)

getInsertStyles

public final StyleAttributeMap getInsertStyles()

Gets the value of the insertStyles property.

Property description:

Specifies the styles to be in effect for the characters to be inserted via user input. The value can be null, in which case the styles are determined by the model.

Default value:

null

Returns:

the value of the insertStyles property

Since:

26

See Also:

• setInsertStyles(StyleAttributeMap)
• insertStylesProperty()

setInsertStyles

public final void setInsertStyles(StyleAttributeMap v)

Sets the value of the insertStyles property.

Property description:

Specifies the styles to be in effect for the characters to be inserted via user input. The value can be null, in which case the styles are determined by the model.

Default value:

null

Parameters:

v - the value for the insertStyles property

Since:

26

See Also:

• getInsertStyles()
• insertStylesProperty()

leftDecoratorProperty

public final ObjectProperty<SideDecorator> leftDecoratorProperty()

Specifies the left-side paragraph decorator. The value can be null.

Default value:

null

Returns:

the left decorator property

See Also:

• getLeftDecorator()
• setLeftDecorator(SideDecorator)

getLeftDecorator

public final SideDecorator getLeftDecorator()

Gets the value of the leftDecorator property.

Property description:

Specifies the left-side paragraph decorator. The value can be null.

Default value:

null

Returns:

the value of the leftDecorator property

See Also:

• setLeftDecorator(SideDecorator)
• leftDecoratorProperty()

setLeftDecorator

public final void setLeftDecorator(SideDecorator d)

Sets the value of the leftDecorator property.

Property description:

Specifies the left-side paragraph decorator. The value can be null.

Default value:

null

Parameters:

d - the value for the leftDecorator property

See Also:

• getLeftDecorator()
• leftDecoratorProperty()

getLineEnding

public final LineEnding getLineEnding()

Convenience method which delegates to StyledTextModel.getLineEnding(). Returns LineEnding.system() value if the model is null.

Returns:

the model's line ending value

Since:

26

setLineEnding

public final void setLineEnding(LineEnding value)

Sets the model's line ending characters. Delegates to StyledTextModel.setLineEnding(LineEnding). This method does nothing if the model is null.

Parameters:

value - the line ending value, cannot be null

Throws:

NullPointerException - if the value is null

Since:

26

modelProperty

public final ObjectProperty<StyledTextModel> modelProperty()

Determines the StyledTextModel to use with this RichTextArea. The model can be null, which results in an empty, uneditable control.

Note: Subclasses may impose additional restrictions on the type of the model they require.

Default value:

an instance of RichTextModel

Returns:

the model property

See Also:

• getModel()
• setModel(StyledTextModel)

setModel

public final void setModel(StyledTextModel m)

Sets the value of the model property.

Property description:

Determines the StyledTextModel to use with this RichTextArea. The model can be null, which results in an empty, uneditable control.

Note: Subclasses may impose additional restrictions on the type of the model they require.

Default value:

an instance of RichTextModel

Parameters:

m - the value for the model property

See Also:

• getModel()
• modelProperty()

getModel

public final StyledTextModel getModel()

Gets the value of the model property.

Property description:

Determines the StyledTextModel to use with this RichTextArea. The model can be null, which results in an empty, uneditable control.

Note: Subclasses may impose additional restrictions on the type of the model they require.

Default value:

an instance of RichTextModel

Returns:

the value of the model property

See Also:

• setModel(StyledTextModel)
• modelProperty()

validateModel

protected void validateModel(StyledTextModel m)

Validates the model property value. The subclass should override this method if it restricts the type of model that is supported, and throw an IllegalArgumentException if the model is not supported. A null value should always be acceptable and never generate an exception.

Parameters:

m - the model (can be null)

redoableProperty

public final ReadOnlyBooleanProperty redoableProperty()

The property describes if it's currently possible to redo the latest change of the content that was undone.

Default value:

false

Returns:

the read-only property

See Also:

• isRedoable()

isRedoable

public final boolean isRedoable()

Gets the value of the redoable property.

Property description:

The property describes if it's currently possible to redo the latest change of the content that was undone.

Default value:

false

Returns:

the value of the redoable property

See Also:

• redoableProperty()

rightDecoratorProperty

public final ObjectProperty<SideDecorator> rightDecoratorProperty()

Specifies the right-side paragraph decorator. The value can be null.

Default value:

null

Returns:

the right decorator property

See Also:

• getRightDecorator()
• setRightDecorator(SideDecorator)

getRightDecorator

public final SideDecorator getRightDecorator()

Gets the value of the rightDecorator property.

Property description:

Specifies the right-side paragraph decorator. The value can be null.

Default value:

null

Returns:

the value of the rightDecorator property

See Also:

• setRightDecorator(SideDecorator)
• rightDecoratorProperty()

setRightDecorator

public final void setRightDecorator(SideDecorator d)

Sets the value of the rightDecorator property.

Property description:

Specifies the right-side paragraph decorator. The value can be null.

Default value:

null

Parameters:

d - the value for the rightDecorator property

See Also:

• getRightDecorator()
• rightDecoratorProperty()

selectionProperty

public final ReadOnlyProperty<SelectionSegment> selectionProperty()

Tracks the current selection. The SelectionSegment consists of two values - the caret and the anchor positions which may get changed independently. This property allows for tracking the selection as an single entity. A null value for the selection segment causes both the caret and the anchor positions to become null.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

Returns:

the selection property

See Also:

• getSelection()

getSelection

public final SelectionSegment getSelection()

Gets the value of the selection property.

Property description:

Tracks the current selection. The SelectionSegment consists of two values - the caret and the anchor positions which may get changed independently. This property allows for tracking the selection as an single entity. A null value for the selection segment causes both the caret and the anchor positions to become null.

Note: selectionProperty(), anchorPositionProperty(), and caretPositionProperty() are logically connected. When a change occurs, the anchor position is updated first, followed by the caret position, followed by the selection segment.

Default value:

null

Returns:

the value of the selection property

See Also:

• selectionProperty()

undoableProperty

public final ReadOnlyBooleanProperty undoableProperty()

The property describes if it's currently possible to undo the latest change of the content that was done.

Default value:

false

Returns:

the read-only property

See Also:

• isUndoable()

isUndoable

public final boolean isUndoable()

Gets the value of the undoable property.

Property description:

The property describes if it's currently possible to undo the latest change of the content that was done.

Default value:

false

Returns:

the value of the undoable property

See Also:

• undoableProperty()

isUndoRedoEnabled

public final boolean isUndoRedoEnabled()

Indicates whether undo/redo functionality is enabled in the model. Returns false if the model is null.

Returns:

true if undo/redo functionality is enabled in the model

Since:

26

setUndoRedoEnabled

public final void setUndoRedoEnabled(boolean on)

Controls whether undo/redo functionality is enabled in the model. Setting the value to false clears existing undo/redo entries. This method does nothing if the model is null.

Parameters:

on - true to enable undo/redo

Since:

26

See Also:

• clearUndoRedo()

useContentHeightProperty

public final BooleanProperty useContentHeightProperty()

Determines whether the preferred height is the same as the content height. When set to true, the vertical scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-height name.

Default value:

false

Returns:

the use content height property

See Also:

• isUseContentHeight()
• setUseContentHeight(boolean)

isUseContentHeight

public final boolean isUseContentHeight()

Gets the value of the useContentHeight property.

Property description:

Determines whether the preferred height is the same as the content height. When set to true, the vertical scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-height name.

Default value:

false

Returns:

the value of the useContentHeight property

See Also:

• setUseContentHeight(boolean)
• useContentHeightProperty()

setUseContentHeight

public final void setUseContentHeight(boolean on)

Sets the value of the useContentHeight property.

Property description:

Determines whether the preferred height is the same as the content height. When set to true, the vertical scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-height name.

Default value:

false

Parameters:

on - the value for the useContentHeight property

See Also:

• isUseContentHeight()
• useContentHeightProperty()

useContentWidthProperty

public final BooleanProperty useContentWidthProperty()

Determines whether the preferred width is the same as the content width. When set to true, the horizontal scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-width name.

Default value:

false

Returns:

the use content width property

See Also:

• isUseContentWidth()
• setUseContentWidth(boolean)

isUseContentWidth

public final boolean isUseContentWidth()

Gets the value of the useContentWidth property.

Property description:

Determines whether the preferred width is the same as the content width. When set to true, the horizontal scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-width name.

Default value:

false

Returns:

the value of the useContentWidth property

See Also:

• setUseContentWidth(boolean)
• useContentWidthProperty()

setUseContentWidth

public final void setUseContentWidth(boolean on)

Sets the value of the useContentWidth property.

Property description:

Determines whether the preferred width is the same as the content width. When set to true, the horizontal scroll bar is disabled.

This property can be styled with CSS using -fx-use-content-width name.

Default value:

false

Parameters:

on - the value for the useContentWidth property

See Also:

• isUseContentWidth()
• useContentWidthProperty()

wrapTextProperty

public final BooleanProperty wrapTextProperty()

Indicates whether text should be wrapped in this RichTextArea. If a run of text exceeds the width of the RichTextArea, then this variable indicates whether the text should wrap onto another line. Setting this property to true hides the horizontal scroll bar.

This property can be styled with CSS using -fx-wrap-text name.

Default value:

false

Returns:

the wrap text property

See Also:

• isWrapText()
• setWrapText(boolean)

isWrapText

public final boolean isWrapText()

Gets the value of the wrapText property.

Property description:

Indicates whether text should be wrapped in this RichTextArea. If a run of text exceeds the width of the RichTextArea, then this variable indicates whether the text should wrap onto another line. Setting this property to true hides the horizontal scroll bar.

This property can be styled with CSS using -fx-wrap-text name.

Default value:

false

Returns:

the value of the wrapText property

See Also:

• setWrapText(boolean)
• wrapTextProperty()

setWrapText

public final void setWrapText(boolean value)

Sets the value of the wrapText property.

Property description:

Indicates whether text should be wrapped in this RichTextArea. If a run of text exceeds the width of the RichTextArea, then this variable indicates whether the text should wrap onto another line. Setting this property to true hides the horizontal scroll bar.

This property can be styled with CSS using -fx-wrap-text name.

Default value:

false

Parameters:

value - the value for the wrapText property

See Also:

• isWrapText()
• wrapTextProperty()

getClassCssMetaData

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:

the CssMetaData

getControlCssMetaData

public List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Description copied from class: Control

Gets the unmodifiable list of the control's CSS-styleable properties.

Overrides:

getControlCssMetaData in class Control

Returns:

the unmodifiable list of the control's CSS-styleable properties

appendText

public final TextPos appendText(String text,
 StyleAttributeMap attrs)

Appends the styled text to the end of the document. Any embedded "\n" or "\r\n" sequences result in a new paragraph being added.

It is up to the model to decide whether to accept all, some, or none of the StyleAttributes.

Parameters:

text - the text to append

attrs - the style attributes

Returns:

the text position at the end of the appended text, or null if editing is disabled

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

appendText

public final TextPos appendText(String text)

Appends the styled text to the end of the document. Any embedded "\n" or "\r\n" sequences result in a new paragraph being added.

This convenience method is equivalent to calling appendText(text, StyleAttributeMap.EMPTY);

Parameters:

text - the text to append

Returns:

the text position at the end of the appended text, or null if editing is disabled

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

appendText

public final TextPos appendText(StyledInput in)

Appends the styled content to the end of the document. Any embedded "\n" or "\r\n" sequences result in a new paragraph being added.

Parameters:

in - the input stream

Returns:

the text position at the end of the appended text, or null if editing is disabled

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

applyStyle

public void applyStyle(TextPos start,
 TextPos end,
 StyleAttributeMap attrs)

Applies the specified style to the selected range. The specified attributes will be merged, overriding the existing ones. When applying paragraph attributes, the affected range might extend beyond start and end to include whole paragraphs.

Parameters:

start - the start of text range

end - the end of text range

attrs - the style attributes to apply

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

backspace

public void backspace()

When selection exists, deletes selected text. Otherwise, deletes the character preceding the caret, possibly breaking up the grapheme clusters.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.BACKSPACE

clear

public final void clear()

Clears the document.

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

clearSelection

public final void clearSelection()

Clears existing selection, if any. This method is an alias for getSelectionModel().clear().

clearUndoRedo

public final void clearUndoRedo()

Clears the undo-redo stack of the underlying model. This method does nothing if the model is null.

copy

public void copy()

When selection exists, copies the selected rich text to the clipboard in all the formats supported by the model.

This method does nothing if the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.COPY

copy

public final void copy(DataFormat format)

Copies the selected text in the specified format to the clipboard. This method does nothing if no selection exists or when the data format is not supported by the model.

Parameters:

format - the data format to use

cut

public void cut()

Transfers the currently selected text to the clipboard, removing the current selection.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.CUT

delete

public void delete()

When selection exists, deletes selected text. Otherwise, deletes the symbol at the caret. When the symbol at the caret is a grapheme cluster, deletes the whole cluster.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DELETE

deleteParagraph

public void deleteParagraph()

When selection exists, deletes selected paragraphs. Otherwise, deletes the paragraph at the caret.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DELETE_PARAGRAPH

deleteParagraphStart

public void deleteParagraphStart()

Deletes text from the caret position to the start of the paragraph, ignoring existing selection.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DELETE_PARAGRAPH_START

deleteWordNextEnd

public void deleteWordNextEnd()

Deletes from the caret positon to the end of next word, ignoring existing selection. When the caret is in an empty paragraph, deletes the paragraph.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DELETE_WORD_NEXT_END

deleteWordNextStart

public void deleteWordNextStart()

Deletes from the caret positon to the start of next word, ignoring existing selection. When the caret is in an empty paragraph, deletes the paragraph.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DELETE_WORD_NEXT_START

deleteWordPrevious

public void deleteWordPrevious()

Deletes (multiple) empty paragraphs or text from the caret position to the start of the previous word, ignoring existing selection.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DELETE_WORD_PREVIOUS

deselect

public void deselect()

Clears the selected text range by moving anchor to the caret position.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.DESELECT

errorFeedback

public void errorFeedback()

Provides audio and/or visual error feedback. The default implementation does nothing. This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.ERROR_FEEDBACK

execute

public final void execute(FunctionTag tag)

Executes a function mapped to the specified function tag. This method does nothing if no function is mapped to the tag, or the function has been unbound.

Parameters:

tag - the function tag

executeDefault

public final void executeDefault(FunctionTag tag)

Executes the default function mapped to the specified tag. This method does nothing if no default mapping exists.

Parameters:

tag - the function tag

extendSelection

public final void extendSelection(TextPos pos)

Extends selection to the specified position. Internally, this method will normalized the position to be within the document boundaries. Calling this method produces the same result as select(pos, pos) if no prior selection exists. This method does nothing if the model is null.

Parameters:

pos - the text position

getActiveStyleAttributeMap

public final StyleAttributeMap getActiveStyleAttributeMap()

Returns StyleAttributeMap which contains character and paragraph attributes.

When selection exists, returns the attributes at the first selected character.

When no selection exists, returns the attributes at the character which immediately precedes the caret. When at the beginning of the document, returns the attributes of the first character. If the model uses CSS styles, this method resolves individual attributes (bold, font size, etc.) for this instance of RichTextArea.

Returns:

the non-null StyleAttributeMap instance

getStyleAttributeMap

public final StyleAttributeMap getStyleAttributeMap(TextPos pos,
 boolean forInsert)

Returns the StyleAttributeMap of the character at the specified position's charIndex.

When the position points to the boundary between two text segments with different attributes, the value of forInsert determines which segment will be used: when true, the preceding segment's attributes will be returned so inserted/typed text has the same style as preceding text. When forInsert is false, the returned attributes correspond exactly to the symbol indicated by the specified position.

This method returns the attributes of the last character at the end of the document. An empty StyleAttributeMap is returned for a null model.

Parameters:

pos - the text position

forInsert - whether to pick preceding style at the segment boundary

Returns:

the style attributes, never null

Since:

27

getDocumentEnd

public final TextPos getDocumentEnd()

Returns a TextPos corresponding to the end of the document. When the model is null, returns TextPos.ZERO.

Returns:

the text position

getInputMap

public final InputMap getInputMap()

Returns the input map instance.

Returns:

the input map instance

getParagraphCount

public final int getParagraphCount()

Returns the number of paragraphs in the model. This method returns 0 if the model is null.

Returns:

the paragraph count

getParagraphEnd

public final TextPos getParagraphEnd(int index)

Returns a TextPos corresponding to the end of paragraph. When the model is null, returns TextPos.ZERO.

Parameters:

index - paragraph index

Returns:

text position

getPlainText

public final String getPlainText(int index)

Returns the plain text at the specified paragraph index. The value of index must be between 0 (inclusive) and the value returned by getParagraphCount() (exclusive).

Parameters:

index - the paragraph index

Returns:

the non-null plain text string

Throws:

IndexOutOfBoundsException - if the index is outside of the range supported by the model

getStyleHandlerRegistry

public StyleHandlerRegistry getStyleHandlerRegistry()

Returns the style handler registry for this control. Applications should not normally call this method as it is intended for use by the skin subclasses.

Returns:

the style handler registry

getTextPosition

public final TextPos getTextPosition(double screenX,
 double screenY)

Finds a text position corresponding to the specified screen coordinates. This method returns null if the specified coordinates are outside of the content area.

Parameters:

screenX - the screen x coordinate

screenY - the screen y coordinate

Returns:

the text position, or null

hasNonEmptySelection

public final boolean hasNonEmptySelection()

This convenience method returns true when a non-empty selection exists.

Returns:

true when an non-empty selection exists

insertLineBreak

public void insertLineBreak()

Inserts a line break at the caret. If selection exists, first deletes the selected text.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.INSERT_LINE_BREAK

insertTab

public void insertTab()

Inserts a tab symbol at the caret. If selection exists, first deletes the selected text.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.INSERT_TAB

insertText

public final TextPos insertText(TextPos pos,
 String text,
 StyleAttributeMap attrs)

Inserts the styled text at the specified position. Any embedded "\n" or "\r\n" sequences result in a new paragraph being added.

Parameters:

pos - the insert position

text - the text to inser

attrs - the style attributes

Returns:

the text position at the end of the appended text, or null if editing is disabled

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

insertText

public final TextPos insertText(TextPos pos,
 StyledInput in)

Inserts the styled content at the specified position.

Parameters:

pos - the insert position

in - the input stream

Returns:

the text position at the end of the appended text, or null if editing is disabled

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

moveDocumentEnd

public void moveDocumentEnd()

Moves the caret to after the last character of the text, clearing an existing selection.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_TO_DOCUMENT_END

moveDocumentStart

public void moveDocumentStart()

Moves the caret to before the first character of the text, clearing an existing selection.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_TO_DOCUMENT_START

moveDown

public void moveDown()

Moves the caret one visual line down, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_DOWN

moveLeft

public void moveLeft()

Moves the caret left, clearing an existing selection range.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_LEFT

moveLineEnd

public void moveLineEnd()

Moves the caret to the end of the visual text line at caret, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_TO_LINE_END

moveLineStart

public void moveLineStart()

Moves the caret to the start of the visual text line at caret, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_TO_LINE_START

moveParagraphDown

public void moveParagraphDown()

Moves the caret to the end of the current paragraph, or, if already there, to the end of the next paragraph.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_PARAGRAPH_DOWN

moveParagraphEnd

public void moveParagraphEnd()

Moves the caret to the end of the paragraph at caret, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_TO_PARAGRAPH_END

moveParagraphStart

public void moveParagraphStart()

Moves the caret to the start of the current paragraph, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_TO_PARAGRAPH_START

moveParagraphUp

public void moveParagraphUp()

Moves the caret to the start of the current paragraph, or, if already there, to the start of the previous paragraph.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_PARAGRAPH_UP

moveRight

public void moveRight()

Moves the caret to the next symbol, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_RIGHT

moveUp

public void moveUp()

Moves the caret one visual line up, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_UP

moveWordLeft

public void moveWordLeft()

Moves the caret to the beginning of previous word in a left-to-right setting (or the beginning of the next word in a right-to-left setting), clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_WORD_LEFT

moveWordNextEnd

public void moveWordNextEnd()

Moves the caret to the end of the next word, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_WORD_NEXT_END

moveWordNextStart

public void moveWordNextStart()

Moves the caret to the start of next word, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_WORD_NEXT_START

moveWordPrevious

public void moveWordPrevious()

Moves the caret to the beginning of previous word, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_WORD_PREVIOUS

moveWordRight

public void moveWordRight()

Moves the caret to the beginning of next word in a left-to-right setting (or the beginning of the previous word in a right-to-left setting), clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.MOVE_WORD_RIGHT

pageDown

public void pageDown()

Move caret one visual page down, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.PAGE_DOWN

pageUp

public void pageUp()

Move caret one visual page up, clearing an existing selection.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.PAGE_UP

paste

public void paste()

Pastes the clipboard content at the caret, or, if selection exists, replacing the selected text. This method clears the selection afterward. It is up to the model to pick the best data format to paste.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.PASTE

paste

public void paste(DataFormat format)

Pastes the clipboard content at the caret, or, if selection exists, replacing the selected text.

This method does nothing if the control is not editable or the model is not writable, or the model is null, or if the specified format is not supported by the model.

Parameters:

format - the data format to use

pastePlainText

public final void pastePlainText()

Pastes the plain text clipboard content at the caret, or, if selection exists, replacing the selected text.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.PASTE_PLAIN_TEXT

read

public final void read(DataFormat f,
 InputStream in)
                throws IOException

Calls the model to replace the current document with the content read from the stream using the specified DataFormat. Any existing content is discarded and undo/redo buffer is cleared.

This method does not close the input stream. This method does nothing if the model is null.

Parameters:

f - the data format

in - the input stream

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException - when the data format is not supported by the model

read

public final void read(InputStream in)
                throws IOException

Calls the model to replace the current document with the content read from the input stream. The model picks the best DataFormat to use based on priority. Any existing content is discarded and undo/redo buffer is cleared.

This method does not close the input stream. This method does nothing if the model is null.

Parameters:

in - the input stream

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException - when the data format is not supported by the model

redo

public void redo()

If possible, redoes the last undone modification. If isRedoable() returns false, then calling this method has no effect.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.REDO

replaceText

public final TextPos replaceText(TextPos start,
 TextPos end,
 String text)

Replaces the specified range with the new text.

Parameters:

start - the start text position

end - the end text position

text - the input text

Returns:

the new caret position at the end of inserted text, or null if the change cannot be made

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

replaceText

public final TextPos replaceText(TextPos start,
 TextPos end,
 StyledInput in)

Replaces the specified range with the new input.

Parameters:

start - the start text position

end - the end text position

in - the input stream

Returns:

the new caret position at the end of inserted text, or null if the change cannot be made

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

select

public final void select(TextPos pos)

Moves both the caret and the anchor to the specified position, clearing any existing selection. This method is equivalent to select(pos, pos).

Parameters:

pos - the text position

select

public final void select(TextPos anchor,
 TextPos caret)

Selects the specified range and places the caret at the new position. Both positions will be internally clamped to be within the document boundaries. This method does nothing if the model is null.

Parameters:

anchor - the new selection anchor position

caret - the new caret position

selectAll

public void selectAll()

Selects all the text in the document: the anchor is set at the document start, while the caret is positioned at the end of the document.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_ALL

selectDown

public void selectDown()

Extends selection one visual text line down.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_DOWN

selectLeft

public void selectLeft()

Extends selection one symbol to the left.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_LEFT

selectPageDown

public void selectPageDown()

Extends selection one visible page down.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PAGE_DOWN

selectPageUp

public void selectPageUp()

Extends selection one visible page up.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PAGE_UP

selectParagraph

public void selectParagraph()

Selects the current paragraph.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PARAGRAPH

selectParagraphDown

public void selectParagraphDown()

Extends selection to the end of the current paragraph, or, if already at the end, to the end of the next paragraph.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PARAGRAPH_DOWN

selectParagraphEnd

public void selectParagraphEnd()

Selects from the current position to the paragraph end.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PARAGRAPH_END

selectParagraphStart

public void selectParagraphStart()

Selects from the current position to the paragraph start.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PARAGRAPH_START

selectParagraphUp

public void selectParagraphUp()

Extends selection to the start of the current paragraph, or, if already at the start, to the start of the previous paragraph.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_PARAGRAPH_UP

selectRight

public void selectRight()

Extends selection one symbol (or grapheme cluster) to the right.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_RIGHT

selectToDocumentEnd

public void selectToDocumentEnd()

Extends selection to the end of the document.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_TO_DOCUMENT_END

selectToDocumentStart

public void selectToDocumentStart()

Extends selection to the start of the document.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_TO_DOCUMENT_START

selectToLineEnd

public void selectToLineEnd()

Extends selection to the end of the visual text line at caret.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_TO_LINE_END

selectToLineStart

public void selectToLineStart()

Extends selection to the start of the visual text line at caret.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_TO_LINE_START

selectUp

public void selectUp()

Extends selection one visual text line up.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_UP

selectWord

public void selectWord()

Selects a word at the caret position.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_WORD

selectWordLeft

public void selectWordLeft()

Moves the caret to the beginning of previous word in a left-to-right setting, or to the beginning of the next word in a right-to-left setting. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of next word.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_WORD_LEFT

selectWordNextEnd

public void selectWordNextEnd()

Extends selection to the end of the next word.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_WORD_NEXT_END

selectWordNextStart

public void selectWordNextStart()

Moves the caret to the start of the next word. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of next word.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_WORD_NEXT

selectWordPrevious

public void selectWordPrevious()

Moves the caret to the beginning of previous word. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of previous word.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_WORD_PREVIOUS

selectWordRight

public void selectWordRight()

Moves the caret to the beginning of next word in a left-to-right setting, or to the beginning of the previous word in a right-to-left setting. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of next word.

This method does nothing when the caret position is null.

This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.SELECT_WORD_RIGHT

setStyle

public final void setStyle(TextPos start,
 TextPos end,
 StyleAttributeMap attrs)

Sets the specified style to the selected range. All the existing attributes in the selected range will be cleared. When setting the paragraph attributes, the affected range might be wider than one specified.

Parameters:

start - the start of text range

end - the end of text range

attrs - the style attributes to set

Throws:

NullPointerException - if the model is null

UnsupportedOperationException - if the model is not writable

undo

public void undo()

If possible, undoes the last modification. If isUndoable() returns false, then calling this method has no effect.

This method does nothing if the control is not editable or the model is not writable, or the model or the caret position is null. This action can be changed by remapping the default behavior via InputMap.

See Also:

• RichTextArea.Tag.UNDO

write

public final void write(DataFormat f,
 OutputStream out)
                 throws IOException

Calls the model to writes the current document to the output stream using the specified DataFormat.

This method does not close the output stream. This method does nothing if the model is null.

Parameters:

f - the data format

out - the output stream

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException - when the data format is not supported by the model

write

public final void write(OutputStream out)
                 throws IOException

Calls the model to write the current document to the output stream, using the highest priority DataFormat as determined by the model.

This method does not close the output stream. This method does nothing if the model is null.

Parameters:

out - the output stream

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException - when no suitable data format can be found

createDefaultSkin

protected RichTextAreaSkin createDefaultSkin()

Description copied from class: Control

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Overrides:

createDefaultSkin in class Control

Returns:

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

documentAreaProperty

public final ReadOnlyObjectProperty<Bounds> documentAreaProperty()

Provides the bounds to the document area in local coordinates. The bounds are determined by the skin, and may be null.

Default value:

null

Returns:

the document area

Since:

27

See Also:

• getDocumentArea()

getDocumentArea

public final Bounds getDocumentArea()

Gets the value of the documentArea property.

Property description:

Provides the bounds to the document area in local coordinates. The bounds are determined by the skin, and may be null.

Default value:

null

Returns:

the value of the documentArea property

Since:

27

See Also:

• documentAreaProperty()