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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
/*******************************************************************************
* Copyright (c) 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
******************************************************************************/
package org.eclipse.ui.internal.e4.migration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.annotation.PostConstruct;
import javax.inject.Inject;
import org.eclipse.e4.ui.model.application.ui.MElementContainer;
import org.eclipse.e4.ui.model.application.ui.MUIElement;
import org.eclipse.e4.ui.model.application.ui.SideValue;
import org.eclipse.e4.ui.model.application.ui.advanced.MArea;
import org.eclipse.e4.ui.model.application.ui.advanced.MPerspective;
import org.eclipse.e4.ui.model.application.ui.advanced.MPerspectiveStack;
import org.eclipse.e4.ui.model.application.ui.advanced.MPlaceholder;
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
import org.eclipse.e4.ui.model.application.ui.basic.MPartSashContainer;
import org.eclipse.e4.ui.model.application.ui.basic.MPartStack;
import org.eclipse.e4.ui.model.application.ui.basic.MStackElement;
import org.eclipse.e4.ui.model.application.ui.basic.MTrimBar;
import org.eclipse.e4.ui.model.application.ui.basic.MTrimmedWindow;
import org.eclipse.e4.ui.model.application.ui.basic.MWindow;
import org.eclipse.e4.ui.model.application.ui.menu.MToolControl;
import org.eclipse.e4.ui.model.application.ui.menu.impl.MenuFactoryImpl;
import org.eclipse.e4.ui.workbench.IPresentationEngine;
import org.eclipse.e4.ui.workbench.addons.minmax.TrimStack;
import org.eclipse.e4.ui.workbench.modeling.EModelService;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.eclipse.e4.ui.workbench.renderers.swt.TrimBarLayout;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.ui.IPageLayout;
import org.eclipse.ui.internal.IPreferenceConstants;
import org.eclipse.ui.internal.Workbench;
import org.eclipse.ui.internal.WorkbenchWindow;
import org.eclipse.ui.internal.e4.compatibility.CompatibilityEditor;
import org.eclipse.ui.internal.e4.compatibility.CompatibilityPart;
import org.eclipse.ui.internal.e4.compatibility.ModeledPageLayout;
import org.eclipse.ui.internal.e4.compatibility.ModeledPageLayoutUtils;
import org.eclipse.ui.internal.e4.migration.WindowReader.EditorReader;
import org.eclipse.ui.internal.e4.migration.WindowReader.ViewReader;
import org.eclipse.ui.internal.registry.StickyViewDescriptor;
import org.eclipse.ui.internal.registry.ViewRegistry;
public class WindowBuilder {
private MWindow window;
private List<MUIElement> sharedElements;
private MPartSashContainer mainSash;
@Inject
private WindowReader windowReader;
@Inject
private EModelService modelService;
@Inject
private IModelBuilderFactory factory;
private ModeledPageLayoutUtils layoutUtils;
private MArea editorArea;
private List<MPerspective> perspectives;
public static String PERSPECTIVES = "perspectives"; //$NON-NLS-1$
@PostConstruct
private void postConstruct() {
layoutUtils = new ModeledPageLayoutUtils(modelService);
}
MWindow createWindow() {
create();
populate();
return window;
}
boolean isSelected() {
return windowReader.isSelected();
}
boolean isWelcomePageOpen() {
return windowReader.isWelcomePageOpen();
}
private void create() {
window = modelService.createModelElement(MTrimmedWindow.class);
Rectangle bounds = windowReader.getBounds();
window.setX(bounds.x);
window.setY(bounds.y);
window.setWidth(bounds.width);
window.setHeight(bounds.height);
window.getTags().add("topLevel"); //$NON-NLS-1$
String coolbarVisible = Boolean.TRUE.toString();
if (!windowReader.isCoolbarVisible() && !isWelcomePageOpen()) {
coolbarVisible = Boolean.FALSE.toString();
}
window.getPersistedState().put(IPreferenceConstants.COOLBAR_VISIBLE, coolbarVisible);
window.getPersistedState().put(IPreferenceConstants.PERSPECTIVEBAR_VISIBLE, coolbarVisible);
// necessary to force correct order of window initial
// rendering when there is no perspective
if (windowReader.isStatusBarVisible()) {
MTrimBar statusBar = modelService.getTrim((MTrimmedWindow) window, SideValue.BOTTOM);
if (windowReader.hasStatusLine()) {
MToolControl statusLine = modelService.createModelElement(MToolControl.class);
statusLine.setElementId(WorkbenchWindow.STATUS_LINE_ID);
statusLine.setContributionURI(WorkbenchWindow.TRIM_CONTRIBUTION_URI);
statusLine.getTags().add(TrimBarLayout.SPACER);
statusBar.getChildren().add(statusLine);
}
}
List<String> tags = window.getTags();
if (windowReader.isMinimized()) {
tags.add(IPresentationEngine.WINDOW_MINIMIZED_TAG);
} else if (windowReader.isMaximized()) {
tags.add(IPresentationEngine.WINDOW_MAXIMIZED_TAG);
}
sharedElements = window.getSharedElements();
}
private void populate() {
addEditorArea();
addEditors();
addViews();
perspectives = new ArrayList<>();
mainSash = modelService.createModelElement(MPartSashContainer.class);
mainSash.setHorizontal(true);
MPerspectiveStack perspectiveStack = createPerspectiveStack();
mainSash.getChildren().add(perspectiveStack);
mainSash.setSelectedElement(perspectiveStack);
window.getChildren().add(mainSash);
window.setSelectedElement(mainSash);
for (PerspectiveReader perspReader : windowReader.getPerspectiveReaders()) {
PerspectiveBuilder builder = factory.createPerspectiveBuilder(perspReader);
MPerspective perspective = builder.createPerspective(windowReader.getDefaultFastViewSide());
perspectiveStack.getChildren().add(perspective);
MPlaceholder eaPlaceholder = builder.getEditorAreaPlaceholder();
if (eaPlaceholder != null) {
eaPlaceholder.setRef(editorArea);
}
for (MPlaceholder viewPlaceholder : builder.getPlaceholders()) {
String id = viewPlaceholder.getElementId();
if (id != null) {
viewPlaceholder.setRef(getSharedView(id));
}
}
perspectives.add(perspective);
}
String activePerspectiveId = windowReader.getActivePerspectiveId();
if (activePerspectiveId != null) {
for (MPerspective persp : perspectiveStack.getChildren()) {
String id = persp.getElementId();
String originalId = (String) persp.getTransientData().get(PerspectiveBuilder.ORIGINAL_ID);
if (originalId != null) {
id = originalId;
}
if (activePerspectiveId.equals(id)) {
perspectiveStack.setSelectedElement(persp);
createTrimBars(persp);
break;
}
}
}
addStickyFolder();
window.getTransientData().put(PERSPECTIVES, perspectives);
}
private void createTrimBars(MPerspective perspective) {
// Find any minimized stacks and show their trim
List<MUIElement> minimizedElements = modelService.findElements(perspective, null, MUIElement.class,
Arrays.asList(IPresentationEngine.MINIMIZED));
for (MUIElement element : minimizedElements) {
createTrim(element, perspective);
}
}
private int getBarIndex(MUIElement element, String trimStr) {
if (trimStr == null)
return -1;
String[] stacks = trimStr.split("#"); //$NON-NLS-1$
for (String stackInfo : stacks) {
String[] vals = stackInfo.split(" "); //$NON-NLS-1$
if (vals[0].equals(element.getElementId())) {
return Integer.parseInt(vals[1]);
}
}
return -1;
}
private int getIndex(MUIElement element, String trimStr) {
if (trimStr == null)
return -1;
String[] stacks = trimStr.split("#"); //$NON-NLS-1$
for (String stackInfo : stacks) {
String[] vals = stackInfo.split(" "); //$NON-NLS-1$
if (vals[0].equals(element.getElementId())) {
return Integer.parseInt(vals[2]);
}
}
return -1;
}
private void createTrim(MUIElement element, MPerspective perspective) {
if (!(window instanceof MTrimmedWindow)) {
return;
}
String trimStr = perspective.getPersistedState().get("trims"); //$NON-NLS-1$
MTrimmedWindow win = (MTrimmedWindow) window;
// Is there already a TrimControl there ?
String trimId = element.getElementId() + getMinimizedElementSuffix(perspective);
MToolControl trimStack = (MToolControl) modelService.find(trimId, window);
if (trimStack == null) {
trimStack = MenuFactoryImpl.eINSTANCE.createToolControl();
trimStack.setElementId(trimId);
trimStack.setContributionURI(TrimStack.CONTRIBUTION_URI);
trimStack.getTags().add("TrimStack"); //$NON-NLS-1$
// Check if we have a cached location
MTrimBar bar = getBarForElement(element, win, trimStr);
int index = getIndex(element, trimStr);
if (index == -1 || index >= bar.getChildren().size())
bar.getChildren().add(trimStack);
else
bar.getChildren().add(index, trimStack);
bar.setVisible(true);
} else {
// get the parent trim bar, see bug 320756
MUIElement parent = trimStack.getParent();
parent.setVisible(true);
trimStack.setToBeRendered(true);
}
}
private String getMinimizedElementSuffix(MPerspective perspective) {
String id = "(minimized)"; //$NON-NLS-1$
if (perspective != null) {
id = '(' + perspective.getElementId() + ')';
}
return id;
}
private MTrimBar getBarForElement(MUIElement element, MTrimmedWindow window, String trimStr) {
SideValue side = SideValue.get(getBarIndex(element, trimStr));
if (side == null) {
side = SideValue.BOTTOM;
}
MTrimBar bar = modelService.getTrim(window, side);
return bar;
}
private void addEditors() {
Map<MPartStack, InfoReader> stackToReader = new HashMap<>();
// add stacks to shared area
List<InfoReader> stackReaders = windowReader.getEditorStacks();
if (stackReaders.isEmpty()) {
// create default stack
MPartStack editorStack = modelService.createModelElement(MPartStack.class);
editorStack.getTags().add(ModeledPageLayout.EDITOR_STACK_TAG);
editorArea.getChildren().add(editorStack);
}
for (InfoReader stackReader : stackReaders) {
stackToReader.put(addEditorStack(stackReader), stackReader);
}
editorArea.setSelectedElement(editorArea.getChildren().get(0));
for (EditorReader editorReader : windowReader.getEditors()) {
MPart editor = modelService.createModelElement(MPart.class);
editor.setElementId(CompatibilityEditor.MODEL_ELEMENT_ID);
editor.setContributionURI(CompatibilityPart.COMPATIBILITY_EDITOR_URI);
editor.setLabel(editorReader.getLabel());
editor.getPersistedState().put(Workbench.MEMENTO_KEY,
new MementoSerializer(editorReader.getMemento()).serialize());
List<String> tags = editor.getTags();
tags.add(Workbench.EDITOR_TAG);
tags.add(EPartService.REMOVE_ON_HIDE_TAG);
tags.add(editorReader.getType());
MPartStack stack = (MPartStack) modelService.find(editorReader.getStackId(), editorArea);
stack.getChildren().add(editor);
if (editorReader.isSelected()) {
stack.setSelectedElement(editor);
}
}
// restore order of editors in stacks
for (Entry<MPartStack, InfoReader> entry : stackToReader.entrySet()) {
MPartStack editorStack = entry.getKey();
if (editorStack.getChildren().size() < 2) {
continue;
}
InfoReader stackReader = entry.getValue();
if (stackReader == null) {
continue;
}
int[] partOrder = stackReader.getPartOrder();
List<MStackElement> stackChildren = editorStack.getChildren();
List<MStackElement> originalOrder = new ArrayList<>(stackChildren);
MStackElement selectedElement = editorStack.getSelectedElement();
stackChildren.clear();
for (int element : partOrder) {
stackChildren.add(originalOrder.get(element));
}
if (selectedElement != null) {
editorStack.setSelectedElement(selectedElement);
}
}
}
private MPartStack addEditorStack(InfoReader info) {
MPartStack stack = layoutUtils.createStack(info.getId(), true);
if (info.isRelativelyPositioned()) {
MUIElement refElement = modelService.find(info.getRelative(), editorArea);
MElementContainer<?> parent = refElement.getParent();
if (parent instanceof MPartStack) {
refElement = parent;
}
layoutUtils.insert(stack, refElement, layoutUtils.plRelToSwt(info.getRelationship()), info.getRatio());
} else {
editorArea.getChildren().add(stack);
}
return stack;
}
private void addViews() {
for (ViewReader viewReader : windowReader.getViews()) {
sharedElements.add(createView(viewReader));
}
}
private MPart createView(ViewReader viewReader) {
MPart view = modelService.createModelElement(MPart.class);
view.setElementId(viewReader.getId());
view.setContributionURI(CompatibilityPart.COMPATIBILITY_VIEW_URI);
view.setLabel(viewReader.getLabel());
view.getTags().add(ViewRegistry.VIEW_TAG);
view.getPersistedState().put(Workbench.MEMENTO_KEY,
new MementoSerializer(viewReader.getViewState()).serialize());
return view;
}
private void addEditorArea() {
editorArea = modelService.createModelElement(MArea.class);
sharedElements.add(editorArea);
editorArea.setElementId(IPageLayout.ID_EDITOR_AREA);
}
private MPerspectiveStack createPerspectiveStack() {
MPerspectiveStack perspStack = modelService.createModelElement(MPerspectiveStack.class);
perspStack.setElementId("PerspectiveStack"); //$NON-NLS-1$
return perspStack;
}
private void addStickyFolder() {
MPartStack stickyFolder = modelService.createModelElement(MPartStack.class);
stickyFolder.setElementId(StickyViewDescriptor.STICKY_FOLDER_RIGHT);
stickyFolder.setContainerData("2500"); //$NON-NLS-1$
stickyFolder.setToBeRendered(false);
mainSash.getChildren().add(stickyFolder);
}
private MPart getSharedView(String id) {
MPart part = null;
for (MUIElement element : sharedElements) {
if (id.equals(element.getElementId()) && element instanceof MPart) {
part = (MPart) element;
break;
}
}
/*
* if (part == null) { part = modelService.createModelElement(MPart.class);
* part.setElementId(id);
* part.setContributionURI(CompatibilityPart.COMPATIBILITY_VIEW_URI);
* part.getTags().add(ViewRegistry.VIEW_TAG); sharedElements.add(part); }
*/
return part;
}
}
|
