org.netbeans.api.editor.caret

Class CaretMoveContext

java.lang.Object

org.netbeans.api.editor.caret.CaretMoveContext

public final class CaretMoveContext
extends Object

Context for carets moving within CaretMoveHandler.

Since:

2.6

Method Summary

Modifier and Type	Method and Description
JTextComponent	getComponent() Return component in which the caret is currently installed.
Document	getDocument() Get document associated with the text component.
List<CaretInfo>	getOriginalCarets() Get list of carets at the time when transaction started.
CaretInfo	getOriginalLastCaret() Get last item from the list returned by getOriginalCarets().
List<CaretInfo>	getOriginalSortedCarets() Get list of carets at the time when transaction started sorted by dot positions in ascending order.
boolean	moveDot(CaretInfo caret, Position dotPos, Position.Bias dotBias) Move dot of the given caret so caret selection gets created or changed.
boolean	setDot(CaretInfo caret, Position dotPos, Position.Bias dotBias) Change dot of the given caret.
boolean	setDotAndMark(CaretInfo caret, Position dotPos, Position.Bias dotBias, Position markPos, Position.Bias markBias) Move dot of the given caret so caret selection gets created or changed.
boolean	setMagicCaretPosition(CaretInfo caret, Point p) Set magic caret position of the given caret.

Methods inherited from class java.lang.Object

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

Method Detail

getOriginalCarets

@NonNull
public List<CaretInfo> getOriginalCarets()

Get list of carets at the time when transaction started.
Note: information contained in the returned list will not reflect changes performed by the dot/selection modification methods contained in this class. It will always return the original state from the beginning of the move transaction. All the performed modifications will be incorporated at the end of the move transaction.

Returns:

list of carets at the time when moving transaction has started.

getOriginalLastCaret

@NonNull
public CaretInfo getOriginalLastCaret()

Get last item from the list returned by getOriginalCarets().

Returns:

last caret at the time when caret moving transaction has started.

See Also:

getOriginalCarets()

getOriginalSortedCarets

@NonNull
public List<CaretInfo> getOriginalSortedCarets()

Get list of carets at the time when transaction started sorted by dot positions in ascending order.
If some of the carets are ComplexPositions their order will reflect the increasing split offset.
Note: information contained in the returned list will not reflect changes performed by the dot/selection modification methods contained in this class. It will always return the original state from the beginning of the move transaction. All the performed modifications will be incorporated at the end of the move transaction.

Returns:

list of carets at the time when caret moving transaction has started.

setDot

public boolean setDot(@NonNull
                      CaretInfo caret,
                      @NonNull
                      Position dotPos,
                      @NonNull
                      Position.Bias dotBias)

Change dot of the given caret.

Parameters:

caret - non-null caret.

dotPos - new dot position.

Returns:

false if passed caret is obsolete or invalid (e.g. a member of another EditorCaret) or true otherwise.

moveDot

public boolean moveDot(@NonNull
                       CaretInfo caret,
                       @NonNull
                       Position dotPos,
                       @NonNull
                       Position.Bias dotBias)

Move dot of the given caret so caret selection gets created or changed.

Parameters:

caret - non-null caret.

dotPos - new dot position.

Returns:

false if passed caret is obsolete or invalid (e.g. a member of another EditorCaret) or true otherwise.

setDotAndMark

public boolean setDotAndMark(@NonNull
                             CaretInfo caret,
                             @NonNull
                             Position dotPos,
                             @NonNull
                             Position.Bias dotBias,
                             @NonNull
                             Position markPos,
                             @NonNull
                             Position.Bias markBias)

Move dot of the given caret so caret selection gets created or changed.

Parameters:

caret - non-null caret.

dotPos - new dot position.

markPos - starting position of the selection or the same position like dotPos if there should be no selection.
The position may point to a lower offset than dotPos in case the selection should extend from a higher offset to a lower offset.

Returns:

false if passed caret is obsolete or invalid (e.g. a member of another EditorCaret) or true otherwise.

setMagicCaretPosition

public boolean setMagicCaretPosition(@NonNull
                                     CaretInfo caret,
                                     Point p)

Set magic caret position of the given caret.

Parameters:

caret - non-null caret.

p - new magic caret position.

Returns:

false if passed caret is obsolete or invalid (e.g. a member of another EditorCaret) or true otherwise.

getComponent

@NonNull
public JTextComponent getComponent()

Return component in which the caret is currently installed.

Returns:

non-null component in which the caret is installed.

getDocument

public Document getDocument()

Get document associated with the text component.

Returns:

document of the associated component.

See Also:

getComponent()