org.netbeans.api.editor.caret

Class CaretInfo

java.lang.Object

org.netbeans.api.editor.caret.CaretInfo

public final class CaretInfo
extends Object

Immutable info about a single caret used in caret API - see EditorCaret.
There is one-to-one reference between immutable caret info and mutable CaretItem. CaretItem is not accessible through the caret API and it's managed privately by EditorCaret. Once the caret item gets mutated its corresponding caret info becomes obsolete and new caret info instance gets created lazily.

Since:

2.6

See Also:

EditorCaret

Method Summary

Modifier and Type	Method and Description
int	getDot() Fetches the current position of the caret.
Position.Bias	getDotBias() Get a bias of the dot position which is either Position.Bias.Forward or Position.Bias.Backward depending on whether the caret biases towards the next character or previous one.
Position	getDotPosition() Get position of the caret itself.
Point	getMagicCaretPosition() Gets the current caret visual location.
int	getMark() Fetches the current position of the mark.
Position.Bias	getMarkBias() Get a bias of the mark position which is either Position.Bias.Forward or Position.Bias.Backward depending on whether the caret biases towards the next character or previous one.
Position	getMarkPosition() Return either the same object like CaretInfo.getDotPosition() if there's no selection or return position denoting the other end of an existing selection (which is either before or after the dot position depending of how the selection was created).
int	getSelectionEnd() Returns the selected text's end position.
int	getSelectionStart() Returns the selected text's start position.
boolean	isSelection() Determines if there currently is a selection.
boolean	isSelectionShowing() Determines if the selection is currently visible.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getDotPosition

@CheckForNull
public Position getDotPosition()

Get position of the caret itself.

Returns:

non-null position of the caret placement. The position may be virtual so methods in ComplexPositions may be used if necessary.

getDotBias

@NonNull
public Position.Bias getDotBias()

Get a bias of the dot position which is either Position.Bias.Forward or Position.Bias.Backward depending on whether the caret biases towards the next character or previous one. The bias is always forward for non bidirectional text.

Returns:

either forward or backward bias.

Since:

2.12

getMarkPosition

@CheckForNull
public Position getMarkPosition()

Return either the same object like CaretInfo.getDotPosition() if there's no selection or return position denoting the other end of an existing selection (which is either before or after the dot position depending of how the selection was created).

Returns:

non-null position of the caret placement. The position may be virtual so methods in ComplexPositions may be used if necessary.

getMarkBias

@NonNull
public Position.Bias getMarkBias()

Get a bias of the mark position which is either Position.Bias.Forward or Position.Bias.Backward depending on whether the caret biases towards the next character or previous one. The bias is always forward for non bidirectional text.

Returns:

either forward or backward bias.

Since:

2.12

getDot

public int getDot()

Fetches the current position of the caret.

Returns:

the position >=0

getMark

public int getMark()

Fetches the current position of the mark. If there is a selection, the mark will not be the same as the dot.

Returns:

the position >=0

isSelection

public boolean isSelection()

Determines if there currently is a selection.

Returns:

true if there's a selection or false if there's no selection for this caret.

isSelectionShowing

public boolean isSelectionShowing()

Determines if the selection is currently visible.

Returns:

true if both CaretInfo.isSelection() and EditorCaret.isSelectionVisible() are true.

getSelectionStart

public int getSelectionStart()

Returns the selected text's start position. Return 0 for an empty document, or the value of dot if no selection.

Returns:

the start position ≥ 0

getSelectionEnd

public int getSelectionEnd()

Returns the selected text's end position. Return 0 if the document is empty, or the value of dot if there is no selection.

Returns:

the end position ≥ 0

getMagicCaretPosition

@CheckForNull
public Point getMagicCaretPosition()

Gets the current caret visual location.

Returns:

the visual position.

toString

public String toString()

Overrides:

toString in class Object