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
|
/*****************************************************************************
* Copyright (c) 2011, 2016 LIFL, 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:
* Vincent Lorenzo (CEA-LIST) vincent.lorenzo@cea.fr - Initial API and implementation
* Juan Cadavid (CEA-LIST) juan.cadavid@cea.fr - Overloading execution to support creation of multiple tables with an incremental name
* Christian W. Damus - bug 485220
*
*****************************************************************************/
package org.eclipse.papyrus.infra.nattable.common.handlers;
import java.util.ArrayList;
import java.util.Iterator;
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.Assert;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.transaction.RecordingCommand;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.jface.dialogs.InputDialog;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.window.Window;
import org.eclipse.papyrus.infra.core.resource.ModelSet;
import org.eclipse.papyrus.infra.core.resource.NotFoundException;
import org.eclipse.papyrus.infra.core.sashwindows.di.service.IPageManager;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.core.services.ServicesRegistry;
import org.eclipse.papyrus.infra.core.utils.EditorNameInitializer;
import org.eclipse.papyrus.infra.core.utils.ServiceUtils;
import org.eclipse.papyrus.infra.emf.utils.EMFHelper;
import org.eclipse.papyrus.infra.nattable.Activator;
import org.eclipse.papyrus.infra.nattable.common.modelresource.PapyrusNattableModel;
import org.eclipse.papyrus.infra.nattable.messages.Messages;
import org.eclipse.papyrus.infra.nattable.model.nattable.NattablePackage;
import org.eclipse.papyrus.infra.nattable.model.nattable.Table;
import org.eclipse.papyrus.infra.nattable.model.nattable.nattableconfiguration.NattableconfigurationPackage;
import org.eclipse.papyrus.infra.nattable.model.nattable.nattableconfiguration.TableConfiguration;
import org.eclipse.papyrus.infra.nattable.utils.TableHelper;
import org.eclipse.papyrus.infra.ui.util.ServiceUtilsForHandlers;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
/**
*
*
*/
public abstract class AbstractCreateNattableEditorHandler extends AbstractHandler {
/**
* @see org.eclipse.core.commands.IHandler#execute(org.eclipse.core.commands.ExecutionEvent)
*
* @param event
* @return
* @throws ExecutionException
*/
@Override
public Object execute(final ExecutionEvent event) throws ExecutionException {
try {
runAsTransaction(event);
} catch (final ServiceException e) {
throw new ExecutionException("Can't create TableEditor", e); //$NON-NLS-1$
}
return null;
}
/**
* Prompts the user the future table's name
*
* @return The name, or <code>null</code> if the user cancelled the creation
*/
public String askName() {
// we create a new resourceSet to avoid to load unused config in the resourceset in case of Cancel
TableConfiguration conf = getTableEditorConfiguration();
String defaultName = conf.getName();
// default Value
final String nameWithIncrement = EditorNameInitializer.getNameWithIncrement(NattablePackage.eINSTANCE.getTable(), NattableconfigurationPackage.eINSTANCE.getTableNamedElement_Name(), defaultName, getTableContext());
final InputDialog dialog = new InputDialog(Display.getDefault().getActiveShell(), Messages.AbstractCreateNattableEditorHandler_PapyrusTableCreation, Messages.AbstractCreateNattableEditorHandler_EnterTheNameForTheNewTable, nameWithIncrement, null);
if (dialog.open() == Window.OK) {
return dialog.getValue();
}
return null;
}
/**
* Run the command as a transaction. Create a Transaction and delegate the
* command to {@link #doExecute(ServicesRegistry)}.
*
* @throws ServiceException
*
*/
public void runAsTransaction(final ExecutionEvent event) throws ServiceException {
String name = askName();
if (name != null) {
runAsTransaction(event, name);
}
}
/**
* Create the table creation command and execute it. Unlike {@link this#runAsTransaction(ExecutionEvent)}, this method doesn't display a dialog to
* ask for the name but rather takes it as a parameter.
*
* @param event
* @param name
* @throws ServiceException
*/
public void runAsTransaction(final ExecutionEvent event, final String name) throws ServiceException {
final ServicesRegistry serviceRegistry = ServiceUtilsForHandlers.getInstance().getServiceRegistry(event);
final TransactionalEditingDomain domain = ServiceUtils.getInstance().getTransactionalEditingDomain(serviceRegistry);
domain.getCommandStack().execute(new RecordingCommand(domain) {
@Override
protected void doExecute() {
try {
AbstractCreateNattableEditorHandler.this.doExecute(serviceRegistry, name, this.description);
} catch (final NotFoundException e) {
Activator.log.error(e);
} catch (final ServiceException e) {
Activator.log.error(e);
}
}
});
}
public Command getCreateNattableEditorCommandWithNameInitialization(final TransactionalEditingDomain domain, final ServicesRegistry serviceRegistry, final ExecutionEvent event, final String name) throws ServiceException {
return new RecordingCommand(domain) {
@Override
protected void doExecute() {
try {
AbstractCreateNattableEditorHandler.this.doExecute(serviceRegistry, name, this.description);
} catch (final NotFoundException e) {
Activator.log.error(e);
} catch (final ServiceException e) {
Activator.log.error(e);
}
}
};
}
/**
* Do the execution of the command.
*
* @param serviceRegistry
* @throws ServiceException
* @throws NotFoundException
*/
public Table doExecute(final ServicesRegistry serviceRegistry, String name, String description) throws ServiceException, NotFoundException {
final Table editorModel = createEditorModel(serviceRegistry, name, description);
// Get the mngr allowing to add/open new editor.
final IPageManager pageMngr = ServiceUtils.getInstance().getService(IPageManager.class, serviceRegistry);
// add the new editor model to the sash.
pageMngr.openPage(editorModel);
return editorModel;
}
/**
* Create a model identifying the editor. This model will be saved with the
* sash
*
* @return
* @throws ServiceException
* @throws NotFoundException
* The model where to save the TableInstance is not found.
*/
protected Table createEditorModel(final ServicesRegistry serviceRegistry, String name, String description) throws ServiceException, NotFoundException {
final TableConfiguration configuration = getTableEditorConfiguration();
Assert.isNotNull(configuration);
final Table table = TableHelper.createTable(configuration, null, name, description); // context null here, see bug 410357
// Save the model in the associated resource
final ModelSet modelSet = ServiceUtils.getInstance().getModelSet(serviceRegistry);
final PapyrusNattableModel model = (PapyrusNattableModel) modelSet.getModelChecked(PapyrusNattableModel.MODEL_ID);
table.setContext(getTableContext());
model.addPapyrusTable(table);
return table;
}
protected abstract TableConfiguration getTableEditorConfiguration();
/**
* Returns the context used to create the table
*
* @return
* the context used to create the table or <code>null</code> if not found
* @throws ServiceException
*/
protected EObject getTableContext() {
final List<EObject> selection = getSelection();
if (!selection.isEmpty()) {
return selection.get(0);
}
return null;
}
/**
*
* @return
*/
protected List<EObject> getSelection() {
final List<EObject> selectedElements = new ArrayList<EObject>();
final IWorkbenchWindow ww = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
if (ww != null) {
final ISelection selection = ww.getSelectionService().getSelection();
if (selection instanceof IStructuredSelection) {
final IStructuredSelection structuredSelection = (IStructuredSelection) selection;
final Iterator<?> it = structuredSelection.iterator();
while (it.hasNext()) {
final Object object = it.next();
final EObject currentEObject = EMFHelper.getEObject(object);
if (currentEObject != null) {
selectedElements.add(currentEObject);
}
}
}
}
return selectedElements;
}
/**
* Get the root element associated with canvas.
*/
protected EObject getRootElement(final Resource modelResource) {
EObject rootElement = null;
if (modelResource != null && modelResource.getContents() != null && modelResource.getContents().size() > 0) {
final Object root = modelResource.getContents().get(0);
if (root instanceof EObject) {
rootElement = (EObject) root;
}
}
return rootElement;
}
}
|
