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
|
/*******************************************************************************
* Copyright (c) 2009 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.e4.ui.workbench.renderers.swt;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import org.eclipse.e4.core.contexts.IEclipseContext;
import org.eclipse.e4.core.contexts.RunAndTrack;
import org.eclipse.e4.ui.internal.workbench.ContributionsAnalyzer;
import org.eclipse.e4.ui.model.application.MApplication;
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.basic.MTrimBar;
import org.eclipse.e4.ui.model.application.ui.menu.MToolBar;
import org.eclipse.e4.ui.model.application.ui.menu.MToolBarContribution;
import org.eclipse.e4.ui.model.application.ui.menu.MToolBarElement;
import org.eclipse.e4.ui.model.application.ui.menu.MToolBarSeparator;
import org.eclipse.e4.ui.model.application.ui.menu.MToolControl;
import org.eclipse.e4.ui.workbench.modeling.ExpressionContext;
import org.eclipse.jface.layout.RowLayoutFactory;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
/**
* Create a contribute part.
*/
public class ToolBarRenderer extends SWTPartRenderer {
private MApplication application;
HashMap<MToolBar, ArrayList<ArrayList<MToolBarElement>>> pendingCleanup = new HashMap<MToolBar, ArrayList<ArrayList<MToolBarElement>>>();
/*
* (non-Javadoc)
*
* @see
* org.eclipse.e4.ui.workbench.renderers.swt.SWTPartRenderer#init(org.eclipse
* .e4.core.contexts.IEclipseContext)
*/
@Override
public void init(IEclipseContext context) {
super.init(context);
application = context.get(MApplication.class);
}
public Object createWidget(final MUIElement element, Object parent) {
if (!(element instanceof MToolBar) || !(parent instanceof Composite))
return null;
// HACK!! This should be done using a separate renderer
Composite intermediate = new Composite((Composite) parent, SWT.NONE);
createToolbar(element, intermediate);
intermediate.addDisposeListener(new DisposeListener() {
public void widgetDisposed(DisposeEvent e) {
cleanUp((MToolBar) element);
}
});
return intermediate;
}
ToolBar createToolbar(final MUIElement element, Composite intermediate) {
int orientation = getOrientation(element);
RowLayout layout = RowLayoutFactory.fillDefaults().wrap(false)
.spacing(0).type(orientation).create();
layout.marginLeft = 3;
layout.center = true;
intermediate.setLayout(layout);
// new Label(intermediate, (orientation == SWT.HORIZONTAL ? SWT.VERTICAL
// : SWT.HORIZONTAL) | SWT.SEPARATOR);
ToolBar separatorToolBar = new ToolBar(intermediate, orientation
| SWT.WRAP | SWT.FLAT | SWT.RIGHT);
new ToolItem(separatorToolBar, SWT.SEPARATOR);
return new ToolBar(intermediate, orientation | SWT.WRAP | SWT.FLAT
| SWT.RIGHT);
}
int getOrientation(final MUIElement element) {
MUIElement theParent = element.getParent();
if (theParent instanceof MTrimBar) {
MTrimBar trimContainer = (MTrimBar) theParent;
SideValue side = trimContainer.getSide();
if (side.getValue() == SideValue.LEFT_VALUE
|| side.getValue() == SideValue.RIGHT_VALUE)
return SWT.VERTICAL;
}
return SWT.HORIZONTAL;
}
public Object getUIContainer(MUIElement childElement) {
Composite intermediate = (Composite) super.getUIContainer(childElement);
if (intermediate == null || intermediate.isDisposed()) {
return null;
}
ToolBar toolbar = findToolbar(intermediate);
if (toolbar == null) {
toolbar = createToolbar(childElement.getParent(), intermediate);
}
return toolbar;
}
ToolBar findToolbar(Composite intermediate) {
if (!intermediate.isDisposed()) {
Control[] children = intermediate.getChildren();
int length = children.length;
if (length > 0 && children[length - 1] instanceof ToolBar) {
return (ToolBar) children[length - 1];
}
}
return null;
}
@Override
public void hideChild(MElementContainer<MUIElement> parentElement,
MUIElement child) {
super.hideChild(parentElement, child);
// Since there's no place to 'store' a child that's not in a menu
// we'll blow it away and re-create on an add
Widget widget = (Widget) child.getWidget();
if (widget != null && !widget.isDisposed()) {
widget.dispose();
}
ToolBar toolbar = (ToolBar) getUIContainer(child);
if (toolbar != null && !toolbar.isDisposed()) {
toolbar.getShell().layout(new Control[] { toolbar }, SWT.DEFER);
}
disposeToolbarIfNecessary(parentElement);
}
private void disposeToolbarIfNecessary(MUIElement element) {
Composite composite = (Composite) element.getWidget();
ToolBar toolbar = findToolbar(composite);
if (toolbar != null && hasOnlySeparators(toolbar)) {
toolbar.dispose();
if (composite.getChildren().length > 0) {
composite.getChildren()[0].dispose();
}
}
}
boolean hasOnlySeparators(ToolBar toolbar) {
ToolItem[] children = toolbar.getItems();
for (ToolItem toolItem : children) {
if ((toolItem.getStyle() & SWT.SEPARATOR) == 0) {
return false;
} else if (toolItem.getControl() != null
&& toolItem.getControl().getData(OWNING_ME) instanceof MToolControl) {
return false;
}
}
return true;
}
@Override
public void childRendered(MElementContainer<MUIElement> parentElement,
MUIElement element) {
super.childRendered(parentElement, element);
ToolBar toolbar = (ToolBar) getUIContainer(element);
if (toolbar != null && !toolbar.isDisposed()) {
toolbar.getShell().layout(new Control[] { toolbar }, SWT.DEFER);
}
}
@Override
public void processContents(MElementContainer<MUIElement> container) {
super.processContents(container);
IEclipseContext ctx = getContext(container);
ExpressionContext eContext = new ExpressionContext(ctx);
ArrayList<MToolBarContribution> toContribute = new ArrayList<MToolBarContribution>();
MElementContainer<?> toolbarObj = container;
MToolBar toolbarModel = (MToolBar) toolbarObj;
ContributionsAnalyzer.gatherToolBarContributions(toolbarModel,
application.getToolBarContributions(),
toolbarModel.getElementId(), toContribute, eContext);
addToolBarContributions(toolbarModel, toContribute, ctx, eContext,
pendingCleanup);
}
@Override
public void postProcess(MUIElement element) {
super.postProcess(element);
disposeToolbarIfNecessary(element);
}
public static void addToolBarContributions(
final MToolBar toolbarModel,
ArrayList<MToolBarContribution> toContribute,
IEclipseContext ctx,
final ExpressionContext eContext,
HashMap<MToolBar, ArrayList<ArrayList<MToolBarElement>>> pendingCleanup) {
HashSet<String> existingSeparatorNames = new HashSet<String>();
for (MToolBarElement child : toolbarModel.getChildren()) {
String elementId = child.getElementId();
if (child instanceof MToolBarSeparator && elementId != null) {
existingSeparatorNames.add(elementId);
}
}
boolean done = toContribute.size() == 0;
while (!done) {
ArrayList<MToolBarContribution> curList = new ArrayList<MToolBarContribution>(
toContribute);
int retryCount = toContribute.size();
toContribute.clear();
for (final MToolBarContribution contribution : curList) {
final ArrayList<MToolBarElement> toRemove = new ArrayList<MToolBarElement>();
if (!ContributionsAnalyzer.processAddition(toolbarModel,
contribution, toRemove, existingSeparatorNames)) {
toContribute.add(contribution);
} else {
if (contribution.getVisibleWhen() != null) {
ctx.runAndTrack(new RunAndTrack() {
@Override
public boolean changed(IEclipseContext context) {
if (!toolbarModel.isToBeRendered()
|| !toolbarModel.isVisible()
|| toolbarModel.getWidget() == null) {
return false;
}
boolean rc = ContributionsAnalyzer.isVisible(
contribution, eContext);
for (MToolBarElement child : toRemove) {
child.setToBeRendered(rc);
}
return true;
}
});
}
ArrayList<ArrayList<MToolBarElement>> lists = pendingCleanup
.get(toolbarModel);
if (lists == null) {
lists = new ArrayList<ArrayList<MToolBarElement>>();
pendingCleanup.put(toolbarModel, lists);
}
lists.add(toRemove);
}
}
// We're done if the retryList is now empty (everything done) or
// if the list hasn't changed at all (no hope)
done = (toContribute.size() == 0)
|| (toContribute.size() == retryCount);
}
}
protected void cleanUp(MToolBar element) {
ArrayList<ArrayList<MToolBarElement>> lists = pendingCleanup
.remove(element);
if (lists == null) {
return;
}
for (ArrayList<MToolBarElement> list : lists) {
for (MToolBarElement child : list) {
element.getChildren().remove(child);
}
}
}
}
|
