Modifier and Type	Class and Description
public static enum	NavigationActions.SelectionPolicy Indicates how to treat selection when caret is moved.

Method Summary

Modifier and Type	Method and Description
public default void	deselect() Clears the selection while keeping the caret position.
public default void	end(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the end of the text.
public default void	moveTo(int pos) Moves the caret to the given position in the text and clears any selection.
public default void	moveTo(int the index of the paragraph to which to move the caret paragraphIndex, int the index to the left of which to move the caret columnIndex) Moves the caret to the position returned from `getAbsolutePosition(paragraphIndex, columnIndex)` and clears any selection.
public default void	moveTo(int position, NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the given position.
public default void	moveTo(int paragraphIndex, int columnIndex, NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the position returned from `getAbsolutePosition(paragraphIndex, columnIndex)` using the given selection policy.
public default void	nextChar(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret forward one char in the text.
public default void	paragraphEnd(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the end of the current paragraph.
public default void	paragraphStart(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the beginning of the current paragraph.
public default void	previousChar(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret backward one char in the text.
public default void	selectAll() Selects everything in the area.
public default void	selectParagraph() Selects the current paragraph.
public default void	selectWord() Selects the word closest to the caret
public default void	start(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the beginning of the text.
public default void	wordBreaksBackwards(int n, NavigationActions.SelectionPolicy selectionPolicy) Skips n number of word boundaries backwards.
public default void	wordBreaksForwards(int n, NavigationActions.SelectionPolicy selectionPolicy) Skips n number of word boundaries forward.

Inherited from org.fxmisc.richtext.TextEditingArea:: anchorProperty beingUpdatedProperty caretBoundsProperty caretColumnProperty caretPositionProperty createMultiChange createMultiChange currentParagraphProperty displaceCaret dispose getAbsolutePosition getAnchor getCaretBounds getCaretColumn getCaretPosition getCaretSelectionBind getContent getCurrentParagraph getDocument getLength getLocale getParagraph getParagraphLength getParagraphs getParagraphSelection getParagraphSelection getSegOps getSelectedText getSelection getSelectionBounds getShowCaret getText getText getText getText getText isBeingUpdated lengthProperty multiPlainChanges multiRichChanges plainTextChanges replace replace replace replace replace replace replaceText replaceText replaceText richChanges selectedTextProperty selectionBoundsProperty selectionProperty selectRange selectRange setShowCaret showCaretProperty subDocument subDocument subDocument subDocument textProperty

Method Detail

deselect	back to summary
public default void deselect() Clears the selection while keeping the caret position.

end	back to summary
public default void end(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the end of the text.

moveTo	back to summary
public default void moveTo(int pos) Moves the caret to the given position in the text and clears any selection.

moveTo back to summary

moveTo	back to summary
public 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 `getAbsolutePosition(int, int)` to know how the column index argument can affect the returned position. Parameters paragraphIndex:int the index of the paragraph to which to move the caret columnIndex:int the index to the left of which to move the caret

public 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 getAbsolutePosition(int, int) to know how the column index argument can affect the returned position.

Parameters

paragraphIndex:int: the index of the paragraph to which to move the caret
columnIndex:int: the index to the left of which to move the caret

moveTo	back to summary
public default void moveTo(int position, NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the given position.

moveTo	back to summary
public default void moveTo(int paragraphIndex, int columnIndex, NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the position returned from `getAbsolutePosition(paragraphIndex, columnIndex)` using the given selection policy. Caution see `getAbsolutePosition(int, int)` to know how the column index argument can affect the returned position.

nextChar	back to summary
public default void nextChar(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret forward one char in the text.

paragraphEnd	back to summary
public default void paragraphEnd(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the end of the current paragraph.

paragraphStart	back to summary
public default void paragraphStart(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the beginning of the current paragraph.

previousChar	back to summary
public default void previousChar(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret backward one char in the text.

selectAll	back to summary
public default void selectAll() Selects everything in the area.

selectParagraph	back to summary
public default void selectParagraph() Selects the current paragraph.

selectWord	back to summary
public default void selectWord() Selects the word closest to the caret

start	back to summary
public default void start(NavigationActions.SelectionPolicy selectionPolicy) Moves the caret to the beginning of the text.

wordBreaksBackwards	back to summary
public default void wordBreaksBackwards(int n, NavigationActions.SelectionPolicy selectionPolicy) Skips n number of word boundaries backwards.

wordBreaksForwards	back to summary
public default void wordBreaksForwards(int n, NavigationActions.SelectionPolicy selectionPolicy) Skips n number of word boundaries forward.

org.fxmisc.richtext back to summary

public final Enum NavigationActions.SelectionPolicy

Class Inheritance

extends Enum<NavigationActions.SelectionPolicy>

java.lang.Object
java.lang.Enum
org.fxmisc.richtext.NavigationActions.SelectionPolicy

Indicates how to treat selection when caret is moved.

Field Summary

Modifier and Type	Field and Description
public static final NavigationActions.SelectionPolicy	ADJUST Moves the caret only without also moving the anchor, thereby making a selection
public static final NavigationActions.SelectionPolicy	CLEAR Move the caret and anchor to the same given position, thereby clearing any existing selection
public static final NavigationActions.SelectionPolicy	EXTEND Extends the selection by updating the "boundary" of the selection that is closest to the new position (i.e. either the selection's start or end position) to that new position and keeping the other position the same.

Constructor Summary

Access	Constructor and Description
private	SelectionPolicy()

Method Summary

Modifier and Type	Method and Description
public static NavigationActions.SelectionPolicy	valueOf(String name)
public static NavigationActions.SelectionPolicy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ADJUST	back to summary
public static final NavigationActions.SelectionPolicy ADJUST Moves the caret only without also moving the anchor, thereby making a selection

CLEAR	back to summary
public static final NavigationActions.SelectionPolicy CLEAR Move the caret and anchor to the same given position, thereby clearing any existing selection

EXTEND back to summary

EXTEND	back to summary
public static final NavigationActions.SelectionPolicy EXTEND Extends the selection by updating the "boundary" of the selection that is closest to the new position (i.e. either the selection's start or end position) to that new position and keeping the other position the same. In either case, the caret position is updated to that new position while the anchor is updated to the opposite boundary. Using the following example, where "\|\|" is the anchor, "\|" is the caret" and "_" is the new position, EXTEND updates the values to: `"A text \|\|with\| a _selection" -> "A text \|\|with a \|selection" "A _text \|\|with\| a selection" -> "A \|text with\|\| a selection"`

public static final NavigationActions.SelectionPolicy EXTEND

Extends the selection by updating the "boundary" of the selection that is closest to the new position (i.e. either the selection's start or end position) to that new position and keeping the other position the same. In either case, the caret position is updated to that new position while the anchor is updated to the opposite boundary.

Using the following example, where "||" is the anchor, "|" is the caret" and "_" is the new position, EXTEND updates the values to:


"A text ||with| a _selection" -> "A text ||with a |selection"
"A _text ||with| a selection" -> "A |text with|| a selection"

Constructor Detail

SelectionPolicy	back to summary
private SelectionPolicy()

Method Detail

valueOf	back to summary
public static NavigationActions.SelectionPolicy valueOf(String name)

values	back to summary
public static NavigationActions.SelectionPolicy[] values()

public Interface NavigationActions<PS, SEG, S>

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum NavigationActions.SelectionPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail