Skip to main content
summaryrefslogtreecommitdiffstats
blob: 09895212022eb97631664965ddd79dd0cfae5795 (plain) (blame)
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
/**
 * Copyright (c) 2017 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:
 *  Maged Elaasar - Initial API and implementation
 *  
 * 
 */
package org.eclipse.papyrus.infra.ui.architecture.widgets;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import org.eclipse.emf.edit.provider.ComposedAdapterFactory;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryLabelProvider;
import org.eclipse.jface.viewers.CheckStateChangedEvent;
import org.eclipse.jface.viewers.CheckboxTableViewer;
import org.eclipse.jface.viewers.CheckboxTreeViewer;
import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
import org.eclipse.jface.viewers.ICheckStateListener;
import org.eclipse.jface.viewers.ICheckStateProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.jface.window.ToolTip;
import org.eclipse.papyrus.infra.architecture.ArchitectureDomainManager;
import org.eclipse.papyrus.infra.core.architecture.ADElement;
import org.eclipse.papyrus.infra.core.architecture.merged.MergedADElement;
import org.eclipse.papyrus.infra.core.architecture.merged.MergedArchitectureContext;
import org.eclipse.papyrus.infra.core.architecture.merged.MergedArchitectureDomain;
import org.eclipse.papyrus.infra.core.architecture.merged.MergedArchitectureViewpoint;
import org.eclipse.papyrus.infra.ui.architecture.ArchitectureUIPlugin;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.ui.dialogs.ContainerCheckedTreeViewer;

/**
 * A composite widget that shows the visible architecture contexts and their viewpoints
 * and allows for changing their selection
 *
 * @since 1.0
 */
public class ArchitectureContextComposite extends Composite {
	
	/**
	 * An interface for doing updates upon selection changes 
	 */
	public static interface Updater {
		void update();
	}
	
	// allow selection of multiple contexts
	private boolean allowSeveralContexts;

	// the set of selected contexts
	private Set<String> selectedContexts;

	// the set of selected viewpoints
	private Set<String> selectedViewpoints;

	// the viewer for architecture contexts
	private CheckboxTreeViewer contextsViewer;
	
	// the viewer for architecture viewpoints
	private CheckboxTableViewer viewpointViewer;

	// the adapter factory of the architecture metadata
	private ComposedAdapterFactory composedAdapterFactory;
	
	// an updater to call upon selection changes
	private Updater updater;

	/**
	 * Constructor.
	 *
	 * @param parent
	 * @param columns
	 * @param hspan
	 * @param fill
	 * @param marginwidth
	 * @param marginheight
	 */
	public ArchitectureContextComposite(Composite parent, int columns, int hspan, int fill, int marginwidth, int marginheight) {
		super(parent, SWT.NONE);
		layoutComposite(this, parent, columns, hspan, fill, marginwidth, marginheight);
		
		composedAdapterFactory = new ComposedAdapterFactory(ComposedAdapterFactory.Descriptor.Registry.INSTANCE);
		
		Composite tableComposite = createComposite(this, 1, 1, GridData.FILL_BOTH, 0, 0);
		createLabel(tableComposite, "Architecture Contexts:", 2);

		contextsViewer = new ContainerCheckedTreeViewer(tableComposite, SWT.MULTI | SWT.BORDER);
		GridData gd = new GridData(GridData.FILL_BOTH);
		gd.heightHint = 250;
		contextsViewer.getControl().setLayoutData(gd);

		contextsViewer.setContentProvider(new ITreeContentProvider() {
			private Collection<MergedArchitectureContext> allContexts;
			@Override
			public boolean hasChildren(Object element) {
				return element instanceof MergedArchitectureDomain;
			}
			@Override
			public Object getParent(Object element) {
				return null;
			}
			@Override
			public Object[] getElements(Object inputElement) {
				Set<MergedArchitectureDomain> allDomains = new LinkedHashSet<MergedArchitectureDomain>();
				allContexts  = new LinkedHashSet<MergedArchitectureContext>();
				for (Object obj : ((Object[])inputElement)) {
					MergedArchitectureContext context = (MergedArchitectureContext)obj;
					allContexts.add(context);
					allDomains.add(context.getDomain());
				}
				return allDomains.toArray();
			}
			@Override
			public Object[] getChildren(Object parentElement) {
				if (parentElement instanceof MergedArchitectureDomain) {
					MergedArchitectureDomain domain = (MergedArchitectureDomain)parentElement;
					List<MergedArchitectureContext> possibleContexts = new ArrayList<MergedArchitectureContext>(domain.getContexts());
					possibleContexts.retainAll(allContexts);
					return possibleContexts.toArray();
				}
				return null;
			}
		});
		contextsViewer.setLabelProvider(new AdapterFactoryLabelProvider(composedAdapterFactory) {
			@Override
			public Image getImage(Object object) {
				MergedADElement element = (MergedADElement) object;
				ADElement imageObject = element.getImageObject();
				if (imageObject != null && imageObject.getIcon() != null) {
					try {
						URL image = new URL(imageObject.getIcon().toString());
						return getImageFromObject(image);                   
					} catch (MalformedURLException e) {
						ArchitectureUIPlugin.log.error(e);
						return null;                 
					}
				}
				return super.getImage(imageObject);
			}
			@Override
			public String getText(Object object) {
				return ((MergedADElement)object).getName();
			}
		});
		contextsViewer.setComparator(new ViewerComparator());
		contextsViewer.setCheckStateProvider(new ICheckStateProvider() {
			@Override
			public boolean isGrayed(Object element) {
				return false;
			}
			@Override
			public boolean isChecked(Object element) {
				if (element instanceof MergedArchitectureContext) 
					return selectedContexts.contains(((MergedArchitectureContext)element).getId());
				else
					return contextsViewer.getChecked(element);
			}
		});
		contextsViewer.addCheckStateListener(new ICheckStateListener() {
			@Override
			public void checkStateChanged(CheckStateChangedEvent event) {
				ArchitectureDomainManager manager = ArchitectureDomainManager.getInstance();
				
				if (!allowSeveralContexts) {
					if (event.getChecked() || contextsViewer.getCheckedElements().length == 0) {
						if (event.getElement() instanceof MergedArchitectureContext) {
							contextsViewer.setCheckedElements(new Object[] {event.getElement()});
						} else {
							for (TreeItem item : contextsViewer.getTree().getItems()) {
								if (item.getData() == event.getElement()) {
									contextsViewer.setCheckedElements(new Object[] {item.getItem(0).getData()});
									break;
								}
							}
						}
					}
				}
				
				selectedContexts.clear();
				for (Object element : contextsViewer.getCheckedElements()) {
					if (element instanceof MergedArchitectureContext)
						selectedContexts.add(((MergedArchitectureContext)element).getId());
				}
				
				selectedViewpoints.clear();
				for (String contextId : selectedContexts) {
					MergedArchitectureContext context = manager.getArchitectureContextById(contextId);
					Collection<MergedArchitectureViewpoint> viewpoints = context.getDefaultViewpoints();
					if (viewpoints.isEmpty())
						viewpoints = context.getViewpoints();
					for (MergedArchitectureViewpoint viewpoint : viewpoints) {
						selectedViewpoints.add(viewpoint.getId());
					}
				}
				
				updateViewpoints();
				if (updater != null)
					updater.update();
			}
		});
		
		ColumnViewerToolTipSupport.enableFor(contextsViewer, ToolTip.NO_RECREATE);

		Composite viewpointComposite = createComposite(this, 1, 1, GridData.FILL_HORIZONTAL, 0, 0);

		createLabel(viewpointComposite, "Architecture Viewpoints:", 1);
		
		viewpointViewer = CheckboxTableViewer.newCheckList(viewpointComposite, SWT.BORDER | SWT.MULTI | SWT.FULL_SELECTION);
		gd = new GridData(GridData.FILL_HORIZONTAL);
		gd.heightHint = 100;
		viewpointViewer.getControl().setLayoutData(gd);
		viewpointViewer.setContentProvider(new IStructuredContentProvider() {
			public Object[] getElements(Object inputElement) {
				Set<MergedADElement> viewpoints = new TreeSet<MergedADElement>(new Comparator<MergedADElement>() {
					@Override
					public int compare(MergedADElement o1, MergedADElement o2) {
						return o1.getName().compareTo(o2.getName());
					}
				});
				for (Object obj : ((Object[])inputElement)) {
					if (obj instanceof MergedArchitectureContext)
						viewpoints.addAll(((MergedArchitectureContext)obj).getViewpoints());
				}
				return viewpoints.toArray();
			}
		});
		viewpointViewer.setLabelProvider(new LabelProvider() {
			private ILabelProvider provider = new AdapterFactoryLabelProvider(composedAdapterFactory);
			@Override
			public Image getImage(Object object) {
				MergedADElement element = (MergedADElement) object;
				return provider.getImage(element.getImageObject());
			}
			@Override
			public String getText(Object object) {
				return ((MergedADElement)object).getName();
			}
		});
		viewpointViewer.setCheckStateProvider(new ICheckStateProvider() {
			@Override
			public boolean isGrayed(Object element) {
				return false;
			}
			@Override
			public boolean isChecked(Object element) {
				return selectedViewpoints.contains(((MergedArchitectureViewpoint)element).getId());
			}
		});
		viewpointViewer.addCheckStateListener(new ICheckStateListener() {
			@Override
			public void checkStateChanged(CheckStateChangedEvent event) {
				MergedArchitectureViewpoint viewpoint = (MergedArchitectureViewpoint) event.getElement();
				if (event.getChecked())
					selectedViewpoints.add(viewpoint.getId());
				else
					selectedViewpoints.remove(viewpoint.getId());
				updateViewpoints();
				if (updater != null)
					updater.update();
			}
		});
		updateViewpoints();
	}

