Package com.intellij.codeInsight.editorActions

Interface TabOutScopesTracker

All Known Implementing Classes:

TabOutScopesTrackerImpl

public interface TabOutScopesTracker

This service keeps track of scopes inside quotes or brackets in editor, which user can exit (moving caret just to the right of closing quote/bracket) using Tab key. The scope is usually created (registered) when a pair of quotes/brackets is inserted into a document, and lives until user 'tabs out' of this scope, or performs editing outside it.

Method Summary

Modifier and Type	Method and Description
static TabOutScopesTracker	getInstance()
boolean	hasScopeEndingAt(Editor editor, int offset) Checks whether given offset is at the end of tracked scope (so if caret is located at that offset, Tab key can be used to move out of the scope).
default void	registerEmptyScope(Editor editor, int offset) Registers a new scope (empty at the time of call) at the given offset.
void	registerEmptyScope(Editor editor, int offset, int tabOutOffset) Same as registerEmptyScope(Editor, int) but allows to set custom caret shift on exiting the scope.
default void	registerEmptyScopeAtCaret(Editor editor) Registers a new scope (empty at the time of call) at caret offset.
int	removeScopeEndingAt(Editor editor, int offset) Removes a tracked scope (if any) ending at the given offset.

Method Detail

getInstance

static TabOutScopesTracker getInstance()

registerEmptyScopeAtCaret

default void registerEmptyScopeAtCaret(Editor editor)

Registers a new scope (empty at the time of call) at caret offset. Caret is supposed to be located between just inserted pair of quotes/brackets.

registerEmptyScope

default void registerEmptyScope(Editor editor,
                                int offset)

Registers a new scope (empty at the time of call) at the given offset. Provided offset is supposed to point at the location between just inserted pair of quotes/brackets.

registerEmptyScope

void registerEmptyScope(Editor editor,
                        int offset,
                        int tabOutOffset)

Same as registerEmptyScope(Editor, int) but allows to set custom caret shift on exiting the scope. This is for the cases when scope suffix contains more than one character (e.g. a closing parenthesis and a semicolon).

Parameters:

tabOutOffset - position where caret should be moved when Tab is used to exit the scope (should be larger than offset)

hasScopeEndingAt

boolean hasScopeEndingAt(Editor editor,
                         int offset)

Checks whether given offset is at the end of tracked scope (so if caret is located at that offset, Tab key can be used to move out of the scope).

removeScopeEndingAt

int removeScopeEndingAt(Editor editor,
                        int offset)

Removes a tracked scope (if any) ending at the given offset.

Returns:

target caret position where caret should be moved, if there was a scope ending at given offset, and -1 otherwise

See Also:

hasScopeEndingAt(Editor, int), registerEmptyScope(Editor, int, int)