StyledTextArea (richtextfx 0.7-M2 API)

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - org.fxmisc.richtext.StyledTextArea<PS,S>

Type Parameters:

S - type of style that can be applied to text.

All Implemented Interfaces:

Styleable, EventTarget, org.fxmisc.flowless.Virtualized, ClipboardActions<PS,S>, EditActions<PS,S>, NavigationActions<PS,S>, TextEditingArea<PS,S>, TwoDimensional, UndoActions

Direct Known Subclasses:

InlineCssTextArea, InlineStyleTextArea, StyleClassedTextArea
```
public class StyledTextArea<PS,S>
extends Region
implements TextEditingArea<PS,S>, EditActions<PS,S>, ClipboardActions<PS,S>, NavigationActions<PS,S>, UndoActions, TwoDimensional, org.fxmisc.flowless.Virtualized
```
Text editing control. Accepts user input (keyboard, mouse) and provides API to assign style to text ranges. It is suitable for syntax highlighting and rich-text editors.
Subclassing is allowed to define the type of style, e.g. inline style or style classes.

Note: Scroll bars no longer appear when the content spans outside of the viewport. To add scroll bars, the area needs to be wrapped in a VirtualizedScrollPane. For example,
```
 
 // shows area without scroll bars
 InlineCssTextArea area = new InlineCssTextArea();

 // add scroll bars that will display as needed
 VirtualizedScrollPane<InlineCssTextArea> vsPane = new VirtualizedScrollPane(area);

 Parent parent = //;
 parent.getChildren().add(vsPane)
 
 
```
Overriding keyboard shortcuts
StyledTextArea uses KEY_TYPED handler to handle ordinary character input and KEY_PRESSED handler to handle control key combinations (including Enter and Tab). To add or override some keyboard shortcuts, while keeping the rest in place, you would combine the default event handler with a new one that adds or overrides some of the default key combinations. This is how to bind Ctrl+S to the save() operation:
```
 
 import static javafx.scene.input.KeyCode.*;
 import static javafx.scene.input.KeyCombination.*;
 import static org.fxmisc.wellbehaved.event.EventPattern.*;
 import static org.fxmisc.wellbehaved.event.InputMap.*;

 import org.fxmisc.wellbehaved.event.Nodes;

 Nodes.addInputMap(area, consume(keyPressed(S, CONTROL_DOWN), event -> save()));
 
 
```

Property Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Type	Property and Description
`ObservableValue<Integer>`	`anchor`
`ObservableBooleanValue`	`beingUpdated`
`ObservableValue<Integer>`	`caretColumn`
`ObservableValue<Integer>`	`caretPosition`
`ObservableValue<Integer>`	`currentParagraph`
`BooleanProperty`	`editable` Indicates whether this text area can be edited by the user.
`org.reactfx.value.Var<Double>`	`estimatedScrollX` The estimated scrollX value.
`org.reactfx.value.Var<Double>`	`estimatedScrollY` The estimated scrollY value.
`ObservableValue<Integer>`	`length`
`ObjectProperty<Duration>`	`mouseOverTextDelay` Defines how long the mouse has to stay still over the text before a `MouseOverTextEvent` of type `MOUSE_OVER_TEXT_BEGIN` is fired on this text area.
`ObjectProperty<IntFunction<? extends Node>>`	`paragraphGraphicFactory`
`ObjectProperty<PopupAlignment>`	`popupAlignment` Defines where the popup window given in `popupWindowProperty()` is anchored, i.e.
`ObjectProperty<UnaryOperator<Point2D>>`	`popupAnchorAdjustment` Specifies how to adjust the popup window's anchor point.
`ObjectProperty<Point2D>`	`popupAnchorOffset` Specifies further offset (in pixels) of the popup window from the position specified by `popupAlignmentProperty()`.
`ObjectProperty<PopupWindow>`	`popupAtCaret` Deprecated.
`ObjectProperty<PopupWindow>`	`popupWindow` Popup window that will be positioned by this text area relative to the caret or selection.
`ObservableValue<String>`	`selectedText`
`ObservableValue<IndexRange>`	`selection`
`org.reactfx.value.Var<StyledTextArea.CaretVisibility>`	`showCaret` Indicates when this text area should display a caret.
`ObservableValue<String>`	`text`
`org.reactfx.value.Val<Double>`	`totalHeightEstimate` The estimated height of the entire document.
`org.reactfx.value.Val<Double>`	`totalWidthEstimate` The estimated width of the entire document.
`BooleanProperty`	`useInitialStyleForInsertion` Indicates whether the initial style should also be used for plain text inserted into this text area.
`BooleanProperty`	`wrapText` When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.

Properties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent
impl_traversalEngine, needsLayout

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

Properties inherited from interface org.fxmisc.richtext.model.UndoActions
redoAvailable, undoAvailable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StyledTextArea.CaretVisibility
- Nested classes/interfaces inherited from interface org.fxmisc.richtext.model.NavigationActions
  NavigationActions.SelectionPolicy
- Nested classes/interfaces inherited from interface org.fxmisc.richtext.model.TwoDimensional
  TwoDimensional.Bias, TwoDimensional.Position

Nested Classes
Modifier and Type	Class and Description
`static class`	`StyledTextArea.CaretVisibility`

Field Summary

Fields
Modifier and Type Field and Description

static IndexRange EMPTY_RANGE
Index range [0, 0).
- Fields inherited from class javafx.scene.layout.Region
  USE_COMPUTED_SIZE, USE_PREF_SIZE
- Fields inherited from class javafx.scene.Node
  BASELINE_OFFSET_SAME_AS_HEIGHT

Fields
Modifier and Type	Field and Description
`static IndexRange`	`EMPTY_RANGE` Index range [0, 0).

Constructor Summary

Constructors
Constructor and Description
`StyledTextArea(PS initialParagraphStyle, BiConsumer<TextFlow,PS> applyParagraphStyle, S initialTextStyle, BiConsumer<? super TextExt,S> applyStyle)` Creates a text area with empty text content.
`StyledTextArea(PS initialParagraphStyle, BiConsumer<TextFlow,PS> applyParagraphStyle, S initialTextStyle, BiConsumer<? super TextExt,S> applyStyle, boolean preserveStyle)`
`StyledTextArea(PS initialParagraphStyle, BiConsumer<TextFlow,PS> applyParagraphStyle, S initialTextStyle, BiConsumer<? super TextExt,S> applyStyle, EditableStyledDocument<PS,S> document)` The same as `StyledTextArea(Object, BiConsumer, Object, BiConsumer)` except that this constructor can be used to create another `StyledTextArea` object that shares the same `EditableStyledDocument`.
`StyledTextArea(PS initialParagraphStyle, BiConsumer<TextFlow,PS> applyParagraphStyle, S initialTextStyle, BiConsumer<? super TextExt,S> applyStyle, EditableStyledDocument<PS,S> document, boolean preserveStyle)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ObservableValue<Integer>`	`anchorProperty()`
`ObservableBooleanValue`	`beingUpdatedProperty()`
`ObservableValue<Integer>`	`caretColumnProperty()`
`ObservableValue<Integer>`	`caretPositionProperty()`
`void`	`clearParagraphStyle(int paragraph)` Resets the style of the given paragraph to the initial style.
`void`	`clearStyle(int paragraph)` Resets the style of the given paragraph to the initial style.
`void`	`clearStyle(int from, int to)` Resets the style of the given range to the initial style.
`void`	`clearStyle(int paragraph, int from, int to)` Resets the style of the given range in the given paragraph to the initial style.
`ObservableValue<Integer>`	`currentParagraphProperty()`
`void`	`dispose()`
`BooleanProperty`	`editableProperty()` Indicates whether this text area can be edited by the user.
`org.reactfx.value.Var<Double>`	`estimatedScrollXProperty()` The estimated scrollX value.
`org.reactfx.value.Var<Double>`	`estimatedScrollYProperty()` The estimated scrollY value.
`int`	`getAbsolutePosition(int paragraphIndex, int columnIndex)` Returns the absolute position (i.e.
`int`	`getAnchor()` Gets the value of the property anchor.
`BiConsumer<TextFlow,PS>`	`getApplyParagraphStyle()`
`BiConsumer<? super TextExt,S>`	`getApplyStyle()`
`int`	`getCaretColumn()` Gets the value of the property caretColumn.
`int`	`getCaretPosition()` Gets the value of the property caretPosition.
`EditableStyledDocument<PS,S>`	`getContent()` The underlying document that can be displayed by multiple `StyledTextArea`s.
`int`	`getCurrentParagraph()` Gets the value of the property currentParagraph.
`StyledDocument<PS,S>`	`getDocument()` Rich-text content of this text-editing area.
`double`	`getEstimatedScrollX()` Gets the value of the property estimatedScrollX.
`double`	`getEstimatedScrollY()` Gets the value of the property estimatedScrollY.
`PS`	`getInitialParagraphStyle()` Style used by default when no other style is provided.
`S`	`getInitialTextStyle()` Style used by default when no other style is provided.
`int`	`getLength()` Gets the value of the property length.
`Duration`	`getMouseOverTextDelay()` Gets the value of the property mouseOverTextDelay.
`IntConsumer`	`getOnSelectionDrop()`
`Paragraph<PS,S>`	`getParagraph(int index)`
`IntFunction<? extends Node>`	`getParagraphGraphicFactory()` Gets the value of the property paragraphGraphicFactory.
`org.reactfx.collection.LiveList<Paragraph<PS,S>>`	`getParagraphs()` Unmodifiable observable list of paragraphs in this text area.
`IndexRange`	`getParagraphSelection(int paragraph)` Returns the selection range in the given paragraph.
`PopupAlignment`	`getPopupAlignment()` Gets the value of the property popupAlignment.
`UnaryOperator<Point2D>`	`getPopupAnchorAdjustment()` Gets the value of the property popupAnchorAdjustment.
`Point2D`	`getPopupAnchorOffset()` Gets the value of the property popupAnchorOffset.
`PopupWindow`	`getPopupAtCaret()` Deprecated. Use `getPopupWindow()`.
`PopupWindow`	`getPopupWindow()` Gets the value of the property popupWindow.
`String`	`getSelectedText()` Gets the value of the property selectedText.
`IndexRange`	`getSelection()` Gets the value of the property selection.
`StyledTextArea.CaretVisibility`	`getShowCaret()` Gets the value of the property showCaret.
`S`	`getStyleAtPosition(int position)` Returns the style at the given position.
`S`	`getStyleAtPosition(int paragraph, int position)` Returns the style at the given position in the given paragraph.
`Optional<org.reactfx.util.Tuple2<Codec<PS>,Codec<S>>>`	`getStyleCodecs()`
`S`	`getStyleOfChar(int index)` Returns the style of the character with the given index.
`S`	`getStyleOfChar(int paragraph, int index)` Returns the style of the character with the given index in the given paragraph.
`IndexRange`	`getStyleRangeAtPosition(int position)` Returns the range of homogeneous style that includes the given position.
`IndexRange`	`getStyleRangeAtPosition(int paragraph, int position)` Returns the range of homogeneous style that includes the given position in the given paragraph.
`StyleSpans<S>`	`getStyleSpans(IndexRange range)` Returns the styles in the given character range.
`StyleSpans<S>`	`getStyleSpans(int paragraph)` Returns styles of the whole paragraph.
`StyleSpans<S>`	`getStyleSpans(int paragraph, IndexRange range)` Returns the styles in the given character range of the given paragraph.
`StyleSpans<S>`	`getStyleSpans(int from, int to)` Returns the styles in the given character range.
`StyleSpans<S>`	`getStyleSpans(int paragraph, int from, int to)` Returns the styles in the given character range of the given paragraph.
`String`	`getText()` Gets the value of the property text.
`String`	`getText(int paragraph)` Returns text content of the given paragraph.
`String`	`getText(int start, int end)` Returns text content of the given character range.
`double`	`getTotalHeightEstimate()` Gets the value of the property totalHeightEstimate.
`double`	`getTotalWidthEstimate()` Gets the value of the property totalWidthEstimate.
`org.fxmisc.undo.UndoManager`	`getUndoManager()` Undo manager of this text area.
`boolean`	`getUseInitialStyleForInsertion()` Gets the value of the property useInitialStyleForInsertion.
`CharacterHit`	`hit(double x, double y)` Helpful for determining which letter is at point x, y:
`boolean`	`isBeingUpdated()`
`boolean`	`isEditable()` Gets the value of the property editable.
`boolean`	`isPreserveStyle()` Indicates whether style should be preserved on undo/redo, copy/paste and text move.
`boolean`	`isWrapText()` Gets the value of the property wrapText.
`protected void`	`layoutChildren()`
`ObservableValue<Integer>`	`lengthProperty()`
`ObjectProperty<Duration>`	`mouseOverTextDelayProperty()` Defines how long the mouse has to stay still over the text before a `MouseOverTextEvent` of type `MOUSE_OVER_TEXT_BEGIN` is fired on this text area.
`TwoDimensional.Position`	`offsetToPosition(int charOffset, TwoDimensional.Bias bias)`
`ObjectProperty<IntFunction<? extends Node>>`	`paragraphGraphicFactoryProperty()`
`org.reactfx.EventStream<PlainTextChange>`	`plainTextChanges()` Stream of text changes.
`ObjectProperty<PopupAlignment>`	`popupAlignmentProperty()` Defines where the popup window given in `popupWindowProperty()` is anchored, i.e.
`ObjectProperty<UnaryOperator<Point2D>>`	`popupAnchorAdjustmentProperty()` Specifies how to adjust the popup window's anchor point.
`ObjectProperty<Point2D>`	`popupAnchorOffsetProperty()` Specifies further offset (in pixels) of the popup window from the position specified by `popupAlignmentProperty()`.
`ObjectProperty<PopupWindow>`	`popupAtCaretProperty()` Deprecated.
`ObjectProperty<PopupWindow>`	`popupWindowProperty()` Popup window that will be positioned by this text area relative to the caret or selection.
`TwoDimensional.Position`	`position(int row, int col)`
`void`	`positionCaret(int pos)` Deprecated. You probably meant to use `NavigationActions.moveTo(int)`. This method will be made package-private in the future
`void`	`replace(int start, int end, StyledDocument<PS,S> replacement)` Replaces a range of characters with the given rich-text document.
`void`	`replaceText(int start, int end, String text)` Replaces a range of characters with the given text.
`org.reactfx.EventStream<RichTextChange<PS,S>>`	`richChanges()` Stream of rich text changes.
`ObservableValue<String>`	`selectedTextProperty()`
`ObservableValue<IndexRange>`	`selectionProperty()`
`void`	`selectRange(int anchor, int caretPosition)` Positions the anchor and caretPosition explicitly, effectively creating a selection.
`void`	`setEditable(boolean value)` Sets the value of the property editable.
`void`	`setEstimatedScrollX(double value)` Sets the value of the property estimatedScrollX.
`void`	`setEstimatedScrollY(double value)` Sets the value of the property estimatedScrollY.
`void`	`setMouseOverTextDelay(Duration delay)` Sets the value of the property mouseOverTextDelay.
`void`	`setOnSelectionDrop(IntConsumer consumer)`
`void`	`setParagraphGraphicFactory(IntFunction<? extends Node> factory)` Sets the value of the property paragraphGraphicFactory.
`void`	`setParagraphStyle(int paragraph, PS paragraphStyle)` Sets style for the whole paragraph.
`void`	`setPopupAlignment(PopupAlignment pos)` Sets the value of the property popupAlignment.
`void`	`setPopupAnchorAdjustment(UnaryOperator<Point2D> f)` Sets the value of the property popupAnchorAdjustment.
`void`	`setPopupAnchorOffset(Point2D offset)` Sets the value of the property popupAnchorOffset.
`void`	`setPopupAtCaret(PopupWindow popup)` Deprecated. Use `setPopupWindow(PopupWindow)`.
`void`	`setPopupWindow(PopupWindow popup)` Sets the value of the property popupWindow.
`void`	`setShowCaret(StyledTextArea.CaretVisibility value)` Sets the value of the property showCaret.
`void`	`setStyle(int paragraph, int from, int to, S style)` Sets style for the given range relative in the given paragraph.
`void`	`setStyle(int from, int to, S style)` Sets style for the given character range.
`void`	`setStyle(int paragraph, S style)` Sets style for the whole paragraph.
`void`	`setStyleCodecs(Codec<PS> paragraphStyleCodec, Codec<S> textStyleCodec)` Sets codecs to encode/decode style information to/from binary format.
`void`	`setStyleSpans(int paragraph, int from, StyleSpans<? extends S> styleSpans)` Set multiple style ranges of a paragraph at once.
`void`	`setStyleSpans(int from, StyleSpans<? extends S> styleSpans)` Set multiple style ranges at once.
`void`	`setUndoManager(org.fxmisc.undo.UndoManagerFactory undoManagerFactory)`
`void`	`setUseInitialStyleForInsertion(boolean value)` Sets the value of the property useInitialStyleForInsertion.
`void`	`setWrapText(boolean value)` Sets the value of the property wrapText.
`org.reactfx.value.Var<StyledTextArea.CaretVisibility>`	`showCaretProperty()` Indicates when this text area should display a caret.
`StyledDocument<PS,S>`	`subDocument(int paragraphIndex)` Returns rich-text content of the given paragraph.
`StyledDocument<PS,S>`	`subDocument(int start, int end)` Returns rich-text content of the given character range.
`ObservableValue<String>`	`textProperty()`
`org.reactfx.value.Val<Double>`	`totalHeightEstimateProperty()` The estimated height of the entire document.
`org.reactfx.value.Val<Double>`	`totalWidthEstimateProperty()` The estimated width of the entire document.
`BooleanProperty`	`useInitialStyleForInsertionProperty()` Indicates whether the initial style should also be used for plain text inserted into this text area.
`BooleanProperty`	`wrapTextProperty()` When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, 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, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fxmisc.richtext.ClipboardActions
copy, cut, paste

Methods inherited from interface org.fxmisc.richtext.model.EditActions
append, appendText, clear, deleteNextChar, deletePreviousChar, deleteText, deleteText, deleteText, insert, insert, insertText, insertText, moveSelectedText, replace, replaceSelection, replaceSelection, replaceText

Methods inherited from interface org.fxmisc.richtext.model.TextEditingArea
getText, replace, replace, replaceText, replaceText, selectRange, subDocument

Methods inherited from interface org.fxmisc.richtext.model.NavigationActions
deselect, end, lineEnd, lineStart, moveTo, moveTo, moveTo, moveTo, nextChar, previousChar, selectAll, selectLine, start, wordBreaksBackwards, wordBreaksForwards

Methods inherited from interface org.fxmisc.richtext.model.UndoActions
isRedoAvailable, isUndoAvailable, redo, redoAvailableProperty, undo, undoAvailableProperty

- Property Detail
  - editable
```
public final BooleanProperty editableProperty
```
    Indicates whether this text area can be edited by the user. Note that this property doesn't affect editing through the API.
    
    See Also:
    
    isEditable(), setEditable(boolean)
  - wrapText
```
public final BooleanProperty wrapTextProperty
```
    When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.
    
    See Also:
    
    isWrapText(), setWrapText(boolean)
  - showCaret
```
public final org.reactfx.value.Var<StyledTextArea.CaretVisibility> showCaretProperty
```
    Indicates when this text area should display a caret.
    
    See Also:
    
    getShowCaret(), setShowCaret(CaretVisibility)
  - popupWindow
```
public ObjectProperty<PopupWindow> popupWindowProperty
```
    Popup window that will be positioned by this text area relative to the caret or selection. Use popupAlignmentProperty() to specify how the popup should be positioned relative to the caret or selection. Use popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty() to further adjust the position.
    
    See Also:
    
    getPopupWindow(), setPopupWindow(PopupWindow)
  - popupAtCaret
```
@Deprecated
public ObjectProperty<PopupWindow> popupAtCaretProperty
```
    See Also:
    
    getPopupAtCaret(), setPopupAtCaret(PopupWindow)
  - popupAnchorOffset
```
public ObjectProperty<Point2D> popupAnchorOffsetProperty
```
    Specifies further offset (in pixels) of the popup window from the position specified by popupAlignmentProperty().
    If popupAnchorAdjustmentProperty() is also specified, then it overrides the offset set by this property.
    
    See Also:
    
    getPopupAnchorOffset(), setPopupAnchorOffset(Point2D)
  - popupAnchorAdjustment
```
public ObjectProperty<UnaryOperator<Point2D>> popupAnchorAdjustmentProperty
```
    Specifies how to adjust the popup window's anchor point. The given operator is invoked with the screen position calculated according to popupAlignmentProperty() and should return a new screen position. This position will be used as the popup window's anchor point.
    Setting this property overrides popupAnchorOffsetProperty().
    
    See Also:
    
    getPopupAnchorAdjustment(), setPopupAnchorAdjustment(UnaryOperator)
  - popupAlignment
```
public ObjectProperty<PopupAlignment> popupAlignmentProperty
```
    Defines where the popup window given in popupWindowProperty() is anchored, i.e. where its anchor point is positioned. This position can further be adjusted by popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty().
    
    See Also:
    
    getPopupAlignment(), setPopupAlignment(PopupAlignment)
  - mouseOverTextDelay
```
public ObjectProperty<Duration> mouseOverTextDelayProperty
```
    Defines how long the mouse has to stay still over the text before a MouseOverTextEvent of type MOUSE_OVER_TEXT_BEGIN is fired on this text area. When set to null, no MouseOverTextEvents are fired on this text area.
    Default value is null.
    
    See Also:
    
    getMouseOverTextDelay(), setMouseOverTextDelay(Duration)
  - paragraphGraphicFactory
```
public ObjectProperty<IntFunction<? extends Node>> paragraphGraphicFactoryProperty
```
    See Also:
    
    getParagraphGraphicFactory(), setParagraphGraphicFactory(IntFunction)
  - useInitialStyleForInsertion
```
public BooleanProperty useInitialStyleForInsertionProperty
```
    Indicates whether the initial style should also be used for plain text inserted into this text area. When false, the style immediately preceding the insertion position is used. Default value is false.
    
    See Also:
    
    getUseInitialStyleForInsertion(), setUseInitialStyleForInsertion(boolean)
  - estimatedScrollX
```
public org.reactfx.value.Var<Double> estimatedScrollXProperty
```
    The estimated scrollX value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
    
    Specified by:
    
    estimatedScrollXProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getEstimatedScrollX(), setEstimatedScrollX(double)
  - estimatedScrollY
```
public org.reactfx.value.Var<Double> estimatedScrollYProperty
```
    The estimated scrollY value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
    
    Specified by:
    
    estimatedScrollYProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getEstimatedScrollY(), setEstimatedScrollY(double)
  - text
```
public final ObservableValue<String> textProperty
```
    Specified by:
    
    textProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getText()
  - length
```
public final ObservableValue<Integer> lengthProperty
```
    Specified by:
    
    lengthProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getLength()
  - caretPosition
```
public final ObservableValue<Integer> caretPositionProperty
```
    Specified by:
    
    caretPositionProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getCaretPosition()
  - anchor
```
public final ObservableValue<Integer> anchorProperty
```
    Specified by:
    
    anchorProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getAnchor()
  - selection
```
public final ObservableValue<IndexRange> selectionProperty
```
    Specified by:
    
    selectionProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getSelection()
  - selectedText
```
public final ObservableValue<String> selectedTextProperty
```
    Specified by:
    
    selectedTextProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getSelectedText()
  - currentParagraph
```
public final ObservableValue<Integer> currentParagraphProperty
```
    Specified by:
    
    currentParagraphProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getCurrentParagraph()
  - caretColumn
```
public final ObservableValue<Integer> caretColumnProperty
```
    Specified by:
    
    caretColumnProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getCaretColumn()
  - beingUpdated
```
public ObservableBooleanValue beingUpdatedProperty
```
  - totalWidthEstimate
```
public org.reactfx.value.Val<Double> totalWidthEstimateProperty
```
    The estimated width of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.
    
    Specified by:
    
    totalWidthEstimateProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getTotalWidthEstimate()
  - totalHeightEstimate
```
public org.reactfx.value.Val<Double> totalHeightEstimateProperty
```
    The estimated height of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.
    
    Specified by:
    
    totalHeightEstimateProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getTotalHeightEstimate()
- Field Detail
  - EMPTY_RANGE
```
public static final IndexRange EMPTY_RANGE
```
    Index range [0, 0).
- Constructor Detail
  - StyledTextArea
```
public StyledTextArea(PS initialParagraphStyle,
                      BiConsumer<TextFlow,PS> applyParagraphStyle,
                      S initialTextStyle,
                      BiConsumer<? super TextExt,S> applyStyle)
```
    Creates a text area with empty text content.
    
    Parameters:
    
    initialTextStyle - style to use in places where no other style is specified (yet).
    
    applyStyle - function that, given a Text node and a style, applies the style to the text node. This function is used by the default skin to apply style to text nodes.
    
    initialParagraphStyle - style to use in places where no other style is specified (yet).
    
    applyParagraphStyle - function that, given a TextFlow node and a style, applies the style to the paragraph node. This function is used by the default skin to apply style to paragraph nodes.
  - StyledTextArea
```
public StyledTextArea(PS initialParagraphStyle,
                      BiConsumer<TextFlow,PS> applyParagraphStyle,
                      S initialTextStyle,
                      BiConsumer<? super TextExt,S> applyStyle,
                      boolean preserveStyle)
```
  - StyledTextArea
```
public StyledTextArea(PS initialParagraphStyle,
                      BiConsumer<TextFlow,PS> applyParagraphStyle,
                      S initialTextStyle,
                      BiConsumer<? super TextExt,S> applyStyle,
                      EditableStyledDocument<PS,S> document)
```
    The same as StyledTextArea(Object, BiConsumer, Object, BiConsumer) except that this constructor can be used to create another StyledTextArea object that shares the same EditableStyledDocument.
  - StyledTextArea
```
public StyledTextArea(PS initialParagraphStyle,
                      BiConsumer<TextFlow,PS> applyParagraphStyle,
                      S initialTextStyle,
                      BiConsumer<? super TextExt,S> applyStyle,
                      EditableStyledDocument<PS,S> document,
                      boolean preserveStyle)
```
- Method Detail
  - isEditable
```
public final boolean isEditable()
```
    Gets the value of the property editable.
    
    Property description:
    
    Indicates whether this text area can be edited by the user. Note that this property doesn't affect editing through the API.
  - setEditable
```
public final void setEditable(boolean value)
```
    Sets the value of the property editable.
    
    Property description:
    
    Indicates whether this text area can be edited by the user. Note that this property doesn't affect editing through the API.
  - editableProperty
```
public final BooleanProperty editableProperty()
```
    Indicates whether this text area can be edited by the user. Note that this property doesn't affect editing through the API.
    
    See Also:
    
    isEditable(), setEditable(boolean)
  - isWrapText
```
public final boolean isWrapText()
```
    Gets the value of the property wrapText.
    
    Property description:
    
    When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.
  - setWrapText
```
public final void setWrapText(boolean value)
```
    Sets the value of the property wrapText.
    
    Property description:
    
    When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.
  - wrapTextProperty
```
public final BooleanProperty wrapTextProperty()
```
    When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.
    
    See Also:
    
    isWrapText(), setWrapText(boolean)
  - getShowCaret
```
public final StyledTextArea.CaretVisibility getShowCaret()
```
    Gets the value of the property showCaret.
    
    Property description:
    
    Indicates when this text area should display a caret.
  - setShowCaret
```
public final void setShowCaret(StyledTextArea.CaretVisibility value)
```
    Sets the value of the property showCaret.
    
    Property description:
    
    Indicates when this text area should display a caret.
  - showCaretProperty
```
public final org.reactfx.value.Var<StyledTextArea.CaretVisibility> showCaretProperty()
```
    Indicates when this text area should display a caret.
    
    See Also:
    
    getShowCaret(), setShowCaret(CaretVisibility)
  - getUndoManager
```
public org.fxmisc.undo.UndoManager getUndoManager()
```
    Description copied from interface: UndoActions
    
    Undo manager of this text area.
    
    Specified by:
    
    getUndoManager in interface UndoActions
  - setUndoManager
```
public void setUndoManager(org.fxmisc.undo.UndoManagerFactory undoManagerFactory)
```
    Specified by:
    
    setUndoManager in interface UndoActions
  - setPopupWindow
```
public void setPopupWindow(PopupWindow popup)
```
    Sets the value of the property popupWindow.
    
    Property description:
    
    Popup window that will be positioned by this text area relative to the caret or selection. Use popupAlignmentProperty() to specify how the popup should be positioned relative to the caret or selection. Use popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty() to further adjust the position.
  - getPopupWindow
```
public PopupWindow getPopupWindow()
```
    Gets the value of the property popupWindow.
    
    Property description:
    
    Popup window that will be positioned by this text area relative to the caret or selection. Use popupAlignmentProperty() to specify how the popup should be positioned relative to the caret or selection. Use popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty() to further adjust the position.
  - popupWindowProperty
```
public ObjectProperty<PopupWindow> popupWindowProperty()
```
    Popup window that will be positioned by this text area relative to the caret or selection. Use popupAlignmentProperty() to specify how the popup should be positioned relative to the caret or selection. Use popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty() to further adjust the position.
    
    See Also:
    
    getPopupWindow(), setPopupWindow(PopupWindow)
  - setPopupAtCaret
```
@Deprecated
public void setPopupAtCaret(PopupWindow popup)
```
    Deprecated. Use setPopupWindow(PopupWindow).
  - getPopupAtCaret
```
@Deprecated
public PopupWindow getPopupAtCaret()
```
    Deprecated. Use getPopupWindow().
  - popupAtCaretProperty
```
@Deprecated
public ObjectProperty<PopupWindow> popupAtCaretProperty()
```
    Deprecated.
    
    See Also:
    
    getPopupAtCaret(), setPopupAtCaret(PopupWindow)
  - setPopupAnchorOffset
```
public void setPopupAnchorOffset(Point2D offset)
```
    Sets the value of the property popupAnchorOffset.
    
    Property description:
    
    Specifies further offset (in pixels) of the popup window from the position specified by popupAlignmentProperty().
    If popupAnchorAdjustmentProperty() is also specified, then it overrides the offset set by this property.
  - getPopupAnchorOffset
```
public Point2D getPopupAnchorOffset()
```
    Gets the value of the property popupAnchorOffset.
    
    Property description:
    
    Specifies further offset (in pixels) of the popup window from the position specified by popupAlignmentProperty().
    If popupAnchorAdjustmentProperty() is also specified, then it overrides the offset set by this property.
  - popupAnchorOffsetProperty
```
public ObjectProperty<Point2D> popupAnchorOffsetProperty()
```
    Specifies further offset (in pixels) of the popup window from the position specified by popupAlignmentProperty().
    If popupAnchorAdjustmentProperty() is also specified, then it overrides the offset set by this property.
    
    See Also:
    
    getPopupAnchorOffset(), setPopupAnchorOffset(Point2D)
  - setPopupAnchorAdjustment
```
public void setPopupAnchorAdjustment(UnaryOperator<Point2D> f)
```
    Sets the value of the property popupAnchorAdjustment.
    
    Property description:
    
    Specifies how to adjust the popup window's anchor point. The given operator is invoked with the screen position calculated according to popupAlignmentProperty() and should return a new screen position. This position will be used as the popup window's anchor point.
    Setting this property overrides popupAnchorOffsetProperty().
  - getPopupAnchorAdjustment
```
public UnaryOperator<Point2D> getPopupAnchorAdjustment()
```
    Gets the value of the property popupAnchorAdjustment.
    
    Property description:
    
    Specifies how to adjust the popup window's anchor point. The given operator is invoked with the screen position calculated according to popupAlignmentProperty() and should return a new screen position. This position will be used as the popup window's anchor point.
    Setting this property overrides popupAnchorOffsetProperty().
  - popupAnchorAdjustmentProperty
```
public ObjectProperty<UnaryOperator<Point2D>> popupAnchorAdjustmentProperty()
```
    Specifies how to adjust the popup window's anchor point. The given operator is invoked with the screen position calculated according to popupAlignmentProperty() and should return a new screen position. This position will be used as the popup window's anchor point.
    Setting this property overrides popupAnchorOffsetProperty().
    
    See Also:
    
    getPopupAnchorAdjustment(), setPopupAnchorAdjustment(UnaryOperator)
  - setPopupAlignment
```
public void setPopupAlignment(PopupAlignment pos)
```
    Sets the value of the property popupAlignment.
    
    Property description:
    
    Defines where the popup window given in popupWindowProperty() is anchored, i.e. where its anchor point is positioned. This position can further be adjusted by popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty().
  - getPopupAlignment
```
public PopupAlignment getPopupAlignment()
```
    Gets the value of the property popupAlignment.
    
    Property description:
    
    Defines where the popup window given in popupWindowProperty() is anchored, i.e. where its anchor point is positioned. This position can further be adjusted by popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty().
  - popupAlignmentProperty
```
public ObjectProperty<PopupAlignment> popupAlignmentProperty()
```
    Defines where the popup window given in popupWindowProperty() is anchored, i.e. where its anchor point is positioned. This position can further be adjusted by popupAnchorOffsetProperty() or popupAnchorAdjustmentProperty().
    
    See Also:
    
    getPopupAlignment(), setPopupAlignment(PopupAlignment)
  - setMouseOverTextDelay
```
public void setMouseOverTextDelay(Duration delay)
```
    Sets the value of the property mouseOverTextDelay.
    
    Property description:
    
    Defines how long the mouse has to stay still over the text before a MouseOverTextEvent of type MOUSE_OVER_TEXT_BEGIN is fired on this text area. When set to null, no MouseOverTextEvents are fired on this text area.
    Default value is null.
  - getMouseOverTextDelay
```
public Duration getMouseOverTextDelay()
```
    Gets the value of the property mouseOverTextDelay.
    
    Property description:
    
    Defines how long the mouse has to stay still over the text before a MouseOverTextEvent of type MOUSE_OVER_TEXT_BEGIN is fired on this text area. When set to null, no MouseOverTextEvents are fired on this text area.
    Default value is null.
  - mouseOverTextDelayProperty
```
public ObjectProperty<Duration> mouseOverTextDelayProperty()
```
    Defines how long the mouse has to stay still over the text before a MouseOverTextEvent of type MOUSE_OVER_TEXT_BEGIN is fired on this text area. When set to null, no MouseOverTextEvents are fired on this text area.
    Default value is null.
    
    See Also:
    
    getMouseOverTextDelay(), setMouseOverTextDelay(Duration)
  - setOnSelectionDrop
```
public final void setOnSelectionDrop(IntConsumer consumer)
```
  - getOnSelectionDrop
```
public final IntConsumer getOnSelectionDrop()
```
  - setParagraphGraphicFactory
```
public void setParagraphGraphicFactory(IntFunction<? extends Node> factory)
```
    Sets the value of the property paragraphGraphicFactory.
  - getParagraphGraphicFactory
```
public IntFunction<? extends Node> getParagraphGraphicFactory()
```
    Gets the value of the property paragraphGraphicFactory.
  - paragraphGraphicFactoryProperty
```
public ObjectProperty<IntFunction<? extends Node>> paragraphGraphicFactoryProperty()
```
    See Also:
    
    getParagraphGraphicFactory(), setParagraphGraphicFactory(IntFunction)
  - useInitialStyleForInsertionProperty
```
public BooleanProperty useInitialStyleForInsertionProperty()
```
    Indicates whether the initial style should also be used for plain text inserted into this text area. When false, the style immediately preceding the insertion position is used. Default value is false.
    
    See Also:
    
    getUseInitialStyleForInsertion(), setUseInitialStyleForInsertion(boolean)
  - setUseInitialStyleForInsertion
```
public void setUseInitialStyleForInsertion(boolean value)
```
    Sets the value of the property useInitialStyleForInsertion.
    
    Property description:
    
    Indicates whether the initial style should also be used for plain text inserted into this text area. When false, the style immediately preceding the insertion position is used. Default value is false.
  - getUseInitialStyleForInsertion
```
public boolean getUseInitialStyleForInsertion()
```
    Gets the value of the property useInitialStyleForInsertion.
    
    Property description:
    
    Indicates whether the initial style should also be used for plain text inserted into this text area. When false, the style immediately preceding the insertion position is used. Default value is false.
  - setStyleCodecs
```
public void setStyleCodecs(Codec<PS> paragraphStyleCodec,
                           Codec<S> textStyleCodec)
```
    Sets codecs to encode/decode style information to/from binary format. Providing codecs enables clipboard actions to retain the style information.
  - getStyleCodecs
```
public Optional<org.reactfx.util.Tuple2<Codec<PS>,Codec<S>>> getStyleCodecs()
```
    Specified by:
    
    getStyleCodecs in interface ClipboardActions<PS,S>
  - estimatedScrollXProperty
```
public org.reactfx.value.Var<Double> estimatedScrollXProperty()
```
    The estimated scrollX value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
    
    Specified by:
    
    estimatedScrollXProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getEstimatedScrollX(), setEstimatedScrollX(double)
  - getEstimatedScrollX
```
public double getEstimatedScrollX()
```
    Gets the value of the property estimatedScrollX.
    
    Property description:
    
    The estimated scrollX value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
  - setEstimatedScrollX
```
public void setEstimatedScrollX(double value)
```
    Sets the value of the property estimatedScrollX.
    
    Property description:
    
    The estimated scrollX value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
  - estimatedScrollYProperty
```
public org.reactfx.value.Var<Double> estimatedScrollYProperty()
```
    The estimated scrollY value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
    
    Specified by:
    
    estimatedScrollYProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getEstimatedScrollY(), setEstimatedScrollY(double)
  - getEstimatedScrollY
```
public double getEstimatedScrollY()
```
    Gets the value of the property estimatedScrollY.
    
    Property description:
    
    The estimated scrollY value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
  - setEstimatedScrollY
```
public void setEstimatedScrollY(double value)
```
    Sets the value of the property estimatedScrollY.
    
    Property description:
    
    The estimated scrollY value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.
  - getText
```
public final String getText()
```
    Gets the value of the property text.
    
    Specified by:
    
    getText in interface TextEditingArea<PS,S>
  - textProperty
```
public final ObservableValue<String> textProperty()
```
    Specified by:
    
    textProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getText()
  - getDocument
```
public final StyledDocument<PS,S> getDocument()
```
    Description copied from interface: TextEditingArea
    
    Rich-text content of this text-editing area. The returned document is immutable, it does not reflect subsequent edits of this text-editing area.
    
    Specified by:
    
    getDocument in interface TextEditingArea<PS,S>
  - getLength
```
public final int getLength()
```
    Gets the value of the property length.
    
    Specified by:
    
    getLength in interface TextEditingArea<PS,S>
  - lengthProperty
```
public final ObservableValue<Integer> lengthProperty()
```
    Specified by:
    
    lengthProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getLength()
  - getCaretPosition
```
public final int getCaretPosition()
```
    Gets the value of the property caretPosition.
    
    Specified by:
    
    getCaretPosition in interface TextEditingArea<PS,S>
  - caretPositionProperty
```
public final ObservableValue<Integer> caretPositionProperty()
```
    Specified by:
    
    caretPositionProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getCaretPosition()
  - getAnchor
```
public final int getAnchor()
```
    Gets the value of the property anchor.
    
    Specified by:
    
    getAnchor in interface TextEditingArea<PS,S>
  - anchorProperty
```
public final ObservableValue<Integer> anchorProperty()
```
    Specified by:
    
    anchorProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getAnchor()
  - getSelection
```
public final IndexRange getSelection()
```
    Gets the value of the property selection.
    
    Specified by:
    
    getSelection in interface TextEditingArea<PS,S>
  - selectionProperty
```
public final ObservableValue<IndexRange> selectionProperty()
```
    Specified by:
    
    selectionProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getSelection()
  - getSelectedText
```
public final String getSelectedText()
```
    Gets the value of the property selectedText.
    
    Specified by:
    
    getSelectedText in interface TextEditingArea<PS,S>
  - selectedTextProperty
```
public final ObservableValue<String> selectedTextProperty()
```
    Specified by:
    
    selectedTextProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getSelectedText()
  - getCurrentParagraph
```
public final int getCurrentParagraph()
```
    Gets the value of the property currentParagraph.
    
    Specified by:
    
    getCurrentParagraph in interface TextEditingArea<PS,S>
  - currentParagraphProperty
```
public final ObservableValue<Integer> currentParagraphProperty()
```
    Specified by:
    
    currentParagraphProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getCurrentParagraph()
  - getCaretColumn
```
public final int getCaretColumn()
```
    Gets the value of the property caretColumn.
    
    Specified by:
    
    getCaretColumn in interface TextEditingArea<PS,S>
  - caretColumnProperty
```
public final ObservableValue<Integer> caretColumnProperty()
```
    Specified by:
    
    caretColumnProperty in interface TextEditingArea<PS,S>
    
    See Also:
    
    getCaretColumn()
  - getParagraphs
```
public org.reactfx.collection.LiveList<Paragraph<PS,S>> getParagraphs()
```
    Description copied from interface: TextEditingArea
    
    Unmodifiable observable list of paragraphs in this text area.
    
    Specified by:
    
    getParagraphs in interface TextEditingArea<PS,S>
  - beingUpdatedProperty
```
public ObservableBooleanValue beingUpdatedProperty()
```
  - isBeingUpdated
```
public boolean isBeingUpdated()
```
  - totalWidthEstimateProperty
```
public org.reactfx.value.Val<Double> totalWidthEstimateProperty()
```
    The estimated width of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.
    
    Specified by:
    
    totalWidthEstimateProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getTotalWidthEstimate()
  - getTotalWidthEstimate
```
public double getTotalWidthEstimate()
```
    Gets the value of the property totalWidthEstimate.
    
    Property description:
    
    The estimated width of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.
  - totalHeightEstimateProperty
```
public org.reactfx.value.Val<Double> totalHeightEstimateProperty()
```
    The estimated height of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.
    
    Specified by:
    
    totalHeightEstimateProperty in interface org.fxmisc.flowless.Virtualized
    
    See Also:
    
    getTotalHeightEstimate()
  - getTotalHeightEstimate
```
public double getTotalHeightEstimate()
```
    Gets the value of the property totalHeightEstimate.
    
    Property description:
    
    The estimated height of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.
  - plainTextChanges
```
public final org.reactfx.EventStream<PlainTextChange> plainTextChanges()
```
    Description copied from interface: TextEditingArea
    
    Stream of text changes.
    
    Specified by:
    
    plainTextChanges in interface TextEditingArea<PS,S>
  - richChanges
```
public final org.reactfx.EventStream<RichTextChange<PS,S>> richChanges()
```
    Description copied from interface: TextEditingArea
    
    Stream of rich text changes.
    
    Specified by:
    
    richChanges in interface TextEditingArea<PS,S>
  - getContent
```
public final EditableStyledDocument<PS,S> getContent()
```
    The underlying document that can be displayed by multiple StyledTextAreas.
  - getInitialTextStyle
```
public final S getInitialTextStyle()
```
    Style used by default when no other style is provided.
  - getInitialParagraphStyle
```
public final PS getInitialParagraphStyle()
```
    Style used by default when no other style is provided.
  - getApplyStyle
```
public final BiConsumer<? super TextExt,S> getApplyStyle()
```
  - getApplyParagraphStyle
```
public final BiConsumer<TextFlow,PS> getApplyParagraphStyle()
```
  - isPreserveStyle
```
public final boolean isPreserveStyle()
```
    Indicates whether style should be preserved on undo/redo, copy/paste and text move. TODO: Currently, only undo/redo respect this flag.
  - hit
```
public CharacterHit hit(double x,
                        double y)
```
    Helpful for determining which letter is at point x, y:
```
     
     StyledTextArea area = // creation code
     area.addEventHandler(MouseEvent.MOUSE_PRESSED, (MouseEvent e) -> {
         CharacterHit hit = area.hit(e.getX(), e.getY());
         int characterPosition = hit.getInsertionIndex();

         // move the caret to that character's position
         area.moveTo(characterPosition, SelectionPolicy.CLEAR);
     }
 
```
  - getText
```
public final String getText(int start,
                            int end)
```
    Description copied from interface: TextEditingArea
    
    Returns text content of the given character range.
    
    Specified by:
    
    getText in interface TextEditingArea<PS,S>
  - getText
```
public String getText(int paragraph)
```
    Description copied from interface: TextEditingArea
    
    Returns text content of the given paragraph.
    
    Specified by:
    
    getText in interface TextEditingArea<PS,S>
  - getParagraph
```
public Paragraph<PS,S> getParagraph(int index)
```
  - subDocument
```
public StyledDocument<PS,S> subDocument(int start,
                                        int end)
```
    Description copied from interface: TextEditingArea
    
    Returns rich-text content of the given character range.
    
    Specified by:
    
    subDocument in interface TextEditingArea<PS,S>
  - subDocument
```
public StyledDocument<PS,S> subDocument(int paragraphIndex)
```
    Description copied from interface: TextEditingArea
    
    Returns rich-text content of the given paragraph.
    
    Specified by:
    
    subDocument in interface TextEditingArea<PS,S>
  - getParagraphSelection
```
public IndexRange getParagraphSelection(int paragraph)
```
    Returns the selection range in the given paragraph.
  - getStyleOfChar
```
public S getStyleOfChar(int index)
```
    Returns the style of the character with the given index. If index points to a line terminator character, the last style used in the paragraph terminated by that line terminator is returned.
  - getStyleAtPosition
```
public S getStyleAtPosition(int position)
```
    Returns the style at the given position. That is the style of the character immediately preceding position, except when position points to a paragraph boundary, in which case it is the style at the beginning of the latter paragraph.
    In other words, most of the time getStyleAtPosition(p) is equivalent to getStyleOfChar(p-1), except when p points to a paragraph boundary, in which case it is equivalent to getStyleOfChar(p).
  - getStyleRangeAtPosition
```
public IndexRange getStyleRangeAtPosition(int position)
```
    Returns the range of homogeneous style that includes the given position. If position points to a boundary between two styled ranges, then the range preceding position is returned. If position points to a boundary between two paragraphs, then the first styled range of the latter paragraph is returned.
  - getStyleSpans
```
public StyleSpans<S> getStyleSpans(int from,
                                   int to)
```
    Returns the styles in the given character range.
  - getStyleSpans
```
public StyleSpans<S> getStyleSpans(IndexRange range)
```
    Returns the styles in the given character range.
  - getStyleOfChar
```
public S getStyleOfChar(int paragraph,
                        int index)
```
    Returns the style of the character with the given index in the given paragraph. If index is beyond the end of the paragraph, the style at the end of line is returned. If index is negative, it is the same as if it was 0.
  - getStyleAtPosition
```
public S getStyleAtPosition(int paragraph,
                            int position)
```
    Returns the style at the given position in the given paragraph. This is equivalent to getStyleOfChar(paragraph, position-1).
  - getStyleRangeAtPosition
```
public IndexRange getStyleRangeAtPosition(int paragraph,
                                          int position)
```
    Returns the range of homogeneous style that includes the given position in the given paragraph. If position points to a boundary between two styled ranges, then the range preceding position is returned.
  - getStyleSpans
```
public StyleSpans<S> getStyleSpans(int paragraph)
```
    Returns styles of the whole paragraph.
  - getStyleSpans
```
public StyleSpans<S> getStyleSpans(int paragraph,
                                   int from,
                                   int to)
```
    Returns the styles in the given character range of the given paragraph.
  - getStyleSpans
```
public StyleSpans<S> getStyleSpans(int paragraph,
                                   IndexRange range)
```
    Returns the styles in the given character range of the given paragraph.
  - getAbsolutePosition
```
public int getAbsolutePosition(int paragraphIndex,
                               int columnIndex)
```
    Description copied from interface: TextEditingArea
    Returns the absolute position (i.e. the spot in-between characters) to the left of the given column in the given paragraph.
    For example, given a text with only one line "text" and the columnIndex value of 1, "position 1" would be returned:
```
  ┌ character index 0
  | ┌ character index 1
  | |   ┌ character index 3
  | |   |
  v v   v

 |t|e|x|t|

 ^ ^     ^
 | |     |
 | |     └ position 4
 | └ position 1
 └ position 0
 
```
    Warning: Off-By-One errors can easily occur
    
    If the column index spans outside of the given paragraph's length, the returned value will pass on to the previous/next paragraph. In other words, given a document with two paragraphs (where the first paragraph's text is "some" and the second "thing"), then the following statements are true:
    - getAbsolutePosition(0, "some".length()) == 4 == getAbsolutePosition(1, -1)
    - getAbsolutePosition(0, "some".length() + 1) == 5 == getAbsolutePosition(1, 0)
    Specified by:
    
    getAbsolutePosition in interface TextEditingArea<PS,S>
    
    Parameters:
    
    paragraphIndex - The index of the paragraph from which to start.
    
    columnIndex - If positive, the index going forward (the given paragraph's line or the next one(s)). If negative, the index going backward (the previous paragraph's line(s)
  - position
```
public TwoDimensional.Position position(int row,
                                        int col)
```
    Specified by:
    
    position in interface TwoDimensional
  - offsetToPosition
```
public TwoDimensional.Position offsetToPosition(int charOffset,
                                                TwoDimensional.Bias bias)
```
    Specified by:
    
    offsetToPosition in interface TwoDimensional
  - setStyle
```
public void setStyle(int from,
                     int to,
                     S style)
```
    Sets style for the given character range.
  - setStyle
```
public void setStyle(int paragraph,
                     S style)
```
    Sets style for the whole paragraph.
  - setStyle
```
public void setStyle(int paragraph,
                     int from,
                     int to,
                     S style)
```
    Sets style for the given range relative in the given paragraph.
  - setStyleSpans
```
public void setStyleSpans(int from,
                          StyleSpans<? extends S> styleSpans)
```
    Set multiple style ranges at once. This is equivalent to
```
 for(StyleSpan <S> span: styleSpans) {
     setStyle(from, from + span.getLength(), span.getStyle());
     from += span.getLength();
 }
 
```
    but the actual implementation is more efficient.
  - setStyleSpans
```
public void setStyleSpans(int paragraph,
                          int from,
                          StyleSpans<? extends S> styleSpans)
```
    Set multiple style ranges of a paragraph at once. This is equivalent to
```
 for(StyleSpan <S> span: styleSpans) {
     setStyle(paragraph, from, from + span.getLength(), span.getStyle());
     from += span.getLength();
 }
 
```
    but the actual implementation is more efficient.
  - setParagraphStyle
```
public void setParagraphStyle(int paragraph,
                              PS paragraphStyle)
```
    Sets style for the whole paragraph.
  - clearStyle
```
public void clearStyle(int from,
                       int to)
```
    Resets the style of the given range to the initial style.
  - clearStyle
```
public void clearStyle(int paragraph)
```
    Resets the style of the given paragraph to the initial style.
  - clearStyle
```
public void clearStyle(int paragraph,
                       int from,
                       int to)
```
    Resets the style of the given range in the given paragraph to the initial style.
  - clearParagraphStyle
```
public void clearParagraphStyle(int paragraph)
```
    Resets the style of the given paragraph to the initial style.
  - replaceText
```
public void replaceText(int start,
                        int end,
                        String text)
```
    Description copied from interface: TextEditingArea
    
    Replaces a range of characters with the given text. It must hold 0 <= start <= end <= getLength().
    
    Specified by:
    
    replaceText in interface TextEditingArea<PS,S>
    
    Parameters:
    
    start - Start index of the range to replace, inclusive.
    
    end - End index of the range to replace, exclusive.
    
    text - The text to put in place of the deleted range. It must not be null.
  - replace
```
public void replace(int start,
                    int end,
                    StyledDocument<PS,S> replacement)
```
    Description copied from interface: TextEditingArea
    
    Replaces a range of characters with the given rich-text document.
    
    Specified by:
    
    replace in interface TextEditingArea<PS,S>
  - selectRange
```
public void selectRange(int anchor,
                        int caretPosition)
```
    Description copied from interface: TextEditingArea
    
    Positions the anchor and caretPosition explicitly, effectively creating a selection.
    
    Specified by:
    
    selectRange in interface TextEditingArea<PS,S>
  - positionCaret
```
@Deprecated
public void positionCaret(int pos)
```
    Deprecated. You probably meant to use NavigationActions.moveTo(int). This method will be made package-private in the future
    
    Positions only the caret. Doesn't move the anchor and doesn't change the selection. Can be used to achieve the special case of positioning the caret outside or inside the selection, as opposed to always being at the boundary. Use with care.
    
    Specified by:
    
    positionCaret in interface TextEditingArea<PS,S>
  - dispose
```
public void dispose()
```
  - layoutChildren
```
protected void layoutChildren()
```
    Overrides:
    
    layoutChildren in class Parent

Class StyledTextArea<PS,S>

Overriding keyboard shortcuts

Property Summary

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Properties inherited from interface org.fxmisc.richtext.model.UndoActions

Nested Class Summary

Nested classes/interfaces inherited from interface org.fxmisc.richtext.model.NavigationActions

Nested classes/interfaces inherited from interface org.fxmisc.richtext.model.TwoDimensional

Field Summary

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Methods inherited from interface org.fxmisc.richtext.ClipboardActions

Methods inherited from interface org.fxmisc.richtext.model.EditActions

Methods inherited from interface org.fxmisc.richtext.model.TextEditingArea

Methods inherited from interface org.fxmisc.richtext.model.NavigationActions

Methods inherited from interface org.fxmisc.richtext.model.UndoActions

Property Detail

editable

wrapText

showCaret

popupWindow

popupAtCaret

popupAnchorOffset

popupAnchorAdjustment

popupAlignment

mouseOverTextDelay

paragraphGraphicFactory

useInitialStyleForInsertion

estimatedScrollX

estimatedScrollY

text

length

caretPosition

anchor

selection

selectedText

currentParagraph

caretColumn

beingUpdated

totalWidthEstimate

totalHeightEstimate

Field Detail

EMPTY_RANGE

Constructor Detail

StyledTextArea

StyledTextArea

StyledTextArea

StyledTextArea

Method Detail

isEditable

setEditable

editableProperty

isWrapText

setWrapText

wrapTextProperty

getShowCaret

setShowCaret

showCaretProperty

getUndoManager

setUndoManager

setPopupWindow

getPopupWindow

popupWindowProperty

setPopupAtCaret

getPopupAtCaret

popupAtCaretProperty

setPopupAnchorOffset

getPopupAnchorOffset

popupAnchorOffsetProperty

setPopupAnchorAdjustment

getPopupAnchorAdjustment

popupAnchorAdjustmentProperty