blob: 82ca6d72ef02ba7cb73e33c0ca6ab816ec7dcde1 (
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
|
/**
* Copyright (c) 2012 Mia-Software.
*
* All rights reserved. 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:
* Alban Ménager (Soft-Maint) - Bug 387470 - [EFacet][Custom] Editors
* Grégoire Dupé (Mia-Software) - Bug 387470 - [EFacet][Custom] Editors
*/
package org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.widget.command;
import java.util.Map;
import org.eclipse.papyrus.emf.facet.util.ui.internal.exported.dialog.IDialog;
import org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.dialog.AbstractDialog;
import org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.dialog.SynchronizedAbstractDialog;
import org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.widget.component.CreateElementWidget;
import org.eclipse.papyrus.emf.facet.util.ui.internal.widget.metaclass.FilteredElementSelectionWidget;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
/**
* This abstract class allows the user to select or create an element (the
* concretes classes extending this abstract class will specify the type for
* this elements).</p>
*
* The widget contains two composite:
* <nl>
* <li> {@link FilteredElementSelectionWidget} : display a filtered list with the elements returned by {@link #getElements()}</li>
* <li> {@link CreateElementWidget} : create a "new..." button, and display the dialog returned by {@link #createDialog()} when clicked</li>
* </nl>
*
* @see GetOrCreateFacetSetWidget
* @see GetOrCreateFacetWidget
* @see GetOrCreateOperationWidget
* @see FilteredElementSelectionWidget
* @see CreateElementWidget
* @since 0.3
*/
public abstract class AbstractGetOrCreateFilteredElementCommandWidget<T extends Object, W extends Object>
extends AbstractCommandWidget implements IGetOrCreateFilteredElementCommmandWidget<T, W> {
private static final int COLUMNS_NUMBER = 2;
private FilteredElementSelectionWidget elementSelection;
private CreateElementWidget<W> createElementW;
/**
* Constructor. Initialize a new layout containing {@value #COLUMN_NUMBER} columns.
*
* @param parent
* the parent of this widget.
* @param editingDomain
* the current editing domain.
* @param properties
* the properties.
*/
protected AbstractGetOrCreateFilteredElementCommandWidget(
final Composite parent) {
super(parent);
this.setLayout(new GridLayout(COLUMNS_NUMBER, false));
}
@Override
protected void addSubWidgets() {
final Object[] array = getElements().keySet().toArray();
this.elementSelection = new FilteredElementSelectionWidget(this, array);
addSubWidget(this.elementSelection);
final IDialog<W> dialog = createDialog();
if (dialog != null) {
this.createElementW = new CreateElementWidget<W>(this, dialog);
addSubWidget(this.createElementW);
}
}
/**
* This method must return the all the elements that the user can choose
* (with the name to display has the key to the map). The method {@link #getSuperFacetSet(Object)} can be useful.
*
* @return a map of the elements to display.
*/
protected abstract Map<String, T> getElements();
/**
* @return the dialog that the "New..." button of this widget will open.
* Null if you want no "New..." button.
*
* @see AbstractDialog
*/
protected abstract IDialog<W> createDialog();
/**
* Update the filtered list. The list will be updated with the elements
* returned by {@link #getElements()}.
*/
public void updateFilteredList() {
this.elementSelection.setElements(getElements().keySet().toArray());
}
/*
* (non-Javadoc)
*
* @see org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.widget.command.IGetOrCreateFilteredElementCommmandWidget#getElementSelected()
*/
public T getElementSelected() {
T result = null;
final Object selectedElement = this.elementSelection
.getFirstSelectedElement();
if (selectedElement != null) {
final String elementName = selectedElement.toString();
result = getElements().get(elementName);
}
return result;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.widget.command.IGetOrCreateFilteredElementCommmandWidget#selectElement(T)
*/
public void selectElement(final T element) {
Object[] selectionsParam = new Object[1];
for (String key : getElements().keySet()) {
if (getElements().get(key) == element) {
selectionsParam[0] = key;
this.elementSelection.getFilteredList().setSelection(
selectionsParam);
break;
}
}
}
public void selectElementByName(final String name) {
final T element = this.getElements().get(name);
selectElement(element);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.papyrus.emf.facet.util.ui.internal.exported.util.widget.command.IGetOrCreateFilteredElementCommmandWidget#pressNewButton()
*/
public IDialog<W> pressNewButton() {
return new SynchronizedAbstractDialog<W>(
this.createElementW.pressNewButton(), this.getDisplay());
}
}
|
