Package com.intellij.openapi.editor.actions

Class EditorActionUtil

java.lang.Object

com.intellij.openapi.editor.actions.EditorActionUtil

public class EditorActionUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	DELETE_COMMAND_GROUP
protected static java.lang.Object	EDIT_COMMAND_GROUP

Method Summary

Modifier and Type	Method and Description
static EditorPopupHandler	createEditorPopupHandler(ActionGroup group) Deprecated. Use EditorEx.setContextMenuGroupId(String) or EditorEx.installPopupHandler(com.intellij.openapi.editor.ex.EditorPopupHandler) instead. To be removed in version 2020.2.
static EditorPopupHandler	createEditorPopupHandler(java.lang.String groupId) Deprecated. Use EditorEx.setContextMenuGroupId(String) or EditorEx.installPopupHandler(com.intellij.openapi.editor.ex.EditorPopupHandler) instead. To be removed in version 2020.2.
static int	findFirstNonSpaceColumnOnTheLine(Editor editor, int visualLineNumber) Tries to find visual column that points to the first non-white space symbol at the visual line at the given editor.
static int	findFirstNonSpaceOffsetInRange(java.lang.CharSequence text, int start, int end) Tries to find non white space symbol at the given range at the given document.
static int	findFirstNonSpaceOffsetOnTheLine(Document document, int lineNumber)
static int	getNextCaretStopOffset(Editor editor, CaretStopPolicy caretStopPolicy, boolean isCamel)
static int	getNextCaretStopOffset(Editor editor, CaretStopPolicy caretStopPolicy, boolean isCamel, boolean handleQuoted)
static int	getNextLineStopOffset(Editor editor, CaretStop lineStop)
static int	getPreviousCaretStopOffset(Editor editor, CaretStopPolicy caretStopPolicy, boolean isCamel)
static int	getPreviousCaretStopOffset(Editor editor, CaretStopPolicy caretStopPolicy, boolean isCamel, boolean handleQuoted)
static int	getPreviousLineStopOffset(Editor editor, CaretStop lineStop)
static TextRange	getRangeToWordEnd(Editor editor, boolean isCamel, boolean handleQuoted)
static TextRange	getRangeToWordStart(Editor editor, boolean isCamel, boolean handleQuoted)
static void	indentLine(Project project, Editor editor, int lineNumber, int indent)
static int	indentLine(Project project, Editor editor, int lineNumber, int indent, int caretOffset)
static boolean	isHumpBound(java.lang.CharSequence text, int offset, boolean isStart)
static boolean	isLexemeBoundary(Editor editor, int offset) Finds out whether there's a boundary between two lexemes of different type at given offset.
static boolean	isWordBoundary(java.lang.CharSequence text, int offset, boolean isCamel, boolean isStart)
static boolean	isWordEnd(java.lang.CharSequence text, int offset, boolean isCamel)
static boolean	isWordOrLexemeEnd(Editor editor, int offset, boolean isCamel)
static boolean	isWordOrLexemeStart(Editor editor, int offset, boolean isCamel)
static boolean	isWordStart(java.lang.CharSequence text, int offset, boolean isCamel)
static void	makePositionVisible(Editor editor, int offset) This method will make required expansions of collapsed region to make given offset 'visible'.
static void	moveCaret(Caret caret, int offset, boolean withSelection)
static void	moveCaretPageBottom(Editor editor, boolean isWithSelection)
static void	moveCaretPageDown(Editor editor, boolean isWithSelection)
static void	moveCaretPageTop(Editor editor, boolean isWithSelection)
static void	moveCaretPageUp(Editor editor, boolean isWithSelection)
static void	moveCaretRelativelyAndScroll(Editor editor, int columnShift, int lineShift, boolean withSelection)
static void	moveCaretToLineEnd(Editor editor, boolean isWithSelection)
static void	moveCaretToLineEnd(Editor editor, boolean isWithSelection, boolean ignoreTrailingWhitespace) Moves caret to visual line end.
static void	moveCaretToLineStart(Editor editor, boolean isWithSelection) Depending on the current caret position and 'smart Home' editor settings, moves caret to the start of current visual line or to the first non-whitespace character on it.
static void	moveCaretToLineStartIgnoringSoftWraps(Editor editor) This method moves caret to the nearest preceding visual line start, which is not a soft line wrap
static void	moveCaretToNextWord(Editor editor, boolean isWithSelection, boolean camel)
static void	moveCaretToPreviousWord(Editor editor, boolean isWithSelection, boolean camel)
static void	moveToNextCaretStop(Editor editor, CaretStopPolicy caretStopPolicy, boolean isWithSelection, boolean isCamel)
static void	moveToPreviousCaretStop(Editor editor, CaretStopPolicy caretStopPolicy, boolean isWithSelection, boolean isCamel)
static void	scrollRelatively(Editor editor, int lineShift, int columnShift, boolean moveCaret) Tries to change given editor's viewport position in vertical dimension by the given number of visual lines.
static void	selectNonexpandableFold(Editor editor)
static boolean	shouldUseSmartTabs(Project project, Editor editor)

