Package com.intellij.openapi.editor

Class EditorModificationUtil

java.lang.Object

com.intellij.openapi.editor.EditorModificationUtil

public class EditorModificationUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.String>	READ_ONLY_VIEW_MESSAGE_KEY Deprecated. Use setReadOnlyHint(Editor, String)

Method Summary

Modifier and Type	Method and Description
static int	calcAfterLineEnd(Editor editor) Calculates difference in columns between current editor caret position and end of the logical line fragment displayed on a current visual line.
static java.util.List<CaretState>	calcBlockSelectionState(Editor editor, LogicalPosition blockStart, LogicalPosition blockEnd)
static java.lang.String	calcStringToFillVirtualSpace(Editor editor)
static java.lang.String	calcStringToFillVirtualSpace(Editor editor, int afterLineEnd)
static boolean	checkModificationAllowed(Editor editor)
static void	deleteSelectedText(Editor editor)
static void	deleteSelectedTextForAllCarets(Editor editor)
static java.awt.datatransfer.Transferable	getContentsToPasteToEditor(Producer<? extends java.awt.datatransfer.Transferable> producer)
static java.lang.String	getStringContent(java.awt.datatransfer.Transferable content)
static void	insertStringAtCaret(Editor editor, java.lang.String s)
static int	insertStringAtCaret(Editor editor, java.lang.String s, boolean toProcessOverwriteMode)
static int	insertStringAtCaret(Editor editor, java.lang.String s, boolean toProcessOverwriteMode, boolean toMoveCaret)
static int	insertStringAtCaret(Editor editor, java.lang.String s, boolean toProcessOverwriteMode, boolean toMoveCaret, int caretShift)
static int	insertStringAtCaret(Editor editor, java.lang.String s, boolean toProcessOverwriteMode, int caretShift)
static void	moveAllCaretsRelatively(Editor editor, int caretShift)
static void	moveCaretRelatively(Editor editor, int caretShift)
static void	pasteTransferableAsBlock(Editor editor, java.util.function.Supplier<? extends java.awt.datatransfer.Transferable> producer)
static boolean	requestWriting(Editor editor)
static void	scrollToCaret(Editor editor) This method is safe to run both in and out of CaretModel.runForEachCaret(CaretAction) context.
static void	setReadOnlyHint(Editor editor, java.lang.String message)
static void	setReadOnlyHint(Editor editor, java.lang.String message, javax.swing.event.HyperlinkListener linkListener) Change hint that is displayed on attempt to modify text when editor is in view mode.
static void	typeInStringAtCaretHonorMultipleCarets(Editor editor, java.lang.String str)
static void	typeInStringAtCaretHonorMultipleCarets(Editor editor, java.lang.String str, boolean toProcessOverwriteMode)
static void	typeInStringAtCaretHonorMultipleCarets(Editor editor, java.lang.String str, boolean toProcessOverwriteMode, int caretShift) Inserts given string at each caret's position.
static void	typeInStringAtCaretHonorMultipleCarets(Editor editor, java.lang.String str, int caretShift)
static void	zeroWidthBlockSelectionAtCaretColumn(Editor editor, int startLine, int endLine)

Methods inherited from class java.lang.Object

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

Field Detail

READ_ONLY_VIEW_MESSAGE_KEY

@Deprecated
public static final Key<java.lang.String> READ_ONLY_VIEW_MESSAGE_KEY

Deprecated. Use setReadOnlyHint(Editor, String)

Method Detail

deleteSelectedText

public static void deleteSelectedText(Editor editor)

deleteSelectedTextForAllCarets

public static void deleteSelectedTextForAllCarets(Editor editor)

zeroWidthBlockSelectionAtCaretColumn

public static void zeroWidthBlockSelectionAtCaretColumn(Editor editor,
                                                        int startLine,
                                                        int endLine)

insertStringAtCaret

public static void insertStringAtCaret(Editor editor,
                                       java.lang.String s)

insertStringAtCaret

public static int insertStringAtCaret(Editor editor,
                                      java.lang.String s,
                                      boolean toProcessOverwriteMode)

