replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / editor / EditorCopyPasteHelper.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.editor;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import com.intellij.openapi.util.TextRange;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 import java.awt.datatransfer.Transferable;
24
25 /**
26  * Support for data transfer between editor and clipboard.
27  */
28 public abstract class EditorCopyPasteHelper {
29   /**
30    *  Setup JTextComponent.getDocument().putProperty(TRIM_TEXT_ON_PASTE_KEY, Boolean.TRUE) to trim text that is being pasted
31    */
32   public static final String TRIM_TEXT_ON_PASTE_KEY = "trimTextOnPaste";
33
34   public static EditorCopyPasteHelper getInstance() {
35     return ServiceManager.getService(EditorCopyPasteHelper.class);
36   }
37
38   /**
39    * Copies text selected in editor to clipboard.
40    */
41   public abstract void copySelectionToClipboard(@NotNull Editor editor);
42
43   /**
44    * Pastes from clipboard into editor at caret(s) position.
45    *
46    * @return ranges of text in the document, corresponding to pasted fragments, if paste succeeds, or {@code null} otherwise
47    */
48   @Nullable
49   public abstract TextRange[] pasteFromClipboard(@NotNull Editor editor);
50
51   /**
52    * Pastes given Transferable instance into editor at caret(s) position.
53    *
54    * @return ranges of text in the document, corresponding to pasted fragments, if paste succeeds, or {@code null} otherwise
55    */
56   @Nullable
57   public abstract TextRange[] pasteTransferable(@NotNull Editor editor, @NotNull Transferable content);
58 }