Methods inherited from class java.lang.Object

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

Field Detail

EDIT_COMMAND_GROUP

protected static final java.lang.Object EDIT_COMMAND_GROUP

DELETE_COMMAND_GROUP

public static final java.lang.Object DELETE_COMMAND_GROUP

Method Detail

scrollRelatively

public static void scrollRelatively(Editor editor,
                                    int lineShift,
                                    int columnShift,
                                    boolean moveCaret)

Tries to change given editor's viewport position in vertical dimension by the given number of visual lines.

Parameters:

editor - target editor which viewport position should be changed

lineShift - defines viewport position's vertical change length

columnShift - defines viewport position's horizontal change length

moveCaret - flag that identifies whether caret should be moved if its current position becomes off-screen

moveCaretRelativelyAndScroll

public static void moveCaretRelativelyAndScroll(Editor editor,
                                                int columnShift,
                                                int lineShift,
                                                boolean withSelection)

indentLine

public static void indentLine(Project project,
                              Editor editor,
                              int lineNumber,
                              int indent)

indentLine

public static int indentLine(Project project,
                             Editor editor,
                             int lineNumber,
                             int indent,
                             int caretOffset)

shouldUseSmartTabs

public static boolean shouldUseSmartTabs(Project project,
                                         Editor editor)

getRangeToWordEnd

public static TextRange getRangeToWordEnd(Editor editor,
                                          boolean isCamel,
                                          boolean handleQuoted)

getRangeToWordStart

public static TextRange getRangeToWordStart(Editor editor,
                                            boolean isCamel,
                                            boolean handleQuoted)

getNextCaretStopOffset

public static int getNextCaretStopOffset(Editor editor,
                                         CaretStopPolicy caretStopPolicy,
                                         boolean isCamel)

getPreviousCaretStopOffset

public static int getPreviousCaretStopOffset(Editor editor,
                                             CaretStopPolicy caretStopPolicy,
                                             boolean isCamel)

getNextCaretStopOffset

public static int getNextCaretStopOffset(Editor editor,
                                         CaretStopPolicy caretStopPolicy,
                                         boolean isCamel,
                                         boolean handleQuoted)

getPreviousCaretStopOffset

public static int getPreviousCaretStopOffset(Editor editor,
                                             CaretStopPolicy caretStopPolicy,
                                             boolean isCamel,
                                             boolean handleQuoted)

getNextLineStopOffset

public static int getNextLineStopOffset(Editor editor,
                                        CaretStop lineStop)

getPreviousLineStopOffset

public static int getPreviousLineStopOffset(Editor editor,
                                            CaretStop lineStop)

isWordOrLexemeStart

public static boolean isWordOrLexemeStart(Editor editor,
                                          int offset,
                                          boolean isCamel)

isWordOrLexemeEnd

public static boolean isWordOrLexemeEnd(Editor editor,
                                        int offset,
                                        boolean isCamel)

isLexemeBoundary

public static boolean isLexemeBoundary(Editor editor,
                                       int offset)

Finds out whether there's a boundary between two lexemes of different type at given offset.

moveCaretToLineStart

public static void moveCaretToLineStart(Editor editor,
                                        boolean isWithSelection)

Depending on the current caret position and 'smart Home' editor settings, moves caret to the start of current visual line or to the first non-whitespace character on it.

Parameters:

isWithSelection - if true - sets selection from old caret position to the new one, if false - clears selection

See Also:

moveCaretToLineStartIgnoringSoftWraps(Editor)

findFirstNonSpaceColumnOnTheLine

public static int findFirstNonSpaceColumnOnTheLine(Editor editor,
                                                   int visualLineNumber)

Tries to find visual column that points to the first non-white space symbol at the visual line at the given editor.

