An object for encapsulating a caret in a given area.

"Position" refers to the place in-between characters. In other words, every "|" in "|t|e|x|t|" is a valid position. There are two kinds of positions used here:

getPosition(), which refers to a position somewhere in the entire area's content. It's bounds are 0 <= x <= area.getLength().
getColumnPosition(), which refers to a position somewhere in the current paragraph. It's bounds are 0 <= x <= area.getParagraphLength(index).

Note: when parameter names are "position" without the "column" prefix, they refer to the position in the entire area.

"Line" refers either to a single paragraph when the area does not wrap its text or to a line on a multi-line paragraph when the area does wrap its text.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Caret.CaretVisibility Determines whether the caret is visible.

Method Summary

Modifier and Type	Method and Description
public ObservableValue<Boolean>	beingUpdatedProperty()
public ObservableValue<Duration>	blinkRateProperty()
public ObservableValue<Optional<Bounds>>	caretBoundsProperty() The selectionBoundsProperty of the caret in the Screen's coordinate system or `Optional#empty()` if caret is not visible in the viewport.
public void	clearTargetOffset() Clears the caret's x offset
public ObservableValue<Integer>	columnPositionProperty() The column position of the caret on its given line
public void	dispose() Disposes the caret and prevents memory leaks
public GenericStyledArea<?, ?, ?>	getArea() Gets the area with which this caret is associated.
public Duration	getBlinkRate()
public Optional<Bounds>	getCaretBounds()
public String	getCaretName() Gets the name of this caret.
public int	getColumnPosition()
public OptionalInt	getLineIndex()
public int	getParagraphIndex()
public int	getPosition()
public Caret.CaretVisibility	getShowCaret()
public ParagraphBox.CaretOffsetX	getTargetOffset() Stores the caret's current column position, so that moving the caret vertically will keep it close to its original offset in a line.
public boolean	isBeingUpdated()
public boolean	isVisible()
public ObservableValue<OptionalInt>	lineIndexProperty() The line index of a multi-line paragraph that contains this caret
public void	moveBreaksBackwards(int numOfBreaks, BreakIterator breakIterator) Moves the caret backwards by the number of breaks.
public void	moveBreaksForwards(int numOfBreaks, BreakIterator breakIterator) Moves the caret forwards by the number of breaks.
public default void	moveSentenceBreaksBackwards(int numOfSentenceBreaks)
public default void	moveSentenceBreaksForwards(int numOfSentenceBreaks)
public void	moveTo(int paragraphIndex, int columnPosition) Moves the caret to the given position in the area.
public void	moveTo(int position) Moves the caret to the given position in the area.
public void	moveToAreaEnd() Moves the caret to the end of the area.
public default void	moveToAreaStart() Moves the caret to the beginning of the area.
public void	moveToNextChar() Moves the caret forward one char in the text.
public void	moveToParEnd() Moves the caret to the end of the current paragraph.
public void	moveToParStart() Moves the caret to the beginning of the current paragraph.
public void	moveToPrevChar() Moves the caret backward one char in the text.
public default void	moveWordBreaksBackwards(int numOfWordBreaks)
public default void	moveWordBreaksForwards(int numOfWordBreaks)
public ObservableValue<Integer>	paragraphIndexProperty() The paragraph index that contains this caret
public ObservableValue<Integer>	positionProperty() The position of the caret within the text
public void	setBlinkRate(Duration blinkRate)
public void	setShowCaret(Caret.CaretVisibility value)
public Var<Caret.CaretVisibility>	showCaretProperty() Whether to display the caret or not.
public ObservableValue<Boolean>	visibleProperty() Whether the caret is being shown in the viewport

Method Detail

beingUpdatedProperty	back to summary
public ObservableValue<Boolean> beingUpdatedProperty()

blinkRateProperty	back to summary
public ObservableValue<Duration> blinkRateProperty()

caretBoundsProperty	back to summary
public ObservableValue<Optional<Bounds>> caretBoundsProperty() The selectionBoundsProperty of the caret in the Screen's coordinate system or `Optional#empty()` if caret is not visible in the viewport.

clearTargetOffset	back to summary
public void clearTargetOffset() Clears the caret's x offset

columnPositionProperty	back to summary
public ObservableValue<Integer> columnPositionProperty() The column position of the caret on its given line

dispose	back to summary
public void dispose() Disposes the caret and prevents memory leaks

getArea	back to summary
public GenericStyledArea<?, ?, ?> getArea() Gets the area with which this caret is associated.

getBlinkRate	back to summary
public Duration getBlinkRate()

getCaretBounds	back to summary
public Optional<Bounds> getCaretBounds()

getCaretName	back to summary
public String getCaretName() Gets the name of this caret. Each caret that is added to an area must have a unique name since it is used to distinguish it from others in a Set.

getColumnPosition	back to summary
public int getColumnPosition()

getLineIndex	back to summary
public OptionalInt getLineIndex()

getParagraphIndex	back to summary
public int getParagraphIndex()

getPosition	back to summary
public int getPosition()

getShowCaret	back to summary
public Caret.CaretVisibility getShowCaret()

getTargetOffset	back to summary
public ParagraphBox.CaretOffsetX getTargetOffset() Stores the caret's current column position, so that moving the caret vertically will keep it close to its original offset in a line.