	/**
	 * Sets the input object of the composite that initializes its viewers
	 * 
	 * @param input the input object
	 */
    public void setInput(Object input) {
		contextsViewer.setInput(input);
		contextsViewer.expandAll();
		updateViewpoints();
    }
    
    /**
     * Sets whether to show several context
     * 
     * @param allowSeveralContexts boolean value
     */
    public void setAllowSeveralContexts(boolean allowSeveralContexts) {
		this.allowSeveralContexts = allowSeveralContexts;
	}
	
    /**
     * @return an array of selected contexts
     */
	public String[] getSelectedContexts() {
		return selectedContexts.toArray(new String[0]);
	}

	/**
	 * Sets the selected contexts
	 * 
	 * @param selectedContexts
	 */
	public void setSelectedContexts(String[] selectedContexts) {
		this.selectedContexts = new HashSet<String>(Arrays.asList(selectedContexts));
	}
	
	/**
	 * @return an array of selected viewpoints
	 */
	public String[] getSelectedViewpoints() {
		return selectedViewpoints.toArray(new String[0]);
	}

	/**
	 * Sets the selected viewpoints
	 * 
	 * @param selectedViewpoints
	 */
	public void setSelectedViewpoints(String[] selectedViewpoints) {
		this.selectedViewpoints = new HashSet<String>(Arrays.asList(selectedViewpoints));
	}
	
	/**
	 * Sets the updater instance 
	 * 
	 * @param updater
	 */
	public void setUpdater(Updater updater) {
		this.updater = updater;
	}

	/*
	 * update the viewpoint viewer based on changes to context viewer 
	 */
	private void updateViewpoints() {
		viewpointViewer.setInput(contextsViewer.getCheckedElements());
	}

	private static Composite createComposite(Composite parent, int columns, int hspan, int fill, int marginwidth, int marginheight) {
		Composite g = new Composite(parent, SWT.NONE);
		layoutComposite(g, parent, columns, hspan, fill, marginwidth, marginheight);
		return g;
	}
	
	private static Composite layoutComposite(Composite g, Composite parent, int columns, int hspan, int fill, int marginwidth, int marginheight) {
		GridLayout layout = new GridLayout(columns, false);
		layout.marginWidth = marginwidth;
		layout.marginHeight = marginheight;
		g.setLayout(layout);
		g.setFont(parent.getFont());
		GridData gd = new GridData(fill);
		gd.horizontalSpan = hspan;
		g.setLayoutData(gd);
		return g;
	}

	private static Label createLabel(Composite parent, String text, int hspan) {
		Label l = new Label(parent, SWT.NONE);
		l.setFont(parent.getFont());
		l.setText(text);
		GridData gd = new GridData(GridData.FILL_HORIZONTAL);
		gd.horizontalSpan = hspan;
		gd.grabExcessHorizontalSpace = false;
		l.setLayoutData(gd);
		return l;
	}

}

Back to the top