Parameters:

editor - target editor

visualLineNumber - target visual line

Returns:

visual column that points to the first non-white space symbol at the target visual line if the one exists; '-1' otherwise

findFirstNonSpaceOffsetOnTheLine

public static int findFirstNonSpaceOffsetOnTheLine(Document document,
                                                   int lineNumber)

findFirstNonSpaceOffsetInRange

public static int findFirstNonSpaceOffsetInRange(java.lang.CharSequence text,
                                                 int start,
                                                 int end)

Tries to find non white space symbol at the given range at the given document.

Parameters:

text - text to be inspected

start - target start offset (inclusive)

end - target end offset (exclusive)

Returns:

index of the first non-white space character at the given document at the given range if the one is found; '-1' otherwise

moveCaretToLineEnd

public static void moveCaretToLineEnd(Editor editor,
                                      boolean isWithSelection)

moveCaretToLineEnd

public static void moveCaretToLineEnd(Editor editor,
                                      boolean isWithSelection,
                                      boolean ignoreTrailingWhitespace)

Moves caret to visual line end.

Parameters:

editor - target editor

isWithSelection - whether selection should be set from original caret position to its target position

ignoreTrailingWhitespace - if true, line end will be determined while ignoring trailing whitespace, unless caret is already at so-determined target position, in which case trailing whitespace will be taken into account

moveCaretToNextWord

public static void moveCaretToNextWord(Editor editor,
                                       boolean isWithSelection,
                                       boolean camel)

moveToNextCaretStop

public static void moveToNextCaretStop(Editor editor,
                                       CaretStopPolicy caretStopPolicy,
                                       boolean isWithSelection,
                                       boolean isCamel)

selectNonexpandableFold

public static void selectNonexpandableFold(Editor editor)

moveCaretToPreviousWord

public static void moveCaretToPreviousWord(Editor editor,
                                           boolean isWithSelection,
                                           boolean camel)

moveToPreviousCaretStop

public static void moveToPreviousCaretStop(Editor editor,
                                           CaretStopPolicy caretStopPolicy,
                                           boolean isWithSelection,
                                           boolean isCamel)

moveCaretPageUp

public static void moveCaretPageUp(Editor editor,
                                   boolean isWithSelection)

moveCaretPageDown

public static void moveCaretPageDown(Editor editor,
                                     boolean isWithSelection)

moveCaretPageTop

public static void moveCaretPageTop(Editor editor,
                                    boolean isWithSelection)

moveCaretPageBottom

public static void moveCaretPageBottom(Editor editor,
                                       boolean isWithSelection)

createEditorPopupHandler

@Deprecated
public static EditorPopupHandler createEditorPopupHandler(java.lang.String groupId)

Deprecated. Use EditorEx.setContextMenuGroupId(String) or EditorEx.installPopupHandler(com.intellij.openapi.editor.ex.EditorPopupHandler) instead. To be removed in version 2020.2.

createEditorPopupHandler

@Deprecated
public static EditorPopupHandler createEditorPopupHandler(ActionGroup group)

Deprecated. Use EditorEx.setContextMenuGroupId(String) or EditorEx.installPopupHandler(com.intellij.openapi.editor.ex.EditorPopupHandler) instead. To be removed in version 2020.2.

isWordStart

public static boolean isWordStart(java.lang.CharSequence text,
                                  int offset,
                                  boolean isCamel)

isWordEnd

public static boolean isWordEnd(java.lang.CharSequence text,
                                int offset,
                                boolean isCamel)

isWordBoundary

public static boolean isWordBoundary(java.lang.CharSequence text,
                                     int offset,
                                     boolean isCamel,
                                     boolean isStart)

isHumpBound

public static boolean isHumpBound(java.lang.CharSequence text,
                                  int offset,
                                  boolean isStart)

moveCaretToLineStartIgnoringSoftWraps

public static void moveCaretToLineStartIgnoringSoftWraps(Editor editor)

This method moves caret to the nearest preceding visual line start, which is not a soft line wrap

See Also:

EditorUtil.calcCaretLineRange(Editor), moveCaretToLineStart(Editor, boolean)

makePositionVisible

public static void makePositionVisible(Editor editor,
                                       int offset)

This method will make required expansions of collapsed region to make given offset 'visible'.

moveCaret

public static void moveCaret(Caret caret,
                             int offset,
                             boolean withSelection)