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
|
/*******************************************************************************
* Copyright (c) 2000, 2010 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
* Chris Gross (schtoo@schtoo.com) - patch for bug 16179
* Tasktop Technologies - extracted code for Mylyn
*******************************************************************************/
package org.eclipse.mylyn.commons.ui;
import java.lang.reflect.InvocationTargetException;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.ProgressMonitorWrapper;
import org.eclipse.jface.operation.IRunnableContext;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.operation.ModalContext;
import org.eclipse.jface.wizard.ProgressMonitorPart;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
/**
* A helper class for running operations in dialogs. Based on {@link WizardDialog}.
*
* @author Steffen Pingel
* @since 3.7
*/
public class ProgressContainer implements IRunnableContext {
private static final String FOCUS_CONTROL = "focusControl"; //$NON-NLS-1$
// The number of long running operation executed from the dialog.
private long activeRunningOperations = 0;
private Cursor arrowCursor;
private Button cancelButton;
private boolean lockedUI = false;
// The progress monitor
private final ProgressMonitorPart progressMonitorPart;
private final Shell shell;
private Cursor waitCursor;
private boolean useWaitCursor;
public ProgressContainer(Shell shell, ProgressMonitorPart progressMonitorPart) {
Assert.isNotNull(shell);
Assert.isNotNull(progressMonitorPart);
this.shell = shell;
this.progressMonitorPart = progressMonitorPart;
init();
}
private void init() {
this.shell.addDisposeListener(new DisposeListener() {
public void widgetDisposed(DisposeEvent e) {
progressMonitorPart.setCanceled(true);
}
});
}
public boolean useWaitCursor() {
return useWaitCursor;
}
public void setUseWaitCursor(boolean useWaitCursor) {
this.useWaitCursor = useWaitCursor;
}
/**
* About to start a long running operation triggered through the wizard. Shows the progress monitor and disables the
* wizard's buttons and controls.
*
* @param enableCancelButton
* <code>true</code> if the Cancel button should be enabled, and <code>false</code> if it should be
* disabled
* @return the saved UI state
*/
private Object aboutToStart(boolean enableCancelButton) {
Map<Object, Object> savedState = null;
if (getShell() != null) {
// Save focus control
Control focusControl = getShell().getDisplay().getFocusControl();
if (focusControl != null && focusControl.getShell() != getShell()) {
focusControl = null;
}
// Set the busy cursor to all shells.
Display d = getShell().getDisplay();
if (useWaitCursor()) {
waitCursor = new Cursor(d, SWT.CURSOR_WAIT);
setDisplayCursor(waitCursor);
// Set the arrow cursor to the cancel component.
arrowCursor = new Cursor(d, SWT.CURSOR_ARROW);
if (cancelButton != null) {
cancelButton.setCursor(arrowCursor);
}
}
// Deactivate shell
savedState = new HashMap<Object, Object>(10);
saveUiState(savedState);
if (focusControl != null) {
savedState.put(FOCUS_CONTROL, focusControl);
}
// Attach the progress monitor part to the cancel button
if (cancelButton != null) {
progressMonitorPart.attachToCancelComponent(cancelButton);
}
progressMonitorPart.setVisible(true);
}
return savedState;
}
public Button getCancelButton() {
return cancelButton;
}
private IProgressMonitor getProgressMonitor() {
return new ProgressMonitorWrapper(progressMonitorPart) {
@Override
public void internalWorked(double work) {
if (progressMonitorPart.isDisposed()) {
this.setCanceled(true);
return;
}
super.internalWorked(work);
}
};
}
public Shell getShell() {
return shell;
}
public boolean isActive() {
return activeRunningOperations > 0;
}
public boolean isLockedUI() {
return lockedUI;
}
protected void restoreUiState(Map<Object, Object> state) {
// ignore
}
/**
* This implementation of IRunnableContext#run(boolean, boolean, IRunnableWithProgress) blocks until the runnable
* has been run, regardless of the value of <code>fork</code>. It is recommended that <code>fork</code> is set to
* true in most cases. If <code>fork</code> is set to <code>false</code>, the runnable will run in the UI thread and
* it is the runnable's responsibility to call <code>Display.readAndDispatch()</code> to ensure UI responsiveness.
* UI state is saved prior to executing the long-running operation and is restored after the long-running operation
* completes executing. Any attempt to change the UI state of the wizard in the long-running operation will be
* nullified when original UI state is restored.
*/
public void run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) throws InvocationTargetException,
InterruptedException {
// The operation can only be canceled if it is executed in a separate
// thread.
// Otherwise the UI is blocked anyway.
Object state = null;
if (activeRunningOperations == 0) {
state = aboutToStart(fork && cancelable);
}
activeRunningOperations++;
try {
if (!fork) {
lockedUI = true;
}
ModalContext.run(runnable, fork, getProgressMonitor(), getShell().getDisplay());
lockedUI = false;
} finally {
activeRunningOperations--;
// Stop if this is the last one
if (state != null) {
stopped(state);
}
}
}
protected void saveUiState(Map<Object, Object> savedState) {
// ignore
}
public void setCancelButton(Button cancelButton) {
this.cancelButton = cancelButton;
}
/**
* Sets the given cursor for all shells currently active for this window's display.
*
* @param c
* the cursor
*/
private void setDisplayCursor(Cursor c) {
Shell[] shells = getShell().getDisplay().getShells();
for (Shell shell2 : shells) {
shell2.setCursor(c);
}
}
/**
* A long running operation triggered through the wizard was stopped either by user input or by normal end. Hides
* the progress monitor and restores the enable state wizard's buttons and controls.
*
* @param savedState
* the saved UI state as returned by <code>aboutToStart</code>
* @see #aboutToStart
*/
@SuppressWarnings("unchecked")
private void stopped(Object savedState) {
if (getShell() != null && !getShell().isDisposed()) {
progressMonitorPart.setVisible(false);
if (cancelButton != null) {
progressMonitorPart.removeFromCancelComponent(cancelButton);
}
Map<Object, Object> state = (Map<Object, Object>) savedState;
restoreUiState(state);
if (waitCursor != null) {
setDisplayCursor(null);
if (cancelButton != null) {
cancelButton.setCursor(null);
}
waitCursor.dispose();
waitCursor = null;
arrowCursor.dispose();
arrowCursor = null;
}
Control focusControl = (Control) state.get(FOCUS_CONTROL);
if (focusControl != null && !focusControl.isDisposed()) {
focusControl.setFocus();
}
}
}
}
|
