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
|
/*******************************************************************************
* Copyright (c) 2000, 2018 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.dialogs;
import org.eclipse.jface.dialogs.IDialogSettings;
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.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.wizard.IWizardNode;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Table;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.internal.WorkbenchMessages;
import org.eclipse.ui.model.AdaptableList;
import org.eclipse.ui.model.WorkbenchLabelProvider;
import org.eclipse.ui.model.WorkbenchViewerComparator;
/**
* Abstract implementation of a wizard selection page which simply displays a
* list of specified wizard elements and allows the user to select one to be
* launched. Subclasses just need to provide a method which creates an
* appropriate wizard node based upon a user selection.
*/
public abstract class WorkbenchWizardListSelectionPage extends
WorkbenchWizardSelectionPage implements ISelectionChangedListener,
IDoubleClickListener {
// id constants
private static final String DIALOG_SETTING_SECTION_NAME = "WizardListSelectionPage."; //$NON-NLS-1$
private static final int SIZING_LISTS_HEIGHT = 200;
private static final String STORE_SELECTED_WIZARD_ID = DIALOG_SETTING_SECTION_NAME
+ "STORE_SELECTED_WIZARD_ID"; //$NON-NLS-1$
private TableViewer viewer;
private String message;
/**
* Creates a <code>WorkbenchWizardListSelectionPage</code>.
*
* @param aWorkbench the current workbench
* @param currentSelection the workbench's current resource selection
* @param wizardElements the collection of <code>WorkbenchWizardElements</code>
* to display for selection
* @param message the message to display above the selection list
* @param triggerPointId the trigger point id
*/
protected WorkbenchWizardListSelectionPage(IWorkbench aWorkbench,
IStructuredSelection currentSelection,
AdaptableList wizardElements, String message, String triggerPointId) {
super(
"singleWizardSelectionPage", aWorkbench, currentSelection, wizardElements, triggerPointId); //$NON-NLS-1$
setDescription(WorkbenchMessages.WizardList_description);
this.message = message;
}
@Override
public void createControl(Composite parent) {
Font font = parent.getFont();
// create composite for page.
Composite outerContainer = new Composite(parent, SWT.NONE);
outerContainer.setLayout(new GridLayout());
outerContainer.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_FILL
| GridData.HORIZONTAL_ALIGN_FILL));
outerContainer.setFont(font);
Label messageLabel = new Label(outerContainer, SWT.NONE);
messageLabel.setText(message);
messageLabel.setFont(font);
createViewer(outerContainer);
layoutTopControl(viewer.getControl());
restoreWidgetValues();
setControl(outerContainer);
}
/**
* Create a new viewer in the parent.
*
* @param parent the parent <code>Composite</code>.
*/
private void createViewer(Composite parent) {
//Create a table for the list
Table table = new Table(parent, SWT.BORDER);
table.setFont(parent.getFont());
// the list viewer
viewer = new TableViewer(table);
viewer.setContentProvider(new WizardContentProvider());
viewer.setLabelProvider(new WorkbenchLabelProvider());
viewer.setComparator(new WorkbenchViewerComparator());
viewer.addSelectionChangedListener(this);
viewer.addDoubleClickListener(this);
viewer.setInput(wizardElements);
}
/**
* Returns an <code>IWizardNode</code> representing the specified
* workbench wizard which has been selected by the user. <b>Subclasses
* </b> must override this abstract implementation.
*
* @param element the wizard element that an <code>IWizardNode</code> is
* needed for
* @return org.eclipse.jface.wizards.IWizardNode
*/
protected abstract IWizardNode createWizardNode(
WorkbenchWizardElement element);
/**
* An item in a viewer has been double-clicked.
*/
@Override
public void doubleClick(DoubleClickEvent event) {
selectionChanged(new SelectionChangedEvent(event.getViewer(), event
.getViewer().getSelection()));
getContainer().showPage(getNextPage());
}
/**
* Layout the top control.
*
* @param control the control.
* @since 3.0
*/
private void layoutTopControl(Control control) {
GridData data = new GridData(GridData.FILL_BOTH);
int availableRows = DialogUtil.availableRows(control.getParent());
//Only give a height hint if the dialog is going to be too small
if (availableRows > 50) {
data.heightHint = SIZING_LISTS_HEIGHT;
} else {
data.heightHint = availableRows * 3;
}
control.setLayoutData(data);
}
/**
* Uses the dialog store to restore widget values to the values that they
* held last time this wizard was used to completion.
*/
private void restoreWidgetValues() {
IDialogSettings settings = getDialogSettings();
if (settings == null) {
return;
}
String wizardId = settings.get(STORE_SELECTED_WIZARD_ID);
WorkbenchWizardElement wizard = findWizard(wizardId);
if (wizard == null) {
return;
}
StructuredSelection selection = new StructuredSelection(wizard);
viewer.setSelection(selection);
}
/**
* Since Finish was pressed, write widget values to the dialog store so
* that they will persist into the next invocation of this wizard page
*/
public void saveWidgetValues() {
IStructuredSelection sel = viewer.getStructuredSelection();
if (sel.size() > 0) {
WorkbenchWizardElement selectedWizard = (WorkbenchWizardElement) sel
.getFirstElement();
getDialogSettings().put(STORE_SELECTED_WIZARD_ID,
selectedWizard.getId());
}
}
/**
* Notes the newly-selected wizard element and updates the page
* accordingly.
*
* @param event the selection changed event
*/
@Override
public void selectionChanged(SelectionChangedEvent event) {
setErrorMessage(null);
IStructuredSelection selection = event.getStructuredSelection();
WorkbenchWizardElement currentWizardSelection = (WorkbenchWizardElement) selection
.getFirstElement();
if (currentWizardSelection == null) {
setMessage(null);
setSelectedNode(null);
return;
}
setSelectedNode(createWizardNode(currentWizardSelection));
setMessage(currentWizardSelection.getDescription());
}
}
|
