Package com.intellij.openapi.editor

Class EditorCopyPasteHelper

java.lang.Object

com.intellij.openapi.editor.EditorCopyPasteHelper

Direct Known Subclasses:

EditorCopyPasteHelperImpl

public abstract class EditorCopyPasteHelper
extends java.lang.Object

Support for data transfer between editor and clipboard.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorCopyPasteHelper.TooLargeContentException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TRIM_TEXT_ON_PASTE_KEY Setup JTextComponent.getDocument().putProperty(TRIM_TEXT_ON_PASTE_KEY, Boolean.TRUE) to trim text that is being pasted

Constructor Summary

Constructors

Constructor and Description
EditorCopyPasteHelper()

Method Summary

Modifier and Type	Method and Description
abstract void	copySelectionToClipboard(Editor editor) Copies text selected in editor to clipboard.
static EditorCopyPasteHelper	getInstance()
abstract TextRange []	pasteFromClipboard(Editor editor) Pastes from clipboard into editor at caret(s) position.
abstract TextRange []	pasteTransferable(Editor editor, java.awt.datatransfer.Transferable content) Pastes given Transferable instance into editor at caret(s) position.

Methods inherited from class java.lang.Object

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

Field Detail

TRIM_TEXT_ON_PASTE_KEY

public static final java.lang.String TRIM_TEXT_ON_PASTE_KEY

Setup JTextComponent.getDocument().putProperty(TRIM_TEXT_ON_PASTE_KEY, Boolean.TRUE) to trim text that is being pasted

See Also:

Constant Field Values

Constructor Detail

EditorCopyPasteHelper

public EditorCopyPasteHelper()

Method Detail

getInstance

public static EditorCopyPasteHelper getInstance()

copySelectionToClipboard

public abstract void copySelectionToClipboard(Editor editor)

Copies text selected in editor to clipboard.

pasteFromClipboard

public abstract TextRange [] pasteFromClipboard(Editor editor)
                                         throws EditorCopyPasteHelper.TooLargeContentException

Pastes from clipboard into editor at caret(s) position.

Returns:

ranges of text in the document, corresponding to pasted fragments, if paste succeeds, or null otherwise

Throws:

EditorCopyPasteHelper.TooLargeContentException - if content is too large to be pasted in editor

pasteTransferable

public abstract TextRange [] pasteTransferable(Editor editor,
                                               java.awt.datatransfer.Transferable content)
                                        throws EditorCopyPasteHelper.TooLargeContentException

Pastes given Transferable instance into editor at caret(s) position.

Returns:

ranges of text in the document, corresponding to pasted fragments, if paste succeeds, or null otherwise

Throws:

EditorCopyPasteHelper.TooLargeContentException - if content is too large to be pasted in editor