1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*
* Copyright 2000-2014 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.openapi.editor.actionSystem;
import com.intellij.openapi.actionSystem.DataContext;
import com.intellij.openapi.editor.Caret;
import com.intellij.openapi.editor.CaretAction;
import com.intellij.openapi.editor.Editor;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Interface for actions activated by keystrokes in the editor.
* Implementations should override
* {@link #execute(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.Caret, com.intellij.openapi.actionSystem.DataContext)}
* .
* <p>
* Two types of handlers are supported: the ones which are executed once, and the ones which are executed for each caret. The latter can be
* created using {@link com.intellij.openapi.editor.actionSystem.EditorActionHandler#EditorActionHandler(boolean)} constructor.
*
* @see EditorActionManager#setActionHandler(String, EditorActionHandler)
*/
public abstract class EditorActionHandler {
private final boolean myRunForEachCaret;
private boolean inExecution;
protected EditorActionHandler() {
this(false);
}
protected EditorActionHandler(boolean runForEachCaret) {
myRunForEachCaret = runForEachCaret;
}
/**
* Checks if the action handler is currently enabled.
*
* @param editor the editor in which the action is invoked.
* @param dataContext the data context for the action.
* @return true if the action is enabled, false otherwise
*/
public boolean isEnabled(Editor editor, DataContext dataContext) {
return true;
}
/**
* @deprecated To implement action logic, override
* {@link #doExecute(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.Caret, com.intellij.openapi.actionSystem.DataContext)},
* to invoke the handler, call
* {@link #execute(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.Caret, com.intellij.openapi.actionSystem.DataContext)}.
*/
public void execute(Editor editor, DataContext dataContext) {
if (inExecution) {
return;
}
try {
inExecution = true;
execute(editor, editor.getCaretModel().getCurrentCaret(), dataContext);
}
finally {
inExecution = false;
}
}
/**
* Executes the action in the context of given caret. Subclasses should override this method.
*
* @param editor the editor in which the action is invoked.
* @param caret the caret for which the action is performed at the moment, or <code>null</code> if it's a 'one-off' action executed
* without current context
* @param dataContext the data context for the action.
*/
protected void doExecute(Editor editor, @Nullable Caret caret, DataContext dataContext) {
if (inExecution) {
return;
}
try {
inExecution = true;
//noinspection deprecation
execute(editor, dataContext);
}
finally {
inExecution = false;
}
}
public boolean executeInCommand(Editor editor, DataContext dataContext) {
return true;
}
public boolean runForAllCarets() {
return myRunForEachCaret;
}
/**
* Executes the action in the context of given caret. If the caret is <code>null</code>, and the handler is a 'per-caret' handler,
* it's executed for all carets.
*
* @param editor the editor in which the action is invoked.
* @param dataContext the data context for the action.
*/
public final void execute(@NotNull final Editor editor, @Nullable Caret contextCaret, final DataContext dataContext) {
if (contextCaret == null && runForAllCarets()) {
editor.getCaretModel().runForEachCaret(new CaretAction() {
@Override
public void perform(Caret caret) {
doExecute(editor, caret, dataContext);
}
}, true);
}
else {
doExecute(editor, contextCaret, dataContext);
}
}
public DocCommandGroupId getCommandGroupId(Editor editor) {
// by default avoid merging two consequential commands, and, in the same time, pass along the Document
return DocCommandGroupId.noneGroupId(editor.getDocument());
}
}
|
