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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/*******************************************************************************
* Copyright (c) 2004, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.commands;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.commands.IHandlerAttributes;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.actions.RetargetAction;
/**
* This class adapts instances of <code>IAction</code> to
* <code>IHandler</code>.
*
* @since 3.0
* @deprecated Please use the "org.eclipse.core.commands" plug-in instead.
* @see org.eclipse.jface.commands.ActionHandler
*/
public final class ActionHandler extends AbstractHandler {
/**
* The attribute name for the checked property of the wrapped action. This
* indicates whether the action should be displayed with as a checked check
* box.
*/
private final static String ATTRIBUTE_CHECKED = "checked"; //$NON-NLS-1$
/**
* The attribute name for the enabled property of the wrapped action.
*/
private final static String ATTRIBUTE_ENABLED = "enabled"; //$NON-NLS-1$
/**
* <p>
* The name of the attribute indicating whether the wrapped instance of
* <code>RetargetAction</code> has a handler.
* </p>
*/
private final static String ATTRIBUTE_HANDLED = IHandlerAttributes.ATTRIBUTE_HANDLED;
/**
* The attribute name for the identifier of the wrapped action. This is the
* action identifier, and not the command identifier.
*/
private final static String ATTRIBUTE_ID = "id"; //$NON-NLS-1$
/**
* The attribute name for the visual style of the wrapped action. The style
* can be things like a pull-down menu, a check box, a radio button or a
* push button.
*/
private final static String ATTRIBUTE_STYLE = "style"; //$NON-NLS-1$
/**
* The wrapped action. This value is never <code>null</code>.
*/
private final IAction action;
/**
* The map of attributes values. The keys are <code>String</code> values
* of the attribute names (given above). The values can be any type of
* <code>Object</code>.
*
* This map is always null if there are no IHandlerListeners registered.
*
*/
private Map attributeValuesByName;
/**
* The property change listener hooked on to the action. This is initialized
* when the first listener is attached to this handler, and is removed when
* the handler is disposed or the last listener is removed.
*/
private IPropertyChangeListener propertyChangeListener;
/**
* Creates a new instance of this class given an instance of
* <code>IAction</code>.
*
* @param action
* the action. Must not be <code>null</code>.
*/
public ActionHandler(IAction action) {
if (action == null) {
throw new NullPointerException();
}
this.action = action;
}
/**
* @see org.eclipse.ui.commands.IHandler#addHandlerListener(org.eclipse.ui.commands.IHandlerListener)
* @since 3.1
*/
public void addHandlerListener(IHandlerListener handlerListener) {
if (!hasListeners()) {
attachListener();
}
super.addHandlerListener(handlerListener);
}
/**
* When a listener is attached to this handler, then this registers a
* listener with the underlying action.
*
* @since 3.1
*/
private final void attachListener() {
if (propertyChangeListener == null) {
attributeValuesByName = getAttributeValuesByNameFromAction();
propertyChangeListener = new IPropertyChangeListener() {
public void propertyChange(
PropertyChangeEvent propertyChangeEvent) {
String property = propertyChangeEvent.getProperty();
if (IAction.ENABLED.equals(property)
|| IAction.CHECKED.equals(property)
|| IHandlerAttributes.ATTRIBUTE_HANDLED
.equals(property)) {
Map previousAttributeValuesByName = attributeValuesByName;
attributeValuesByName = getAttributeValuesByNameFromAction();
if (!attributeValuesByName
.equals(previousAttributeValuesByName)) {
fireHandlerChanged(new HandlerEvent(
ActionHandler.this, true,
previousAttributeValuesByName));
}
}
}
};
}
this.action.addPropertyChangeListener(propertyChangeListener);
}
/**
* When no more listeners are registered, then this is used to removed the
* property change listener from the underlying action.
*
* @since 3.1
*
*/
private final void detachListener() {
this.action.removePropertyChangeListener(propertyChangeListener);
propertyChangeListener = null;
attributeValuesByName = null;
}
/**
* Removes the property change listener from the action.
*
* @see org.eclipse.ui.commands.IHandler#dispose()
*/
public void dispose() {
if (hasListeners()) {
action.removePropertyChangeListener(propertyChangeListener);
}
}
/* (non-Javadoc)
* @see org.eclipse.ui.commands.IHandler#execute(java.util.Map)
*/
public Object execute(Map parameterValuesByName) throws ExecutionException {
if ((action.getStyle() == IAction.AS_CHECK_BOX)
|| (action.getStyle() == IAction.AS_RADIO_BUTTON)) {
action.setChecked(!action.isChecked());
}
try {
action.runWithEvent(new Event());
} catch (Exception e) {
throw new ExecutionException(
"While executing the action, an exception occurred", e); //$NON-NLS-1$
}
return null;
}
/**
* Returns the action associated with this handler
*
* @return the action associated with this handler (not null)
* @since 3.1
*/
public IAction getAction() {
return action;
}
/* (non-Javadoc)
* @see org.eclipse.ui.commands.IHandler#getAttributeValuesByName()
*/
public Map getAttributeValuesByName() {
if (attributeValuesByName == null) {
return getAttributeValuesByNameFromAction();
}
return attributeValuesByName;
}
/**
* An accessor for the attribute names from the action. This reads out all
* of the attributes from an action into a local map.
*
* @return A map of the attribute values indexed by the attribute name. The
* attributes names are strings, but the values can by any object.
*
*/
private Map getAttributeValuesByNameFromAction() {
Map map = new HashMap();
map.put(ATTRIBUTE_CHECKED, action.isChecked() ? Boolean.TRUE
: Boolean.FALSE);
map.put(ATTRIBUTE_ENABLED, action.isEnabled() ? Boolean.TRUE
: Boolean.FALSE);
boolean handled = true;
if (action instanceof RetargetAction) {
RetargetAction retargetAction = (RetargetAction) action;
handled = retargetAction.getActionHandler() != null;
}
map.put(ATTRIBUTE_HANDLED, handled ? Boolean.TRUE : Boolean.FALSE);
map.put(ATTRIBUTE_ID, action.getId());
map.put(ATTRIBUTE_STYLE, new Integer(action.getStyle()));
return Collections.unmodifiableMap(map);
}
/**
* @see org.eclipse.ui.commands.IHandler#removeHandlerListener(org.eclipse.ui.commands.IHandlerListener)
* @since 3.1
*/
public void removeHandlerListener(IHandlerListener handlerListener) {
super.removeHandlerListener(handlerListener);
if (!hasListeners()) {
detachListener();
}
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
public final String toString() {
final StringBuffer buffer = new StringBuffer();
buffer.append("ActionHandler(action="); //$NON-NLS-1$
buffer.append(action);
buffer.append(')');
return buffer.toString();
}
}
|
