blob: 53d9ba6e5ca2189bea144b61c9c1e24a8cddc8bb (
plain) (
blame)
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
|
/*****************************************************************************
* Copyright (c) 2010 CEA LIST.
*
*
* 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:
*
* Patrick Tessier (CEA LIST) Patrick.tessier@cea.fr - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.uml.commands.handler;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.commands.AbstractHandler;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.transaction.RunnableWithResult;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.core.services.ServicesRegistry;
import org.eclipse.papyrus.infra.core.utils.ServiceUtils;
import org.eclipse.papyrus.infra.emf.utils.BusinessModelResolver;
import org.eclipse.papyrus.infra.emf.utils.ServiceUtilsForEObject;
import org.eclipse.papyrus.infra.emf.utils.ServiceUtilsForHandlers;
import org.eclipse.papyrus.uml.commands.Activator;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.PlatformUI;
/**
* <pre>
*
* This abstract command handler manages:
* - current selection in order to build a list of the selected {@link EObject}
* - execute the command (returned by children) in Papyrus {@link TransactionalEditingDomain}
* - calculate the command enablement and visibility regarding the command executability
* (the command is now shown in menu if not executable).
*
* </pre>
*/
public abstract class AbstractEMFCommandHandler extends AbstractHandler {
/**
* Returns the current editing domain
*
* @return
* the current editing domain
*/
protected TransactionalEditingDomain getEditingDomain() {
TransactionalEditingDomain editingDomain = null;
try {
editingDomain = org.eclipse.papyrus.infra.core.utils.ServiceUtilsForActionHandlers.getInstance().getTransactionalEditingDomain();
} catch (ServiceException e) {
//we are closing the editor, so the model explorer has nothing to display
// e.printStackTrace();
}
return editingDomain;
}
/**
* <pre>
*
* Returns the command to execute (to be implemented
* in children implementing this class)
*
* @return the command to execute
*
* </pre>
*/
protected abstract Command getCommand(ServicesRegistry registry);
/**
* <pre>
* Get the selected element, the first selected element if several are selected or null
* if no selection or the selection is not an {@link EObject}.
*
* @return selected {@link EObject} or null
* </pre>
*
*/
protected EObject getSelectedElement() {
EObject eObject = null;
Object selection = null;
// Get current selection
selection = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection();
// Get first element if the selection is an IStructuredSelection
if(selection instanceof IStructuredSelection) {
IStructuredSelection structuredSelection = (IStructuredSelection)selection;
selection = structuredSelection.getFirstElement();
}
// Treat non-null selected object (try to adapt and return EObject)
if(selection != null) {
if(selection instanceof IAdaptable) {
selection = ((IAdaptable)selection).getAdapter(EObject.class);
}
Object businessObject = BusinessModelResolver.getInstance().getBusinessModel(selection);
if(businessObject instanceof EObject) {
eObject = (EObject)businessObject;
}
}
return eObject;
}
/**
* <pre>
* Parse current selection and extract the list of {@link EObject} from
* this selection.
*
* This also tries to adapt selected element into {@link EObject}
* (for example to get the {@link EObject} from a selection in the ModelExplorer).
*
* @return a list of currently selected {@link EObject}
* </pre>
*
*/
protected List<EObject> getSelectedElements() {
List<EObject> selectedEObjects = new ArrayList<EObject>();
//FIXME: This method should always be called from the UI Thread.
//TODO: Fix the tests and remove the syncExec call
// Parse current selection
RunnableWithResult<ISelection> runnable;
Display.getDefault().syncExec(runnable = new RunnableWithResult.Impl<ISelection>() {
public void run() {
setResult(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection());
}
});
ISelection selection = runnable.getResult();
if(selection instanceof IStructuredSelection) {
IStructuredSelection structuredSelection = (IStructuredSelection)selection;
for(Object current : structuredSelection.toArray()) {
// Adapt current selection to EObject
if(current instanceof IAdaptable) {
EObject eobject = (EObject)((IAdaptable)current).getAdapter(EObject.class);
if(eobject != null) {
selectedEObjects.add(eobject);
}
}
}
} else { // Not a IStructuredSelection
if(selection != null) {
// Adapt current selection to EObject
if(selection instanceof IAdaptable) {
EObject eobject = (EObject)((IAdaptable)selection).getAdapter(EObject.class);
if(eobject != null) {
selectedEObjects.add(eobject);
}
}
}
}
return selectedEObjects;
}
/**
*
* @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
*
* @param event
* @return null
* @throws ExecutionException
*/
public Object execute(ExecutionEvent event) throws ExecutionException {
try {
ServicesRegistry registry = ServiceUtilsForHandlers.getInstance().getServiceRegistry(event);
Command emfCommand = getCommand(registry);
ServiceUtils.getInstance().getTransactionalEditingDomain(registry).getCommandStack().execute(emfCommand);
return emfCommand.getResult();
} catch (ServiceException e) {
Activator.log.error("Unexpected error while executing command.", e);
}
return null;
}
/**
*
* @see org.eclipse.core.commands.AbstractHandler#isEnabled()
*
* @return true (enabled) when the command can be executed.
*/
@Override
public boolean isEnabled() {
return getCommand(getServicesRegistryFromSelection()).canExecute();
}
protected ServicesRegistry getServicesRegistryFromSelection() {
for(EObject selectedElement : getSelectedElements()) {
try {
ServicesRegistry registry = ServiceUtilsForEObject.getInstance().getServiceRegistry(selectedElement);
if(registry != null) {
return registry;
}
} catch (ServiceException ex) {
//Ignore it and keep searching for a ServicesRegistry
}
}
return null;
}
/**
*
* @return true (visible) when the command can be executed.
*/
public boolean isVisible() {
return getCommand(getServicesRegistryFromSelection()).canExecute();
}
}
|
