Skip to main content
summaryrefslogtreecommitdiffstats
blob: aec0d2ade5ed7778178b4692795da4ecbcaafca9 (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
/*******************************************************************************
 * Copyright (c) 2008, 2011 Obeo.
 * 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:
 *     Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.emf.eef.runtime.ui.widgets;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.emf.common.notify.AdapterFactory;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryLabelProvider;
import org.eclipse.emf.eef.runtime.impl.utils.ModelViewerHelper;
import org.eclipse.emf.eef.runtime.ui.utils.EEFRuntimeUIMessages;
import org.eclipse.emf.eef.runtime.ui.widgets.settings.AdvancedEEFEditorContentProvider;
import org.eclipse.emf.eef.runtime.ui.widgets.settings.EEFEditorSettings;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.viewers.AbstractTreeViewer;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.ui.dialogs.FilteredTree;
import org.eclipse.ui.dialogs.PatternFilter;

/**
 * This dialog shows the tree of all owned element by taking in account a filter
 * 
 * @author Patrick Tessier
 * @author <a href="mailto:jerome.benois@obeo.fr">Jerome Benois</a>
 * @author <a href="mailto:stephane.bouchet@obeo.fr">Stephane Bouchet</a>
 */
public abstract class TabElementTreeSelectionDialog extends Dialog implements IPropertiesFilteredWidget {

	/**
	 * the label
	 */
	protected Label label;

	/**
	 * The selection tree.
	 */
	protected Tree tree;

	/** title of the window */
	protected String title = EEFRuntimeUIMessages.TabElementTreeSelectionDialog_title;

	/**
	 * filters
	 */
	private List<ViewerFilter> viewerFilters;

	/**
	 * business rules filters
	 */
	private List<ViewerFilter> brFilters;

	/**
	 * The adapter factory.
	 */
	protected AdapterFactory adapterFactory;

	private Composite parent;

	private Object input;

	private IStructuredSelection selection;

	/**
	 * The main resource. It's optional. The first resource is the main resource by default.
	 */
	private Resource mainResource;

	/**
	 * Constructor with parent shell and Element.
	 * 
	 * @param parentElement
	 *            the element where we look for a children
	 * @param filters
	 *            this is an array of filter see {@link ViewerFilter} or an example {@link OperationFilter}
	 * @param title
	 *            title of the window
	 * @param createElement
	 *            this is the listener to create an element
	 * @param abstractElement
	 *            it used to inform about if the element is abstract in this case the creation button does not
	 *            appear
	 * @param mainResource
	 *            the main resource.
	 */
	public TabElementTreeSelectionDialog(Object input, List<ViewerFilter> filters,
			List<ViewerFilter> brFilters, String title, AdapterFactory adapterFactory, Resource mainResource) {
		super(Display.getDefault().getActiveShell());
		// add the resize ability to the window
		setShellStyle(SWT.RESIZE | super.getShellStyle());
		this.input = input;
		this.viewerFilters = filters;
		this.brFilters = brFilters;
		this.title = title;
		this.adapterFactory = adapterFactory;
		this.mainResource = mainResource;
	}

	/**
	 * Creates the dialog area.
	 * 
	 * @param parent
	 *            composite.
	 * @return control Control.
	 */
	protected Control createDialogArea(Composite parent) {
		this.parent = parent;
		final CTabFolder tabFolder = new CTabFolder(parent, SWT.BORDER);
		tabFolder.setMaximized(true);

		CTabItem tabItem = new CTabItem(tabFolder, SWT.NULL);
		tabItem.setText(EEFRuntimeUIMessages.TabElementTreeSelectionDialog_model_resource_tab_title);
		tabItem.setControl(fillModelpage(tabFolder, false, new ViewerFilter() {
			// Filter elements only in main Resource
			@Override
			public boolean select(Viewer viewer, Object parentElement, Object element) {
				ResourceSet resourceSet = null;
				if (input instanceof ResourceSet) {
					resourceSet = (ResourceSet)input;
				} else if (input instanceof EEFEditorSettings) {
					if (((EEFEditorSettings)input).getSource().eResource() != null)
						resourceSet = ((EEFEditorSettings)input).getSource().eResource().getResourceSet();
				}
				if (resourceSet != null) {
					Resource mainResource = TabElementTreeSelectionDialog.this.mainResource != null ? TabElementTreeSelectionDialog.this.mainResource
							: resourceSet.getResources().get(0);
					if (mainResource != null && mainResource == element) {
						return true;
					}
					if (element instanceof EObject) {
						EObject eObject = (EObject)element;
						if (mainResource != null && mainResource == eObject.eResource()) {
							return true;
						}
					}
				}
				return false;
			}
		}));

		tabItem = new CTabItem(tabFolder, SWT.NULL);
		tabItem.setText(EEFRuntimeUIMessages.TabElementTreeSelectionDialog_all_resources_tab_title);
		tabItem.setControl(fillModelpage(tabFolder, true, null));

		return tabFolder;
	}

	/**
	 * Used to display a page in a tab
	 * 
	 * @param tabFolder
	 *            that contains all tabs
	 * @param specificTabFilter
	 *            a specific filter to this page
	 * @return the composite of this page
	 */
	public Control fillModelpage(CTabFolder tabFolder, final boolean showResourceItem,
			final ViewerFilter specificTabFilter) {
		Composite composite = new Composite(tabFolder, SWT.None);
		GridLayout layout = new GridLayout();
		layout.marginHeight = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_MARGIN);
		layout.marginWidth = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_MARGIN);
		layout.verticalSpacing = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_SPACING);
		layout.horizontalSpacing = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_SPACING);
		composite.setLayout(layout);

		// use pattern filter
		PatternFilter patternFilter = new TreeSelectionPatternFilter();
		patternFilter.setIncludeLeadingWildcard(true);

		FilteredTree filteredTree = new FilteredTree(composite, SWT.SINGLE | SWT.BORDER | SWT.V_SCROLL
				| SWT.RESIZE, patternFilter);
		// use of EMF facilities
		final TreeViewer treeViewer = filteredTree.getViewer();
		treeViewer.setFilters(new ViewerFilter[0]);
		treeViewer.setUseHashlookup(true);
		if (input instanceof EEFEditorSettings)
			treeViewer.setContentProvider(new AdvancedEEFEditorContentProvider(adapterFactory));
		else
			treeViewer.setContentProvider(new AdapterFactoryContentProvider(adapterFactory));

		ArrayList<ViewerFilter> filters = new ArrayList<ViewerFilter>();
		if (specificTabFilter != null) {
			filters.add(specificTabFilter);
		}
		if (viewerFilters != null && !viewerFilters.isEmpty()) {
			for (ViewerFilter filter : viewerFilters) {
				filters.add(filter);
			}
		}
		// for now, add the businessRuleFilters to the 'normal' filters
		if (brFilters != null && !brFilters.isEmpty()) {
			for (ViewerFilter filter : brFilters) {
				filters.add(filter);
			}
		}
		filters.add(patternFilter);
		ViewerFilter[] v = filters.toArray(new ViewerFilter[filters.size()]);
		treeViewer.setFilters(v);
		treeViewer.setLabelProvider(new AdapterFactoryLabelProvider(adapterFactory));

		filteredTree.setLayoutData(new GridData(550, 300));
		// handle selection change
		if (input instanceof EEFEditorSettings) {
			treeViewer.addSelectionChangedListener(new ISelectionChangedListener() {
				public void selectionChanged(SelectionChangedEvent event) {
					if (event.getSelection() instanceof IStructuredSelection) {
						// Check selection
						IStructuredSelection structuredSelection = (IStructuredSelection)event.getSelection();
						if (structuredSelection != null && !structuredSelection.isEmpty()) {
							Object o = structuredSelection.getFirstElement();
							// Check type matching
							Button okButton = getButton(IDialogConstants.OK_ID);
							if (((List<?>)((EEFEditorSettings)input).choiceOfValues(adapterFactory))
									.contains(o)) {
								selection = structuredSelection;
								if (okButton != null) {
									okButton.setEnabled(true);
								}
							} else {
								// Reject selection
								if (okButton != null) {
									okButton.setEnabled(false);
								}
							}
						}

					}
				}
			});

			// handle double click to validate
			treeViewer.addDoubleClickListener(new IDoubleClickListener() {
				public void doubleClick(DoubleClickEvent event) {
					if (selection != null && !selection.isEmpty()) {
						Object o = selection.getFirstElement();
						if (((List<?>)((EEFEditorSettings)input).choiceOfValues(adapterFactory)).contains(o)) {
							okPressed();
						}
					}
				}
			});
		}
		treeViewer.setInput(input);

		// Init selected element
		if (selection != null) {
			treeViewer.setSelection(selection);
		}

		return composite;

	}

	private class TreeSelectionPatternFilter extends PatternFilter {
		@Override
		protected boolean isParentMatch(Viewer viewer, Object element) {
			Object[] children = ((ITreeContentProvider)((AbstractTreeViewer)viewer).getContentProvider())
					.getChildren(element);
			// apply all filters
			if (viewerFilters != null && children != null) {
				// if one child match, show the parent in tree
				for (ViewerFilter viewerFilter : viewerFilters) {
					for (Object child : children) {
						if (viewerFilter.select(viewer, null, child)) {
							return super.isParentMatch(viewer, element);
						}
					}
				}
				return false;
			} else {
				return super.isParentMatch(viewer, element);
			}
		}

		@Override
		protected boolean isLeafMatch(Viewer viewer, Object element) {
			if (element instanceof EObject) {
				String labelText = ((EObject)element).toString();
				if (labelText != null) {
					return wordMatches(labelText);
				}
			}
			return false;
		}
	}

	/**
	 * Sets or clears the input for this dialog.
	 */
	public void setInput(Object input) {
		this.input = input;
		this.refresh();
	}

	public void refresh() {
		parent.pack();
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected void configureShell(Shell shell) {
		super.configureShell(shell);
		shell.setText(EEFRuntimeUIMessages.TabElementTreeSelectionDialog_shell_title + this.title);
	}

	/**
	 * @see org.eclipse.jface.dialogs.Dialog#okPressed()
	 */
	@Override
	protected void okPressed() {
		if (selection != null && !selection.isEmpty()) {
			process(selection);
			ModelViewerHelper.setLastSelection(selection);
		}
		super.okPressed();
	}

	public void setSelection(IStructuredSelection selection) {
		this.selection = selection;
	}

	public abstract void process(IStructuredSelection selection);

	public void addBusinessRuleFilter(ViewerFilter filter) {
		this.brFilters.add(filter);
	}

	public void addFilter(ViewerFilter filter) {
		this.viewerFilters.add(filter);
	}

	public void removeBusinessRuleFilter(ViewerFilter filter) {
		this.brFilters.remove(filter);
	}

	public void removeFilter(ViewerFilter filter) {
		this.viewerFilters.remove(filter);
	}

}

Back to the top