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
|
/*******************************************************************************
* Copyright (c) 2000, 2006 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;
/**
* Skeleton of a standard text editor action. The action is
* initially associated with a text editor via the constructor,
* but can subsequently be changed using <code>setEditor</code>.
* Subclasses must implement the <code>run</code> method and if
* required override the <code>update</code> method.
* <p>
* Subclasses that may modify the editor content should use {@link #canModifyEditor()}
* in their <code>update</code> code to check whether updating the editor is most
* likely possible (even if it is read-only - this may change for editor contents
* that are under version control) and {@link #validateEditorInputState()} before
* actually modifying the editor contents.
* </p>
*/
public abstract class TextEditorAction extends ResourceAction implements IUpdate {
/** The action's editor */
private ITextEditor fTextEditor;
/**
* Creates and initializes the action for the given text editor. The action
* configures its visual representation from the given resource bundle.
*
* @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
* @see ResourceAction#ResourceAction(ResourceBundle, String)
*/
protected TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor) {
super(bundle, prefix);
setEditor(editor);
update();
}
/**
* Creates and initializes the action for the given text editor. The action
* configures its visual representation from the given resource bundle.
*
* @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 style the style of this action
* @see ResourceAction#ResourceAction(ResourceBundle, String, int)
* @since 3.0
*/
protected TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor, int style) {
super(bundle, prefix, style);
setEditor(editor);
update();
}
/**
* Returns the action's text editor.
*
* @return the action's text editor
*/
protected ITextEditor getTextEditor() {
return fTextEditor;
}
/**
* Retargets this action to the given editor.
*
* @param editor the new editor, or <code>null</code> if none
*/
public void setEditor(ITextEditor editor) {
fTextEditor= editor;
}
/**
* Always enables this action if it is connected to a text editor.
* If the associated editor is <code>null</code>, the action is disabled.
* Subclasses may override.
*/
@Override
public void update() {
setEnabled(getTextEditor() != null);
}
/**
* Checks the editor's modifiable state. Returns <code>true</code> if the editor can be modified,
* taking in account the possible editor extensions.
*
* <p>If the editor implements <code>ITextEditorExtension2</code>,
* this method returns {@link ITextEditorExtension2#isEditorInputModifiable()};<br> else if the editor
* implements <code>ITextEditorExtension</code>, it returns {@link ITextEditorExtension#isEditorInputReadOnly()};<br>
* else, {@link ITextEditor#isEditable()} is returned, or <code>false</code> if the editor is <code>null</code>.</p>
*
* <p>There is only a difference to {@link #validateEditorInputState()} if the editor implements
* <code>ITextEditorExtension2</code>.</p>
*
* @return <code>true</code> if a modifying action should be enabled, <code>false</code> otherwise
* @since 3.0
*/
protected boolean canModifyEditor() {
ITextEditor editor= getTextEditor();
if (editor instanceof ITextEditorExtension2)
return ((ITextEditorExtension2) editor).isEditorInputModifiable();
else if (editor instanceof ITextEditorExtension)
return !((ITextEditorExtension) editor).isEditorInputReadOnly();
else if (editor != null)
return editor.isEditable();
else
return false;
}
/**
* Checks and validates the editor's modifiable state. Returns <code>true</code> if an action
* can proceed modifying the editor's input, <code>false</code> if it should not.
*
* <p>If the editor implements <code>ITextEditorExtension2</code>,
* this method returns {@link ITextEditorExtension2#validateEditorInputState()};<br> else if the editor
* implements <code>ITextEditorExtension</code>, it returns {@link ITextEditorExtension#isEditorInputReadOnly()};<br>
* else, {@link ITextEditor#isEditable()} is returned, or <code>false</code> if the editor is <code>null</code>.</p>
*
* <p>There is only a difference to {@link #canModifyEditor()} if the editor implements
* <code>ITextEditorExtension2</code>.</p>
*
* @return <code>true</code> if a modifying action can proceed to modify the underlying document, <code>false</code> otherwise
* @since 3.0
*/
protected boolean validateEditorInputState() {
ITextEditor editor= getTextEditor();
if (editor instanceof ITextEditorExtension2)
return ((ITextEditorExtension2) editor).validateEditorInputState();
else if (editor instanceof ITextEditorExtension)
return !((ITextEditorExtension) editor).isEditorInputReadOnly();
else if (editor != null)
return editor.isEditable();
else
return false;
}
}
|
