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
264
265
|
/*****************************************************************************
* Copyright (c) 2013,2015 Atos, 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:
* Arthur Daussy (Atos) arthur.daussy@atos.net- Initial API and implementation
* Gabriel Pascual (ALL4TEC) gabriel.pascual@all4tec.net - Bug 459702
*****************************************************************************/
package org.eclipse.papyrus.infra.services.controlmode.commands;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.gmf.runtime.common.core.command.CommandResult;
import org.eclipse.papyrus.infra.core.resource.sasheditor.DiModel;
import org.eclipse.papyrus.infra.core.resource.sasheditor.SashModelUtils;
import org.eclipse.papyrus.infra.core.sashwindows.di.AbstractPanel;
import org.eclipse.papyrus.infra.core.sashwindows.di.PageRef;
import org.eclipse.papyrus.infra.core.sashwindows.di.SashModel;
import org.eclipse.papyrus.infra.core.sashwindows.di.SashPanel;
import org.eclipse.papyrus.infra.core.sashwindows.di.SashWindowsMngr;
import org.eclipse.papyrus.infra.core.sashwindows.di.TabFolder;
import org.eclipse.papyrus.infra.core.sashwindows.di.Window;
import org.eclipse.papyrus.infra.core.sashwindows.di.exception.SashEditorException;
import org.eclipse.papyrus.infra.core.sashwindows.di.util.DiUtils;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.services.controlmode.ControlModePlugin;
import org.eclipse.papyrus.infra.services.controlmode.ControlModeRequest;
import org.eclipse.papyrus.infra.services.controlmode.ControlModeRequestParameters;
/**
* Initialise a correct Sash Model in the right location. Two case:
* <dl>
* <dt>Legacy</dt>
* <dd>The sash model must written in Di file.</dd>
* <dt>Standard</dt>
* <dd>Since Luna, the Sash Model must be inserted in its own workspace's resource.</dd>
* </dl>
*
* @author adaussy
*
*/
public class InitializeSashCommand extends AbstractControlCommand {
/** The Constant SASH_RESOURCE_ERROR. */
private static final String SASH_RESOURCE_ERROR = "Unable to find Sash resource";
/** The Constant SASH_COMMAND_TITLE. */
private static final String SASH_COMMAND_TITLE = "Initialize Sash model";
/**
* Instantiates a new initialize sash command.
*
* @param request
* the request
*/
public InitializeSashCommand(ControlModeRequest request) {
super(SASH_COMMAND_TITLE, null, request);
}
/**
* @see org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand#doExecuteWithResult(org.eclipse.core.runtime.IProgressMonitor, org.eclipse.core.runtime.IAdaptable)
*
* @param monitor
* @param info
* @return
* @throws ExecutionException
*/
@Override
protected CommandResult doExecuteWithResult(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {
/*
* Get from the request tab and diagrams being moved
*/
Collection<EObject> openables = getMovedOpenablesFromRequest();
try {
SashWindowsMngr sashMng = createSashWindowsMngr(openables);
Resource sashResourceResource = getSashResource();
if (sashResourceResource == null) {
return CommandResult.newErrorCommandResult(SASH_RESOURCE_ERROR);
}
sashResourceResource.getContents().add(sashMng);
} catch (SashEditorException e) {
ControlModePlugin.log.error(e);
return CommandResult.newErrorCommandResult(e);
} catch (ServiceException e) {
ControlModePlugin.log.error(e);
return CommandResult.newErrorCommandResult(e);
}
return CommandResult.newOKCommandResult();
}
/**
* Gets the moved openables from request.
*
* @return tables being moved from the request
*/
@SuppressWarnings("unchecked")
protected Collection<EObject> getMovedOpenablesFromRequest() {
Collection<EObject> tabs = (Collection<EObject>) getRequest().getParameter(ControlModeRequestParameters.MOVED_OPENABLES);
if (tabs == null) {
return new ArrayList<EObject>();
}
return tabs;
}
/**
* Gets the sash resource.
*
* @return retrieve the di resource from the request
* @throws ServiceException
*/
protected Resource getSashResource() throws ServiceException {
org.eclipse.papyrus.infra.core.resource.sasheditor.SashModel sashModel = SashModelUtils.getSashModel(request.getModelSet());
Resource sashResource = request.getTargetResource(DiModel.MODEL_FILE_EXTENSION);
// Check if the Sash resource is not Legacy format
if (org.eclipse.papyrus.infra.core.resource.sasheditor.SashModel.SASH_MODEL_FILE_EXTENSION.equals(sashModel.getResourceURI().fileExtension())) {
// Load Sash resource
URI targetUri = sashResource.getURI().trimFileExtension();
sashModel.loadModel(targetUri);
sashResource = SashModelUtils.getSashModel(request.getModelSet()).getResource();
}
return sashResource;
}
/**
* Create a new {@link SashModel} and add page ref for each diagrams and tables being controlled
*
* @param openables
* @return
* @throws SashEditorException
* @throws ServiceException
*/
protected SashWindowsMngr createSashWindowsMngr(Collection<EObject> openables) throws SashEditorException, ServiceException {
// Create a new SashWindowManager
SashWindowsMngr windowsMngr = DiUtils.createDefaultSashWindowsMngr();
Resource rootSashModel = SashModelUtils.getSashModel(request.getModelSet()).getResource();
SashWindowsMngr rootSashMngr = DiUtils.lookupSashWindowsMngr(rootSashModel);
if (rootSashMngr == null){
rootSashMngr = DiUtils.createDefaultSashWindowsMngr();
rootSashModel.getContents().add(rootSashMngr);
}
// Complete SashWindow Manager filling the default TabFolder with opened diagram
for (EObject openable : openables) {
PageRef pageRef = getPageRef(rootSashMngr, openable);
if (pageRef != null) {
windowsMngr.getSashModel().addPage(windowsMngr.getSashModel().getCurrentSelection(), pageRef.getPageIdentifier());
}
}
// Force update of old sash resource
rootSashModel.setModified(!openables.isEmpty());
return windowsMngr;
}
/**
* Gets the page ref.
*
* @param sashWindowsManager
* the sash windows manager
* @param emfPageIdentifier
* the emf page identifier
* @return the page ref
*/
private PageRef getPageRef(SashWindowsMngr sashWindowsManager, EObject emfPageIdentifier) {
// Get iterator on all pages of current Tab folder
PageRef pageRef = null;
boolean match = false;
Iterator<Window> windowsIterator = sashWindowsManager.getSashModel().getWindows().iterator();
// Explore each window
while (!match && windowsIterator.hasNext()) {
Window window = windowsIterator.next();
Iterator<AbstractPanel> panelIterator = window.getChildren().iterator();
// Explore each panel which is a TabFolder
while (!match && panelIterator.hasNext()) {
pageRef = parsePanel(panelIterator.next(), emfPageIdentifier);
match = pageRef != null;
}
}
return pageRef;
}
/**
* Parses the panel.
*
* @param panel
* the panel
* @param emfPageIdentifier
* the emf page identifier
* @return the page ref
*/
private PageRef parsePanel(AbstractPanel panel, EObject emfPageIdentifier) {
PageRef pageRef = null;
if (panel instanceof TabFolder) {
pageRef = parseTabFolder((TabFolder) panel, emfPageIdentifier);
} else if (panel instanceof SashPanel) {
Iterator<AbstractPanel> panelIterator = ((SashPanel) panel).getChildren().iterator();
// Explorer each child
while (pageRef == null && panelIterator.hasNext()) {
pageRef = parsePanel(panelIterator.next(), emfPageIdentifier);
}
}
return pageRef;
}
/**
* Parses the tab folder.
*
* @param panel
* the panel
* @param emfPageIdentifier
* the emf page identifier
* @return the page ref
*/
private PageRef parseTabFolder(TabFolder panel, EObject emfPageIdentifier) {
PageRef pageRef = null;
boolean match = false;
// Explore each pageRef
Iterator<PageRef> pageRefsIterator = panel.getChildren().iterator();
while (!match && pageRefsIterator.hasNext()) {
PageRef currentPage = pageRefsIterator.next();
// Check if the associated pageRef
match = currentPage.getEmfPageIdentifier() != null && emfPageIdentifier.equals(currentPage.getEmfPageIdentifier());
if (match) {
pageRef = currentPage;
}
}
return pageRef;
}
}
|
