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
|
/*******************************************************************************
* Copyright (c) 2007, 2018 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
* Red Hat Inc. - Bug 460967
*******************************************************************************/
package org.eclipse.equinox.internal.p2.ui.admin;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.equinox.internal.p2.ui.actions.RefreshAction;
import org.eclipse.equinox.internal.p2.ui.admin.preferences.PreferenceConstants;
import org.eclipse.equinox.internal.p2.ui.viewers.*;
import org.eclipse.equinox.p2.operations.ProvisioningJob;
import org.eclipse.equinox.p2.ui.ProvisioningUI;
import org.eclipse.jface.action.*;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.viewers.*;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.*;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IWorkbenchActionConstants;
import org.eclipse.ui.part.ViewPart;
import org.eclipse.ui.progress.IWorkbenchSiteProgressService;
/**
* This class supports the common characteristics for views that manipulate
* provisioning models.
*
* @since 3.4
*/
abstract class ProvView extends ViewPart {
protected TreeViewer viewer;
RefreshAction refreshAction;
private IPropertyChangeListener preferenceListener;
protected Display display;
protected ProvisioningUI ui;
/**
* The constructor.
*/
public ProvView() {
// constructor
}
/**
* Create and initialize the viewer
*/
@Override
public void createPartControl(Composite parent) {
// Store the display so we can make async calls from listeners
display = parent.getDisplay();
viewer = new TreeViewer(parent, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL | SWT.FULL_SELECTION);
viewer.getTree().setHeaderVisible(true);
configureViewer(viewer);
// Do this after setting up sorters, filters, etc.
// Otherwise it will retrieve content on each change.
viewer.setContentProvider(getContentProvider());
// Now set up the visuals, columns before labels.
setTreeColumns(viewer.getTree());
viewer.setLabelProvider(getLabelProvider());
// Input is last
viewer.setInput(getInput());
addListeners();
makeActions();
hookContextMenu();
hookDoubleClickAction();
contributeToActionBars();
}
private void hookContextMenu() {
MenuManager menuMgr = new MenuManager("#PopupMenu"); //$NON-NLS-1$
menuMgr.setRemoveAllWhenShown(true);
menuMgr.addMenuListener(manager -> {
ProvView.this.fillContextMenu(manager);
manager.add(new Separator());
manager.add(refreshAction);
manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));
});
Menu menu = menuMgr.createContextMenu(viewer.getControl());
viewer.getControl().setMenu(menu);
getSite().registerContextMenu(menuMgr, viewer);
}
private void hookDoubleClickAction() {
viewer.addDoubleClickListener(event -> {
IAction action = getDoubleClickAction();
if (action != null && action.isEnabled()) {
action.run();
}
});
}
private void contributeToActionBars() {
IActionBars bars = getViewSite().getActionBars();
IMenuManager manager = bars.getMenuManager();
fillLocalPullDown(manager);
manager.add(new Separator());
manager.add(refreshAction);
fillLocalToolBar(bars.getToolBarManager());
}
protected abstract void fillLocalPullDown(IMenuManager manager);
protected abstract void fillContextMenu(IMenuManager manager);
protected abstract void fillLocalToolBar(IToolBarManager manager);
protected abstract IAction getDoubleClickAction();
protected void makeActions() {
refreshAction = new RefreshAction(ProvisioningUI.getDefaultUI(), viewer, viewer.getControl()) {
@Override
protected void refresh() {
refreshAll(true);
}
};
refreshAction.setToolTipText(ProvAdminUIMessages.ProvView_RefreshCommandTooltip);
}
/**
* Passing the focus request to the viewer's control.
*/
@Override
public void setFocus() {
viewer.getControl().setFocus();
}
@Override
public void dispose() {
removeListeners();
super.dispose();
}
protected void addListeners() {
IPreferenceStore store = ProvAdminUIActivator.getDefault().getPreferenceStore();
preferenceListener = event -> {
if (getVisualProperties().contains(event.getProperty())) {
updateCachesForPreferences();
ProvView.this.refreshAll(false);
}
};
store.addPropertyChangeListener(preferenceListener);
}
protected void updateCachesForPreferences() {
// default is to do nothing
}
protected void removeListeners() {
if (preferenceListener != null) {
IPreferenceStore store = ProvAdminUIActivator.getDefault().getPreferenceStore();
store.removePropertyChangeListener(preferenceListener);
}
}
Shell getShell() {
return viewer.getControl().getShell();
}
Control getViewerControl() {
return viewer.getControl();
}
protected IStructuredSelection getSelection() {
return viewer.getStructuredSelection();
}
protected void run(ProvisioningJob job) {
IWorkbenchSiteProgressService service = getSite().getService(IWorkbenchSiteProgressService.class);
if (service != null)
service.schedule(job);
else
job.runModal(new NullProgressMonitor());
}
protected void configureViewer(final TreeViewer treeViewer) {
viewer.setComparator(new IUComparator(IUComparator.IU_ID));
viewer.setComparer(new ProvElementComparer());
}
protected void selectionChanged(IStructuredSelection selection) {
// subclasses may override. Do nothing here.
}
protected abstract IContentProvider getContentProvider();
protected Object getInput() {
return null;
}
protected void setTreeColumns(Tree tree) {
// For now we set two columns and the content depends on the elements
TreeColumn tc = new TreeColumn(tree, SWT.LEFT, 0);
tc.setResizable(true);
tc.setWidth(400);
tc = new TreeColumn(tree, SWT.LEFT, 1);
tc.setWidth(600);
tc.setResizable(true);
}
protected ILabelProvider getLabelProvider() {
return new ProvElementLabelProvider();
}
protected void refreshUnderlyingModel() {
// do nothing by default
}
protected List<String> getVisualProperties() {
ArrayList<String> list = new ArrayList<>(1);
list.add(PreferenceConstants.PREF_SHOW_GROUPS_ONLY);
return list;
}
final void refreshAll(boolean refreshModel) {
// Refresh the underlying elements
if (refreshModel)
refreshUnderlyingModel();
// We then reset the input to ensure that anything the content providers
// are caching gets reset also. The net effect is that everything
// will get queried again.
viewer.setInput(getInput());
}
protected String getProfileId() {
return null;
}
protected ProvisioningUI getProvisioningUI() {
if (ui == null) {
ui = ProvAdminUIActivator.getDefault().getProvisioningUI(getProfileId());
}
return ui;
}
}
|
