org.fxmisc.richtext.model

Interface NavigationActions<PS,S>

All Superinterfaces:

TextEditingArea<PS,S>

All Known Implementing Classes:

CodeArea, InlineCssTextArea, InlineStyleTextArea, StyleClassedTextArea, StyledTextArea, StyledTextAreaModel

public interface NavigationActions<PS,S>
extends TextEditingArea<PS,S>

Navigation actions for TextEditingArea.

Property Summary

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

anchor, caretColumn, caretPosition, currentParagraph, length, selectedText, selection, text

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NavigationActions.SelectionPolicy Indicates how to treat selection when caret is moved.

Method Summary

Modifier and Type	Method and Description
default void	deselect() Clears the selection while keeping the caret position.
default void	end(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the end of the text.
default void	lineEnd(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the end of the current line.
default void	lineStart(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the beginning of the current line.
default void	moveTo(int pos) Moves the caret to the given position in the text and clears any selection.
default void	moveTo(int paragraphIndex, int columnIndex) Moves the caret to the position returned from getAbsolutePosition(paragraphIndex, columnIndex) and clears any selection.
default void	moveTo(int paragraphIndex, int columnIndex, NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the position returned from getAbsolutePosition(paragraphIndex, columnIndex).
default void	moveTo(int pos, NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the position indicated by pos.
default void	nextChar(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret forward one char in the text.
default void	previousChar(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret backward one char in the text.
default void	selectAll() Selects all text in the text input.
default void	selectLine() Selects the current line.
default void	start(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the beginning of the text.
default void	wordBreaksBackwards(int n, NavigationActions.SelectionPolicy selectionPolicy) Skips n number of word boundaries backwards.
default void	wordBreaksForwards(int n, NavigationActions.SelectionPolicy selectionPolicy) Skips n number of word boundaries forward.

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

anchorProperty, caretColumnProperty, caretPositionProperty, currentParagraphProperty, getAbsolutePosition, getAnchor, getCaretColumn, getCaretPosition, getCurrentParagraph, getDocument, getLength, getParagraphs, getSelectedText, getSelection, getText, getText, getText, getText, lengthProperty, plainTextChanges, positionCaret, replace, replace, replace, replaceText, replaceText, replaceText, richChanges, selectedTextProperty, selectionProperty, selectRange, selectRange, subDocument, subDocument, subDocument, textProperty

Method Detail

moveTo

default void moveTo(int pos)

Moves the caret to the given position in the text and clears any selection.

moveTo

default void moveTo(int paragraphIndex,
                    int columnIndex)

Moves the caret to the position returned from getAbsolutePosition(paragraphIndex, columnIndex) and clears any selection.

For example, if "|" represents the caret, "_" represents a newline character, and given the text "Some_Text" (1st line: 'Some'; 2nd line 'Text'), then...

• calling moveTo(0, 4) results in "Some|_Text" (caret to the left of "_")
• calling moveTo(1, -1) results in "Some|_Text" (caret in the left of "_")
• calling moveTo(1, 0) results in "Some_|Text" (caret in the left of "T")
• calling moveTo(0, 5) results in "Some_|Text" (caret in the left of "T")

Caution: see TextEditingArea.getAbsolutePosition(int, int) to know how the column index argument can affect the returned position.

Parameters:

paragraphIndex - the index of the paragraph to which to move the caret

columnIndex - the index to the left of which to move the caret

moveTo

default void moveTo(int pos,
                    NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret to the position indicated by pos. Based on the selection policy, the selection is either cleared (i.e. anchor is set to the same position as caret), adjusted (i.e. anchor is not moved at all), or extended (i.e. pos becomes the new caret and, if pos points outside the current selection, the far end of the current selection becomes the anchor.

moveTo

default void moveTo(int paragraphIndex,
                    int columnIndex,
                    NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret to the position returned from getAbsolutePosition(paragraphIndex, columnIndex). Based on the selection policy, the selection is either cleared (i.e. anchor is set to the same position as caret), adjusted (i.e. anchor is not moved at all), or extended (i.e. getAbsolutePosition(paragraphIndex, columnIndex becomes the new caret and, if that returned value points outside the current selection, the far end of the current selection becomes the anchor.

Caution: see TextEditingArea.getAbsolutePosition(int, int) to know how the column index argument can affect the returned position.

previousChar

default void previousChar(NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret backward one char in the text. Based on the given selection policy, anchor either moves with the caret, stays put, or moves to the former caret position.

nextChar

default void nextChar(NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret forward one char in the text. Based on the given selection policy, anchor either moves with the caret, stays put, or moves to the former caret position.

wordBreaksBackwards

default void wordBreaksBackwards(int n,
                                 NavigationActions.SelectionPolicy selectionPolicy)

Skips n number of word boundaries backwards. Based on the given selection policy, anchor either moves with the caret, stays put, or moves to the former caret position.

wordBreaksForwards

default void wordBreaksForwards(int n,
                                NavigationActions.SelectionPolicy selectionPolicy)

Skips n number of word boundaries forward. Based on the given selection policy, anchor either moves with the caret, stays put, or moves to the former caret position.

lineStart

default void lineStart(NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret to the beginning of the current line.

lineEnd

default void lineEnd(NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret to the end of the current line.

start

default void start(NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret to the beginning of the text.

end

default void end(NavigationActions.SelectionPolicy selectionPolicy)

Moves the caret to the end of the text.

selectLine

default void selectLine()

Selects the current line.

selectAll

default void selectAll()

Selects all text in the text input.

deselect

default void deselect()

Clears the selection while keeping the caret position.