# Uses of Class
jfx.incubator.scene.control.richtext.TextPos

Packages that use TextPos
Package
Description
jfx.incubator.scene.control.richtext
Provides two controls for displaying and editing large, virtualized, rich text documents: `RichTextArea` and `CodeArea`.
jfx.incubator.scene.control.richtext.model
Provides common models for `RichTextArea` and `CodeArea` controls.

- ## Uses of TextPos in jfx.incubator.scene.control.richtext

  Classes in jfx.incubator.scene.control.richtext that implement interfaces with type arguments of type TextPos
  Modifier and Type
  Class
  Description
  `final class`
  `TextPos`
  An immutable position within the text.
  Fields in jfx.incubator.scene.control.richtext declared as TextPos
  Modifier and Type
  Field
  Description
  `static final TextPos`
  TextPos.`ZERO`
  A text position at the start of the document.
  Methods in jfx.incubator.scene.control.richtext that return TextPos
  Modifier and Type
  Method
  Description
  `final TextPos`
  RichTextArea.`appendText(String text)`
  Appends the styled text to the end of the document.
  `final TextPos`
  RichTextArea.`appendText(String text, StyleAttributeMap attrs)`
  Appends the styled text to the end of the document.
  `final TextPos`
  RichTextArea.`appendText(StyledInput in)`
  Appends the styled content to the end of the document.
  `final TextPos`
  SelectionSegment.`getAnchor()`
  Returns the selection anchor position.
  `final TextPos`
  RichTextArea.`getAnchorPosition()`
  Gets the value of the `anchorPosition` property.
  `final TextPos`
  SelectionSegment.`getCaret()`
  Returns the caret position.
  `final TextPos`
  RichTextArea.`getCaretPosition()`
  Gets the value of the `caretPosition` property.
  `final TextPos`
  RichTextArea.`getDocumentEnd()`
  Returns a TextPos corresponding to the end of the document.
  `TextPos`
  SelectionSegment.`getMax()`
  Returns the position which is closer to the end of the document.
  `final TextPos`
  SelectionSegment.`getMin()`
  Returns the position which is closer to the start of the document.
  `final TextPos`
  RichTextArea.`getParagraphEnd(int index)`
  Returns a TextPos corresponding to the end of paragraph.
  `final TextPos`
  Marker.`getTextPos()`
  Gets the value of the `textPos` property.
  `final TextPos`
  RichTextArea.`getTextPosition(double screenX, double screenY)`
  Finds a text position corresponding to the specified screen coordinates.
  `final TextPos`
  RichTextArea.`insertText(TextPos pos, String text, StyleAttributeMap attrs)`
  Inserts the styled text at the specified position.
  `final TextPos`
  RichTextArea.`insertText(TextPos pos, StyledInput in)`
  Inserts the styled content at the specified position.
  `static TextPos`
  TextPos.`ofLeading(int index, int offset)`
  Creates a new text position at the leading edge of the character at the specified text offset.
  `final TextPos`
  RichTextArea.`replaceText(TextPos start, TextPos end, String text)`
  Replaces the specified range with the new text.
  `final TextPos`
  RichTextArea.`replaceText(TextPos start, TextPos end, StyledInput in)`
  Replaces the specified range with the new input.
  Methods in jfx.incubator.scene.control.richtext that return types with arguments of type TextPos
  Modifier and Type
  Method
  Description
  `final ReadOnlyProperty<TextPos>`
  RichTextArea.`anchorPositionProperty()`
  Tracks the selection anchor position within the document.
  `ReadOnlyProperty<TextPos>`
  SelectionModel.`anchorPositionProperty()`
  Anchor position property.
  `ReadOnlyProperty<TextPos>`
  SingleSelectionModel.`anchorPositionProperty()`
  `final ReadOnlyProperty<TextPos>`
  RichTextArea.`caretPositionProperty()`
  Tracks the caret position within the document.
  `ReadOnlyProperty<TextPos>`
  SelectionModel.`caretPositionProperty()`
  Caret position property.
  `ReadOnlyProperty<TextPos>`
  SingleSelectionModel.`caretPositionProperty()`
  `final ReadOnlyObjectProperty<TextPos>`
  Marker.`textPosProperty()`
  This property tracks the marker's position within the model (value is never null).
  Methods in jfx.incubator.scene.control.richtext with parameters of type TextPos
  Modifier and Type
  Method
  Description
  `void`
  RichTextArea.`applyStyle(TextPos start, TextPos end, StyleAttributeMap attrs)`
  Applies the specified style to the selected range.
  `int`
  TextPos.`compareTo(TextPos p)`
  `final void`
  RichTextArea.`extendSelection(TextPos pos)`
  Extends selection to the specified position.
  `void`
  SelectionModel.`extendSelection(StyledTextModel model, TextPos pos)`
  Extends selection to the specified position.
  `void`
  SingleSelectionModel.`extendSelection(StyledTextModel model, TextPos pos)`
  `void`
  SyntaxDecorator.`handleChange(CodeTextModel m, TextPos start, TextPos end, int charsTop, int linesAdded, int charsBottom)`
  Receives the updates from the model, before any of the model's `StyledTextModel.Listener`s are notified.
  `final TextPos`
  RichTextArea.`insertText(TextPos pos, String text, StyleAttributeMap attrs)`
  Inserts the styled text at the specified position.
  `final TextPos`
  RichTextArea.`insertText(TextPos pos, StyledInput in)`
  Inserts the styled content at the specified position.
  `boolean`
  TextPos.`isSameInsertionIndex(TextPos p)`
  Returns true if the specified insertion point is the same.
  `final TextPos`
  RichTextArea.`replaceText(TextPos start, TextPos end, String text)`
  Replaces the specified range with the new text.
  `final TextPos`
  RichTextArea.`replaceText(TextPos start, TextPos end, StyledInput in)`
  Replaces the specified range with the new input.
  `final void`
  RichTextArea.`select(TextPos pos)`
  Moves both the caret and the anchor to the specified position, clearing any existing selection.
  `final void`
  RichTextArea.`select(TextPos anchor, TextPos caret)`
  Selects the specified range and places the caret at the new position.
  `void`
  SelectionModel.`setSelection(StyledTextModel model, TextPos anchor, TextPos caret)`
  Replaced existing selection, if any, with the new one.
  `void`
  SingleSelectionModel.`setSelection(StyledTextModel model, TextPos anchor, TextPos caret)`
  `final void`
  RichTextArea.`setStyle(TextPos start, TextPos end, StyleAttributeMap attrs)`
  Sets the specified style to the selected range.
  Constructors in jfx.incubator.scene.control.richtext with parameters of type TextPos
  Modifier
  Constructor
  Description
  ``
  `SelectionSegment(TextPos anchor, TextPos caret)`
  Constructs the selection segment.

- ## Uses of TextPos in jfx.incubator.scene.control.richtext.model

  Methods in jfx.incubator.scene.control.richtext.model that return TextPos
  Modifier and Type
  Method
  Description
  `final TextPos`
  StyledTextModel.`clamp(TextPos p)`
  Returns the text position guaranteed to be within the document and paragraph limits.
  `final TextPos`
  StyledTextModel.`getDocumentEnd()`
  Returns the text position corresponding to the end of the document.
  `TextPos`
  ContentChange.`getEnd()`
  Returns the end position.
  `final TextPos`
  StyledTextModel.`getEndOfParagraphTextPos(int index)`
  Returns a TextPos corresponding to the end of paragraph at the given index.
  `TextPos`
  ContentChange.`getStart()`
  Returns the start position.
  `final TextPos[]`
  StyledTextModel.`redo(StyleResolver resolver)`
  Redoes the recent change, if possible, returning an array comprising [start, end] text positions prior to the change.
  `final TextPos`
  StyledTextModel.`replace(StyleResolver resolver, TextPos start, TextPos end, String text)`
  Replaces the given range with the provided plain text.
  `final TextPos`
  StyledTextModel.`replace(StyleResolver resolver, TextPos start, TextPos end, StyledInput input)`
  Replaces the given range with the provided styled text input.
  `final TextPos[]`
  StyledTextModel.`undo(StyleResolver resolver)`
  Undoes the recent change, if possible, returning an array comprising [start, end] text positions prior to the change.
  Methods in jfx.incubator.scene.control.richtext.model with parameters of type TextPos
  Modifier and Type
  Method
  Description
  `final void`
  StyledTextModel.`applyStyle(TextPos start, TextPos end, StyleAttributeMap attrs, boolean mergeAttributes)`
  Applies the style attributes to the specified range in the document.
  `final TextPos`
  StyledTextModel.`clamp(TextPos p)`
  Returns the text position guaranteed to be within the document and paragraph limits.
  `abstract Object`
  DataFormatHandler.`copy(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end)`
  Creates an object to be put into the Clipboard for the given text range.
  `Object`
  HtmlExportFormatHandler.`copy(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end)`
  `Object`
  PlainTextFormatHandler.`copy(StyledTextModel m, StyleResolver resolver, TextPos start, TextPos end)`
  `Object`
  RichTextFormatHandler.`copy(StyledTextModel m, StyleResolver r, TextPos start, TextPos end)`
  `Object`
  RtfFormatHandler.`copy(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end)`
  `final void`
  StyledTextModel.`export(TextPos start, TextPos end, StyledOutput out)`
  Exports the stream of `StyledSegment`s in the given range to the specified `StyledOutput`.
  `void`
  StyledTextModel.`fireChangeEvent(TextPos start, TextPos end, int charsTop, int linesAdded, int charsBottom)`
  Fires a text modification event for the given range.
  `void`
  StyledTextModel.`fireStyleChangeEvent(TextPos start, TextPos end)`
  Fires a style change event for the given range.
  `final Marker`
  StyledTextModel.`getMarker(TextPos pos)`
  Returns the `Marker` at the specified position.
  `StyleAttributeMap`
  BasicTextModel.`getStyleAttributeMap(StyleResolver resolver, TextPos pos)`
  `StyleAttributeMap`
  RichTextModel.`getStyleAttributeMap(StyleResolver resolver, TextPos pos)`
  `StyleAttributeMap`
  SimpleViewOnlyStyledModel.`getStyleAttributeMap(StyleResolver r, TextPos pos)`
  `abstract StyleAttributeMap`
  StyledTextModel.`getStyleAttributeMap(StyleResolver resolver, TextPos pos)`
  Returns the `StyleAttributeMap` of the character at the specified position's `charIndex`.
  `void`
  BasicTextModel.`insertText(TextPos p, String text)`
  Inserts text at the specified position.
  `static ContentChange`
  ContentChange.`ofEdit(TextPos start, TextPos end, int charsAddedTop, int linesAdded, int charsAddedBottom)`
  Creates the content change event which represents an edit.
  `static ContentChange`
  ContentChange.`ofStyleChange(TextPos start, TextPos end)`
  Creates the content change event which represents a styling update.
  `void`
  BasicTextModel.Content.`removeRange(TextPos start, TextPos end)`
  Removes the specified range.
  `void`
  BasicTextModel.InMemoryContent.`removeRange(TextPos start, TextPos end)`
  `protected void`
  BasicTextModel.`removeRange(TextPos start, TextPos end)`
  `protected void`
  RichTextModel.`removeRange(TextPos start, TextPos end)`
  `protected abstract void`
  StyledTextModel.`removeRange(TextPos start, TextPos end)`
  Removes the specified text range.
  `protected void`
  StyledTextModelViewOnlyBase.`removeRange(TextPos start, TextPos end)`
  `final TextPos`
  StyledTextModel.`replace(StyleResolver resolver, TextPos start, TextPos end, String text)`
  Replaces the given range with the provided plain text.
  `final TextPos`
  StyledTextModel.`replace(StyleResolver resolver, TextPos start, TextPos end, StyledInput input)`
  Replaces the given range with the provided styled text input.
  `abstract void`
  DataFormatHandler.`save(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, OutputStream out)`
  Save the text range in the handler's format to the output stream (e.g.
  `void`
  HtmlExportFormatHandler.`save(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, OutputStream out)`
  `void`
  PlainTextFormatHandler.`save(StyledTextModel m, StyleResolver resolver, TextPos start, TextPos end, OutputStream out)`
  `void`
  RichTextFormatHandler.`save(StyledTextModel m, StyleResolver r, TextPos start, TextPos end, OutputStream out)`
  `void`
  RtfFormatHandler.`save(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, OutputStream out)`