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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*******************************************************************************
* Copyright (c) 2000, 2018 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.texteditor;
import java.util.ResourceBundle;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.jface.text.ITextOperationTarget;
import org.eclipse.ui.IWorkbenchPartSite;
/**
* An action which gets a text operation target from its text editor.
* <p>
* The action is initially associated with a text editor via the constructor,
* but can subsequently be changed using <code>setEditor</code>.</p>
* <p>
* If this class is used as is, it works by asking the text editor for its
* text operation target adapter (using <code>getAdapter(ITextOperationTarget.class)</code>.
* The action runs this operation with the pre-configured opcode.</p>
*/
public final class TextOperationAction extends TextEditorAction {
/** The text operation code */
private int fOperationCode= -1;
/** The text operation target */
private ITextOperationTarget fOperationTarget;
/**
* Indicates whether this action can be executed on read only editors
* @since 2.0
*/
private boolean fRunsOnReadOnly= false;
/**
* Flag to prevent running twice trough {@link #update()}
* when creating this action.
* @since 3.2
*/
private boolean fAllowUpdate= false;
/**
* Creates and initializes the action for the given text editor and operation
* code. The action configures its visual representation from the given resource
* bundle. The action works by asking the text editor at the time for its
* text operation target adapter (using
* <code>getAdapter(ITextOperationTarget.class)</code>. The action runs that
* operation with the given opcode.
*
* @param bundle the resource bundle
* @param prefix a prefix to be prepended to the various resource keys
* (described in <code>ResourceAction</code> constructor), or
* <code>null</code> if none
* @param editor the text editor
* @param operationCode the operation code
* @see TextEditorAction#TextEditorAction(ResourceBundle, String, ITextEditor)
*/
public TextOperationAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode) {
super(bundle, prefix, editor);
fOperationCode= operationCode;
fAllowUpdate= true;
update();
}
/**
* Creates and initializes the action for the given text editor and operation
* code. The action configures its visual representation from the given resource
* bundle. The action works by asking the text editor at the time for its
* text operation target adapter (using
* <code>getAdapter(ITextOperationTarget.class)</code>. The action runs that
* operation with the given opcode.
*
* @param bundle the resource bundle
* @param prefix a prefix to be prepended to the various resource keys
* (described in <code>ResourceAction</code> constructor), or
* <code>null</code> if none
* @param editor the text editor
* @param operationCode the operation code
* @param runsOnReadOnly <code>true</code> if action can be executed on read-only files
*
* @see TextEditorAction#TextEditorAction(ResourceBundle, String, ITextEditor)
* @since 2.0
*/
public TextOperationAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode, boolean runsOnReadOnly) {
super(bundle, prefix, editor);
fOperationCode= operationCode;
fRunsOnReadOnly= runsOnReadOnly;
fAllowUpdate= true;
update();
}
/**
* The <code>TextOperationAction</code> implementation of this
* <code>IAction</code> method runs the operation with the current
* operation code.
*/
@Override
public void run() {
if (fOperationCode == -1 || fOperationTarget == null)
return;
ITextEditor editor= getTextEditor();
if (editor == null)
return;
if (!fRunsOnReadOnly && !validateEditorInputState())
return;
Display display= null;
IWorkbenchPartSite site= editor.getSite();
Shell shell= site.getShell();
if (shell != null && !shell.isDisposed())
display= shell.getDisplay();
BusyIndicator.showWhile(display, () -> fOperationTarget.doOperation(fOperationCode));
}
/**
* The <code>TextOperationAction</code> implementation of this
* <code>IUpdate</code> method discovers the operation through the current
* editor's <code>ITextOperationTarget</code> adapter, and sets the
* enabled state accordingly.
*/
@Override
public void update() {
if (!fAllowUpdate)
return;
super.update();
if (!fRunsOnReadOnly && !canModifyEditor()) {
setEnabled(false);
return;
}
ITextEditor editor= getTextEditor();
if (fOperationTarget == null && editor!= null && fOperationCode != -1)
fOperationTarget= editor.getAdapter(ITextOperationTarget.class);
boolean isEnabled= (fOperationTarget != null && fOperationTarget.canDoOperation(fOperationCode));
setEnabled(isEnabled);
}
@Override
public void setEditor(ITextEditor editor) {
super.setEditor(editor);
fOperationTarget= null;
}
}
|