isBeingUpdated	back to summary
public boolean isBeingUpdated()

isVisible	back to summary
public boolean isVisible()

lineIndexProperty	back to summary
public ObservableValue<OptionalInt> lineIndexProperty() The line index of a multi-line paragraph that contains this caret

moveBreaksBackwards	back to summary
public void moveBreaksBackwards(int numOfBreaks, BreakIterator breakIterator) Moves the caret backwards by the number of breaks.

moveBreaksForwards	back to summary
public void moveBreaksForwards(int numOfBreaks, BreakIterator breakIterator) Moves the caret forwards by the number of breaks.

moveSentenceBreaksBackwards	back to summary
public default void moveSentenceBreaksBackwards(int numOfSentenceBreaks)

moveSentenceBreaksForwards	back to summary
public default void moveSentenceBreaksForwards(int numOfSentenceBreaks)

moveTo back to summary

moveTo	back to summary
public void moveTo(int paragraphIndex, int columnPosition) Moves the caret to the given position in the area. If this caret is bound to a `CaretSelectionBind`, it displaces the caret from the selection by positioning only the caret to the new location without also affecting the `CaretSelectionBind#getAnchorPosition()` bounded selection's anchor} or the `CaretSelectionBind#getRange()` selection}. This method 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. Caution see `TextEditingArea#getAbsolutePosition(int, int)` to know how the column index argument can affect the returned position.

public void moveTo(int paragraphIndex, int columnPosition)

Moves the caret to the given position in the area. If this caret is bound to a CaretSelectionBind, it displaces the caret from the selection by positioning only the caret to the new location without also affecting the CaretSelectionBind#getAnchorPosition() bounded selection's anchor} or the CaretSelectionBind#getRange() selection}.
This method 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.

Caution

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

moveTo back to summary

moveTo	back to summary
public void moveTo(int position) Moves the caret to the given position in the area. If this caret is bound to a `CaretSelectionBind`, it displaces the caret from the selection by positioning only the caret to the new location without also affecting the `CaretSelectionBind#getAnchorPosition()` bounded selection's anchor} or the `CaretSelectionBind#getRange()` selection}. This method 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.

public void moveTo(int position)

moveToAreaEnd	back to summary
public void moveToAreaEnd() Moves the caret to the end of the area.

moveToAreaStart	back to summary
public default void moveToAreaStart() Moves the caret to the beginning of the area.

moveToNextChar	back to summary
public void moveToNextChar() Moves the caret forward one char in the text.

moveToParEnd	back to summary
public void moveToParEnd() Moves the caret to the end of the current paragraph.

moveToParStart	back to summary
public void moveToParStart() Moves the caret to the beginning of the current paragraph.

moveToPrevChar	back to summary
public void moveToPrevChar() Moves the caret backward one char in the text.

moveWordBreaksBackwards	back to summary
public default void moveWordBreaksBackwards(int numOfWordBreaks)

moveWordBreaksForwards	back to summary
public default void moveWordBreaksForwards(int numOfWordBreaks)

paragraphIndexProperty	back to summary
public ObservableValue<Integer> paragraphIndexProperty() The paragraph index that contains this caret

positionProperty	back to summary
public ObservableValue<Integer> positionProperty() The position of the caret within the text

setBlinkRate	back to summary
public void setBlinkRate(Duration blinkRate)

setShowCaret	back to summary
public void setShowCaret(Caret.CaretVisibility value)

showCaretProperty	back to summary
public Var<Caret.CaretVisibility> showCaretProperty() Whether to display the caret or not. Default value is `CaretVisibility#AUTO`.

visibleProperty	back to summary
public ObservableValue<Boolean> visibleProperty() Whether the caret is being shown in the viewport

org.fxmisc.richtext back to summary

public final Enum Caret.CaretVisibility

Class Inheritance

extends Enum<Caret.CaretVisibility>

java.lang.Object
java.lang.Enum
org.fxmisc.richtext.Caret.CaretVisibility

Determines whether the caret is visible. Those who wish to use the default configuration should use AUTO while those who want a more custom configuration should make a caret's CaretVisibility value oscillate between ON and OFF.

Field Summary

Modifier and Type	Field and Description
public static final Caret.CaretVisibility	AUTO Caret is displayed when area is focused, enabled, and editable.
public static final Caret.CaretVisibility	OFF Caret is not displayed.
public static final Caret.CaretVisibility	ON Caret is displayed.

Constructor Summary

Access	Constructor and Description
private	CaretVisibility()

Method Summary

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

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

Field Detail

AUTO	back to summary
public static final Caret.CaretVisibility AUTO Caret is displayed when area is focused, enabled, and editable.

OFF	back to summary
public static final Caret.CaretVisibility OFF Caret is not displayed.

ON	back to summary
public static final Caret.CaretVisibility ON Caret is displayed.

Constructor Detail

CaretVisibility	back to summary
private CaretVisibility()

Method Detail

valueOf	back to summary
public static Caret.CaretVisibility valueOf(String name)

values	back to summary
public static Caret.CaretVisibility[] values()

public Interface Caret

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Caret.CaretVisibility

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail