Package com.intellij.psi.impl.source.tree.injected

Class InjectedCaret

java.lang.Object

com.intellij.psi.impl.source.tree.injected.InjectedCaret

All Implemented Interfaces:

Disposable, Caret, UserDataHolder, UserDataHolderEx

public class InjectedCaret
extends java.lang.Object
implements Caret

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
Caret	clone(boolean above) Clones the current caret and positions the new one right above or below the current one.
void	dispose() Usually not invoked directly, see class javadoc.
CaretModel	getCaretModel() Returns an instance of CaretModel, current caret is associated with.
Caret	getDelegate()
Editor	getEditor() Returns an instance of Editor, current caret belongs to.
int	getLeadSelectionOffset() Returns the offset from which the user started to extend the selection (the selection start if the selection was extended in forward direction, or the selection end if it was extended backward).
VisualPosition	getLeadSelectionPosition()
LogicalPosition	getLogicalPosition() Returns the logical position of the caret.
int	getOffset() Returns the offset of the caret in the document.
java.lang.String	getSelectedText() Returns the text selected in the editor.
int	getSelectionEnd() Returns the end offset in the document of the selected text range, or the caret position if there is currently no selection.
VisualPosition	getSelectionEndPosition()
int	getSelectionStart() Returns the start offset in the document of the selected text range, or the caret position if there is currently no selection.
VisualPosition	getSelectionStartPosition()
<T> T	getUserData(Key<T> key)
CaretVisualAttributes	getVisualAttributes() Returns visual attributes currently set for the caret.
int	getVisualLineEnd()
int	getVisualLineStart()
VisualPosition	getVisualPosition() Returns the visual position of the caret.
boolean	hasSelection() Checks if a range of text is currently selected.
boolean	isAtBidiRunBoundary() Returns true if caret is located at a boundary between different runs of bidirectional text.
boolean	isAtRtlLocation() Returns true if caret is located in RTL text fragment.
boolean	isUpToDate() Caret position may be updated on document change (e.g.
boolean	isValid() Tells whether this caret is valid, i.e.
void	moveCaretRelatively(int columnShift, int lineShift, boolean withSelection, boolean scrollToCaret) Moves the caret by the specified number of lines and/or columns.
void	moveToLogicalPosition(LogicalPosition pos) Moves the caret to the specified logical position.
void	moveToOffset(int offset) Short hand for calling Caret.moveToOffset(int, boolean) with 'false' as a second argument.
void	moveToOffset(int offset, boolean locateBeforeSoftWrap) Moves the caret to the specified offset in the document.
void	moveToVisualPosition(VisualPosition pos) Moves the caret to the specified visual position.
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
<T> T	putUserDataIfAbsent(Key<T> key, T value)
void	removeSelection() Removes the selection in the editor.
<T> boolean	replace(Key<T> key, T oldValue, T newValue) Replaces (atomically) old value in the map with the new one
void	selectLineAtCaret() Selects the entire line of text at the caret position.
void	selectWordAtCaret(boolean honorCamelWordsSettings) Selects the entire word at the caret position, optionally using camel-case rules to determine word boundaries.
void	setSelection(int startOffset, int endOffset) Selects the specified range of text.
void	setSelection(int startOffset, int endOffset, boolean updateSystemSelection) Selects the specified range of text.
void	setSelection(int startOffset, VisualPosition endPosition, int endOffset) Selects target range providing information about visual boundary of selection end.
void	setSelection(VisualPosition startPosition, int startOffset, VisualPosition endPosition, int endOffset) Selects target range based on its visual boundaries.
void	setSelection(VisualPosition startPosition, int startOffset, VisualPosition endPosition, int endOffset, boolean updateSystemSelection) Selects target range based on its visual boundaries.
void	setVisualAttributes(CaretVisualAttributes attributes) Sets caret's current visual attributes.

Methods inherited from class java.lang.Object

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

Method Detail

getEditor

public Editor getEditor()

Description copied from interface: Caret

Returns an instance of Editor, current caret belongs to.

Specified by:

getEditor in interface Caret

getCaretModel

public CaretModel getCaretModel()

Description copied from interface: Caret

Returns an instance of CaretModel, current caret is associated with.

Specified by:

getCaretModel in interface Caret

getDelegate

public Caret getDelegate()

isValid

public boolean isValid()

Description copied from interface: Caret

Tells whether this caret is valid, i.e. recognized by the caret model currently. Caret is valid since its creation till its removal from caret model.

Specified by:

isValid in interface Caret

See Also:

CaretModel.addCaret(VisualPosition), CaretModel.removeCaret(Caret)

moveCaretRelatively

public void moveCaretRelatively(int columnShift,
                                int lineShift,
                                boolean withSelection,
                                boolean scrollToCaret)

Description copied from interface: Caret

Moves the caret by the specified number of lines and/or columns.

Specified by:

moveCaretRelatively in interface Caret

Parameters:

columnShift - the number of columns to move the caret by.

lineShift - the number of lines to move the caret by.

withSelection - if true, the caret move should extend the selection in the document.

scrollToCaret - if true, the document should be scrolled so that the caret is visible after the move.

moveToLogicalPosition

public void moveToLogicalPosition(LogicalPosition pos)

Description copied from interface: Caret

Moves the caret to the specified logical position. If corresponding position is in the folded region currently, the region will be expanded.

Specified by:

moveToLogicalPosition in interface Caret

Parameters:

pos - the position to move to.

moveToVisualPosition

public void moveToVisualPosition(VisualPosition pos)

Description copied from interface: Caret

Moves the caret to the specified visual position.

Specified by:

moveToVisualPosition in interface Caret

Parameters:

pos - the position to move to.

moveToOffset

public void moveToOffset(int offset)

Description copied from interface: Caret

Short hand for calling Caret.moveToOffset(int, boolean) with 'false' as a second argument.

Specified by:

moveToOffset in interface Caret

Parameters:

offset - the offset to move to

moveToOffset

public void moveToOffset(int offset,
                         boolean locateBeforeSoftWrap)

Description copied from interface: Caret

Moves the caret to the specified offset in the document. If corresponding position is in the folded region currently, the region will be expanded.

Specified by:

moveToOffset in interface Caret

Parameters:

offset - the offset to move to.

locateBeforeSoftWrap - there is a possible case that there is a soft wrap at the given offset, hence, the same offset corresponds to two different visual positions - just before soft wrap and just after soft wrap. We may want to clearly indicate where to put the caret then. Given parameter allows to do that. Note: it's ignored if there is no soft wrap at the given offset

isUpToDate

public boolean isUpToDate()

Description copied from interface: Caret

Caret position may be updated on document change (e.g. consider that user updates from VCS that causes addition of text before caret. Caret offset, visual and logical positions should be updated then). So, there is a possible case that caret model in in the process of caret position update now.

Current method allows to check that.

Specified by:

isUpToDate in interface Caret

Returns:

true if caret position is up-to-date for now; false otherwise

getLogicalPosition

public LogicalPosition getLogicalPosition()

Description copied from interface: Caret

Returns the logical position of the caret.

Specified by:

getLogicalPosition in interface Caret

Returns:

the caret position.

getVisualPosition

public VisualPosition getVisualPosition()

Description copied from interface: Caret

Returns the visual position of the caret.

Specified by:

getVisualPosition in interface Caret

Returns:

the caret position.

getOffset

public int getOffset()

Description copied from interface: Caret

Returns the offset of the caret in the document. Returns 0 for a disposed (invalid) caret.

Specified by:

getOffset in interface Caret

Returns:

the caret offset.

See Also:

Caret.isValid()

getVisualLineStart

public int getVisualLineStart()

Specified by:

getVisualLineStart in interface Caret

Returns:

document offset for the start of the visual line where caret is located

getVisualLineEnd

public int getVisualLineEnd()

Specified by:

getVisualLineEnd in interface Caret

Returns:

document offset that points to the first symbol shown at the next visual line after the one with caret on it

getSelectionStart

public int getSelectionStart()

Description copied from interface: Caret

Returns the start offset in the document of the selected text range, or the caret position if there is currently no selection.

Specified by:

getSelectionStart in interface Caret

Returns:

the selection start offset.

getSelectionStartPosition

public VisualPosition getSelectionStartPosition()

Specified by:

getSelectionStartPosition in interface Caret

Returns:

object that encapsulates information about visual position of selected text start if any

getSelectionEnd

public int getSelectionEnd()

Description copied from interface: Caret

Returns the end offset in the document of the selected text range, or the caret position if there is currently no selection.

Specified by:

getSelectionEnd in interface Caret

Returns:

the selection end offset.

getSelectionEndPosition

public VisualPosition getSelectionEndPosition()

Specified by:

getSelectionEndPosition in interface Caret

Returns:

object that encapsulates information about visual position of selected text end if any;

getSelectedText

public java.lang.String getSelectedText()

Description copied from interface: Caret

Returns the text selected in the editor.

Specified by:

getSelectedText in interface Caret

Returns:

the selected text, or null if there is currently no selection.

getLeadSelectionOffset

public int getLeadSelectionOffset()

Description copied from interface: Caret

Returns the offset from which the user started to extend the selection (the selection start if the selection was extended in forward direction, or the selection end if it was extended backward).

Specified by:

getLeadSelectionOffset in interface Caret

Returns:

the offset from which the selection was started, or the caret offset if there is currently no selection.

getLeadSelectionPosition

public VisualPosition getLeadSelectionPosition()

Specified by:

getLeadSelectionPosition in interface Caret

Returns:

object that encapsulates information about visual position from which the user started to extend the selection if any

hasSelection

public boolean hasSelection()

Description copied from interface: Caret

Checks if a range of text is currently selected.

Specified by:

hasSelection in interface Caret

Returns:

true if a range of text is selected, false otherwise.

setSelection

public void setSelection(int startOffset,
                         int endOffset)

Description copied from interface: Caret

Selects the specified range of text.

System selection will be updated, if such feature is supported by current editor.

Specified by:

setSelection in interface Caret

Parameters:

startOffset - the start offset of the text range to select.

endOffset - the end offset of the text range to select.

setSelection

public void setSelection(int startOffset,
                         int endOffset,
                         boolean updateSystemSelection)

Description copied from interface: Caret

Selects the specified range of text.

Specified by:

setSelection in interface Caret

Parameters:

startOffset - the start offset of the text range to select.

endOffset - the end offset of the text range to select.

updateSystemSelection - whether system selection should be updated (might not have any effect if current editor doesn't support such a feature)

setSelection

public void setSelection(int startOffset,
                         VisualPosition endPosition,
                         int endOffset)

Description copied from interface: Caret

Selects target range providing information about visual boundary of selection end.

That is the case for soft wraps-aware processing where the whole soft wraps virtual space is matched to the same offset.

Also, in column mode this method allows to create selection spanning virtual space after the line end.

System selection will be updated, if such feature is supported by current editor.

Specified by:

setSelection in interface Caret

Parameters:

startOffset - start selection offset

endPosition - end visual position of the text range to select (null argument means that no specific visual position should be used)

endOffset - end selection offset

setSelection

public void setSelection(VisualPosition startPosition,
                         int startOffset,
                         VisualPosition endPosition,
                         int endOffset)

Description copied from interface: Caret

Selects target range based on its visual boundaries.

That is the case for soft wraps-aware processing where the whole soft wraps virtual space is matched to the same offset.

Also, in column mode this method allows to create selection spanning virtual space after the line end.

System selection will be updated, if such feature is supported by current editor.

Specified by:

setSelection in interface Caret

Parameters:

startPosition - start visual position of the text range to select (null argument means that no specific visual position should be used)

startOffset - start selection offset

endPosition - end visual position of the text range to select (null argument means that no specific visual position should be used)

endOffset - end selection offset

setSelection

public void setSelection(VisualPosition startPosition,
                         int startOffset,
                         VisualPosition endPosition,
                         int endOffset,
                         boolean updateSystemSelection)

Description copied from interface: Caret

Selects target range based on its visual boundaries.

That is the case for soft wraps-aware processing where the whole soft wraps virtual space is matched to the same offset.

Also, in column mode this method allows to create selection spanning virtual space after the line end.

Specified by:

setSelection in interface Caret

Parameters:

startPosition - start visual position of the text range to select (null argument means that no specific visual position should be used)

startOffset - start selection offset

endPosition - end visual position of the text range to select (null argument means that no specific visual position should be used)

endOffset - end selection offset

updateSystemSelection - whether system selection should be updated (might not have any effect if current editor doesn't support such a feature)

removeSelection

public void removeSelection()

Description copied from interface: Caret

Removes the selection in the editor.

Specified by:

removeSelection in interface Caret

selectLineAtCaret

public void selectLineAtCaret()

Description copied from interface: Caret

Selects the entire line of text at the caret position.

Specified by:

selectLineAtCaret in interface Caret

selectWordAtCaret

public void selectWordAtCaret(boolean honorCamelWordsSettings)

Description copied from interface: Caret

Selects the entire word at the caret position, optionally using camel-case rules to determine word boundaries.

Specified by:

selectWordAtCaret in interface Caret

Parameters:

honorCamelWordsSettings - if true and "Use CamelHumps words" is enabled, upper-case letters within the word are considered as boundaries for the range of text to select.

clone

public Caret clone(boolean above)

Description copied from interface: Caret

Clones the current caret and positions the new one right above or below the current one. If current caret has selection, corresponding selection will be set for the new caret.

Specified by:

clone in interface Caret

Parameters:

above - if true, new caret will be created at the previous line, if false - on the next line

Returns:

newly created caret instance, or null if the caret cannot be created because it already exists at the new location or caret model doesn't support multiple carets.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

putUserDataIfAbsent

public <T> T putUserDataIfAbsent(Key<T> key,
                                 T value)

Specified by:

putUserDataIfAbsent in interface UserDataHolderEx

Returns:

written or already existing value

replace

public <T> boolean replace(Key<T> key,
                           T oldValue,
                           T newValue)

Description copied from interface: UserDataHolderEx

Replaces (atomically) old value in the map with the new one

Specified by:

replace in interface UserDataHolderEx

Returns:

true if old value got replaced, false otherwise

See Also:

ConcurrentMap.replace(Object, Object, Object)

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

isAtRtlLocation

public boolean isAtRtlLocation()

Description copied from interface: Caret

Returns true if caret is located in RTL text fragment. In that case visual column number is inversely related to offset and logical column number in the vicinity of caret.

Specified by:

isAtRtlLocation in interface Caret

isAtBidiRunBoundary

public boolean isAtBidiRunBoundary()

Description copied from interface: Caret

Returns true if caret is located at a boundary between different runs of bidirectional text. This means that text fragments at different sides of the boundary are non-adjacent in logical order. Caret can located at any side of the boundary, exact location can be determined from directionality flags of caret's logical and visual position (LogicalPosition.leansForward and VisualPosition.leansRight).

Specified by:

isAtBidiRunBoundary in interface Caret

getVisualAttributes

public CaretVisualAttributes getVisualAttributes()

Description copied from interface: Caret

Returns visual attributes currently set for the caret.

Specified by:

getVisualAttributes in interface Caret

See Also:

Caret.setVisualAttributes(CaretVisualAttributes)

setVisualAttributes

public void setVisualAttributes(CaretVisualAttributes attributes)

Description copied from interface: Caret

Sets caret's current visual attributes. This can have no effect if editor doesn't support changing caret's visual appearance.

Specified by:

setVisualAttributes in interface Caret

See Also:

Caret.getVisualAttributes()