insertStringAtCaret

public static int insertStringAtCaret(Editor editor,
                                      java.lang.String s,
                                      boolean toProcessOverwriteMode,
                                      boolean toMoveCaret)

insertStringAtCaret

public static int insertStringAtCaret(Editor editor,
                                      java.lang.String s,
                                      boolean toProcessOverwriteMode,
                                      int caretShift)

insertStringAtCaret

public static int insertStringAtCaret(Editor editor,
                                      java.lang.String s,
                                      boolean toProcessOverwriteMode,
                                      boolean toMoveCaret,
                                      int caretShift)

pasteTransferableAsBlock

public static void pasteTransferableAsBlock(Editor editor,
                                            java.util.function.Supplier<? extends java.awt.datatransfer.Transferable> producer)

getContentsToPasteToEditor

public static java.awt.datatransfer.Transferable getContentsToPasteToEditor(Producer<? extends java.awt.datatransfer.Transferable> producer)

getStringContent

public static java.lang.String getStringContent(java.awt.datatransfer.Transferable content)

calcAfterLineEnd

public static int calcAfterLineEnd(Editor editor)

Calculates difference in columns between current editor caret position and end of the logical line fragment displayed on a current visual line.

Parameters:

editor - target editor

Returns:

difference in columns between current editor caret position and end of the logical line fragment displayed on a current visual line

calcStringToFillVirtualSpace

public static java.lang.String calcStringToFillVirtualSpace(Editor editor)

calcStringToFillVirtualSpace

public static java.lang.String calcStringToFillVirtualSpace(Editor editor,
                                                            int afterLineEnd)

typeInStringAtCaretHonorMultipleCarets

public static void typeInStringAtCaretHonorMultipleCarets(Editor editor,
                                                          java.lang.String str)

typeInStringAtCaretHonorMultipleCarets

public static void typeInStringAtCaretHonorMultipleCarets(Editor editor,
                                                          java.lang.String str,
                                                          int caretShift)

typeInStringAtCaretHonorMultipleCarets

public static void typeInStringAtCaretHonorMultipleCarets(Editor editor,
                                                          java.lang.String str,
                                                          boolean toProcessOverwriteMode)

typeInStringAtCaretHonorMultipleCarets

public static void typeInStringAtCaretHonorMultipleCarets(Editor editor,
                                                          java.lang.String str,
                                                          boolean toProcessOverwriteMode,
                                                          int caretShift)
                                                   throws ReadOnlyFragmentModificationException

Inserts given string at each caret's position. Effective caret shift will be equal to caretShift for each caret.

Throws:

ReadOnlyFragmentModificationException

moveAllCaretsRelatively

public static void moveAllCaretsRelatively(Editor editor,
                                           int caretShift)

moveCaretRelatively

public static void moveCaretRelatively(Editor editor,
                                       int caretShift)

scrollToCaret

public static void scrollToCaret(Editor editor)

This method is safe to run both in and out of CaretModel.runForEachCaret(CaretAction) context. It scrolls to primary caret in both cases, and, in the former case, avoids performing excessive scrolling in case of large number of carets.

calcBlockSelectionState

public static java.util.List<CaretState> calcBlockSelectionState(Editor editor,
                                                                 LogicalPosition blockStart,
                                                                 LogicalPosition blockEnd)

requestWriting

public static boolean requestWriting(Editor editor)

checkModificationAllowed

public static boolean checkModificationAllowed(Editor editor)

Returns:

true when not viewer false otherwise, additionally information hint with warning would be shown

setReadOnlyHint

public static void setReadOnlyHint(Editor editor,
                                   java.lang.String message)

See Also:

setReadOnlyHint(Editor, String, HyperlinkListener)

setReadOnlyHint

public static void setReadOnlyHint(Editor editor,
                                   java.lang.String message,
                                   javax.swing.event.HyperlinkListener linkListener)

Change hint that is displayed on attempt to modify text when editor is in view mode.

Parameters:

message - New hint message or null if default message should be used instead.

linkListener - Callback for html hyperlinks that can be used in hint message.