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
|
/*******************************************************************************
* Copyright (c) 2013, 2016 CEA LIST, Christian W. Damus, 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:
* Cedric Dumoulin - cedric.dumoulin@lifl.fr
* Christian W. Damus - bug 485220
*
******************************************************************************/
package org.eclipse.papyrus.layers3.ui.commands;
import org.eclipse.core.commands.AbstractHandler;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.expressions.IEvaluationContext;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.transaction.RecordingCommand;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor;
import org.eclipse.gmf.runtime.notation.Diagram;
import org.eclipse.papyrus.infra.core.sasheditor.editor.ISashWindowsContainer;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.emf.utils.ServiceUtilsForIEvaluationContext;
import org.eclipse.papyrus.layers.runtime.NotationDiagramHelper;
import org.eclipse.papyrus.layers.runtime.model.LayersModel;
import org.eclipse.papyrus.layers.stackmodel.NotFoundException;
import org.eclipse.ui.IEditorPart;
/**
* Base class for Commands on Layers.
* This class provide utility methods to find the current Layer, LayerStack, ...
*
* @author cedric dumoulin
*
*/
public abstract class AbstractLayerStackCommand extends AbstractHandler {
/**
* Constructor.
*
*/
public AbstractLayerStackCommand() {
super();
}
/**
* @see org.eclipse.core.commands.IHandler#execute(org.eclipse.core.commands.ExecutionEvent)
* @param event
* @return
* @throws ExecutionException
*
*/
@Override
public Object execute(ExecutionEvent event) throws ExecutionException {
executeTransaction(event);
return null;
}
/**
* Execute as transaction
*
* @param event
*/
private void executeTransaction(final ExecutionEvent event) {
// Get requested objects
final NotationDiagramHelper notationDiagramHelper;
TransactionalEditingDomain editingDomain;
try {
IEvaluationContext context = getIEvaluationContext(event);
notationDiagramHelper = lookupNotationDiagramHelperChecked(context);
editingDomain = lookupTransactionalEditingDomain(context);
} catch (NotFoundException e) {
// silently fails
return;
} catch (ServiceException e) {
// silently fails
return;
}
Command cmd = new RecordingCommand(editingDomain, getCommandName()) {
@Override
protected void doExecute() {
AbstractLayerStackCommand.this.doExecute(event, notationDiagramHelper);
}
};
editingDomain.getCommandStack().execute(cmd);
}
/**
* Get the name used in the {@link RecordingCommand}. This name will be visible in
* undo/redo.
*
* @return The command name to show.
*/
public abstract String getCommandName();
/**
* Do the execution of the command.
* Subclass should implements this method.
*
* @param event
*
* @param notationDiagramHelper
*/
protected abstract void doExecute(ExecutionEvent event, NotationDiagramHelper notationDiagramHelper);
// /**
// *
// * @return
// * @throws NotFoundException
// */
// protected LayerStackMngr lookupLayerStackMngrChecked() throws NotFoundException {
//
// return lookupLayersViewChecked().getLayerStackMngrChecked();
//
// }
protected IEvaluationContext getIEvaluationContext(ExecutionEvent event) throws NotFoundException {
try {
return (IEvaluationContext) event.getApplicationContext();
} catch (ClassCastException e) {
throw new NotFoundException("IEvaluationContext can't be found.");
}
}
/**
* Try to lookup the TransactionalEditingDomain.
*
* @return
* @throws ServiceException
* If the Editing domain can't be found.
*/
protected TransactionalEditingDomain lookupTransactionalEditingDomain(IEvaluationContext context) throws ServiceException {
// Get page from the event !
// IWorkbenchPage page = HandlerUtil.getActiveWorkbenchWindow(event).getActivePage();
return ServiceUtilsForIEvaluationContext.getInstance().getTransactionalEditingDomain(context);
}
/**
* Called by framework. Need to set the enabled flag.
*
* @see org.eclipse.core.commands.AbstractHandler#setEnabled(java.lang.Object)
*
* @param evaluationContext
*/
@Override
public void setEnabled(Object evaluationContext) {
if (!(evaluationContext instanceof IEvaluationContext)) {
setBaseEnabled(false);
// System.out.println(getCommandName() + ".setEnabled(" + isEnabled() + ") - no context");
return;
}
IEvaluationContext context = (IEvaluationContext) evaluationContext;
try {
NotationDiagramHelper diagramHelper = lookupNotationDiagramHelperChecked(context);
// Ask the subclass
setBaseEnabled(isEnabled(diagramHelper));
} catch (ServiceException e) {
// Can't find ServiceRegistry: disable
setBaseEnabled(false);
} catch (NotFoundException e) {
// Can't find ServiceRegistry: disable
setBaseEnabled(false);
}
// System.out.println(getCommandName() + ".setEnabled(" + isEnabled() + ")");
}
/**
* Return true if the action is enabled, false otherwise.
* Subclasses should implements this method. The default implementation return true.
*
* @param notationDiagramHelper
* @return
*/
public boolean isEnabled(NotationDiagramHelper notationDiagramHelper) {
return true;
}
// /**
// *
// * @return
// * @throws NotFoundException
// */
// protected LayerStackMngr lookupLayerStackMngrChecked() throws NotFoundException {
//
// return lookupLayersViewChecked().getLayerStackMngrChecked();
//
// }
/**
* Get the notation diagram helper.
* This method can be used from {@link #execute(ExecutionEvent)} or {@link #setEnabled(Object)}.
*
* @return The
* @throws NotFoundException
* @throws ServiceException
*/
protected NotationDiagramHelper lookupNotationDiagramHelperChecked(IEvaluationContext context) throws NotFoundException, ServiceException {
// Get page from the event !
// IWorkbenchPage page = HandlerUtil.getActiveWorkbenchWindow(event).getActivePage();
IEditorPart editor = ServiceUtilsForIEvaluationContext.getInstance().getService(ISashWindowsContainer.class, context).getActiveEditor();
if (!(editor instanceof DiagramDocumentEditor)) {
throw new NotFoundException("Selected editor do not contains Diagram");
}
DiagramDocumentEditor diagramEditor = (DiagramDocumentEditor) editor;
Diagram diagram = diagramEditor.getDiagram();
if (diagram == null) {
throw new NotFoundException("Selected editor do not contains Diagram");
}
// Lookup the Layer model
LayersModel layersModel = (LayersModel) ServiceUtilsForIEvaluationContext.getInstance().getModelSet(context).getModel(LayersModel.MODEL_ID);
// Return a new instance of the Helper
return new NotationDiagramHelper(layersModel, diagram);
}
}
|
