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
|
/*******************************************************************************
* Copyright (c) 2000, 2009 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
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.*;
import org.eclipse.swt.graphics.*;
/**
* Instances of this class represent a task item.
*
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>(none)</dd>
* <dt><b>Events:</b></dt>
* <dd>(none)</dd>
* </dl>
*
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
*
* @since 3.6
*
* @noextend This class is not intended to be subclassed by clients.
*/
public class TaskItem extends Item {
TaskBar parent;
Shell shell;
int progress, progressState = SWT.DEFAULT;
Image overlayImage;
String overlayText = "";
Menu menu;
static final int PROGRESS_MAX = 100;
/**
* Constructs a new instance of this class given its parent
* (which must be a <code>Tray</code>) and a style value
* describing its behavior and appearance. The item is added
* to the end of the items maintained by its parent.
* <p>
* The style value is either one of the style constants defined in
* class <code>SWT</code> which is applicable to instances of this
* class, or must be built by <em>bitwise OR</em>'ing together
* (that is, using the <code>int</code> "|" operator) two or more
* of those <code>SWT</code> style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
* </p>
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
TaskItem (TaskBar parent, int style) {
super (parent, style);
this.parent = parent;
parent.createItem (this, -1);
}
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
void destroyWidget () {
parent.destroyItem (this);
releaseHandle ();
}
/**
* Returns the receiver's pop up menu if it has one, or null
* if it does not.
*
* @return the receiver's menu
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Menu getMenu () {
checkWidget ();
return menu;
}
/**
* Returns the receiver's overlay image if it has one, or null
* if it does not.
*
* @return the receiver's overlay image
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Image getOverlayImage () {
checkWidget();
return overlayImage;
}
/**
* Returns the receiver's overlay text, which will be an empty
* string if it has never been set.
*
* @return the receiver's overlay text
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public String getOverlayText () {
checkWidget();
return overlayText;
}
/**
* Returns the receiver's parent, which must be a <code>TaskBar</code>.
*
* @return the receiver's parent
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public TaskBar getParent () {
checkWidget ();
return parent;
}
/**
* Returns the receiver's progress.
*
* @return the receiver's progress
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public int getProgress () {
checkWidget ();
return progress;
}
/**
* Returns the receiver's progress state.
*
* @return the receiver's progress state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public int getProgressState () {
checkWidget ();
return progressState;
}
void releaseHandle () {
super.releaseHandle ();
parent = null;
}
void releaseWidget () {
super.releaseWidget ();
overlayImage = null;
overlayText = null;
}
/**
* Sets the receiver's pop up menu to the argument. The way the menu is
* shown is platform specific.
*
* <p>
* This feature might not be available for the receiver on all
* platforms. The application code can check if it is supported
* by calling the respective get method. When the feature is not
* available, the get method will always return the NULL.</p>
*
* <p>
* For better cross platform support, the application code should
* set this feature on the <code>TaskItem</code> for application.<br>
* On Windows, this feature will only work on RCP applications.</p>
*
* <p>
* The menu should be fully created before this method is called.
* Dynamic changes to the menu after the method is called will not be reflected
* in the native menu.</p>
*
* @param menu the new pop up menu
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_MENU_NOT_POP_UP - the menu is not a pop up menu</li>
* <li>ERROR_INVALID_ARGUMENT - if the menu has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setMenu (Menu menu) {
checkWidget ();
if (menu != null) {
if (menu.isDisposed()) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
if ((menu.style & SWT.POP_UP) == 0) {
error (SWT.ERROR_MENU_NOT_POP_UP);
}
}
this.menu = menu;
}
/**
* Sets the receiver's overlay image, which may be null
* indicating that no image should be displayed. The bounds
* for the overlay image is determined by the platform and in
* general it should be a small image.
*
* <p>
* This feature might not be available for the receiver on all
* platforms. The application code can check if it is supported
* by calling the respective get method. When the feature is not
* available, the get method will always return the NULL.</p>
*
* <p>
* For better cross platform support, the application code should
* first try to set this feature on the <code>TaskItem</code> for the
* main shell then on the <code>TaskItem</code> for the application.</p>
*
* @param overlayImage the new overlay image (may be null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the overlayImage has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setOverlayImage (Image overlayImage) {
checkWidget ();
if (overlayImage != null && overlayImage.isDisposed ()) error (SWT.ERROR_INVALID_ARGUMENT);
this.overlayImage = overlayImage;
}
/**
* Sets the receiver's overlay text. The space available to display the
* overlay text is platform dependent and in general it should be no longer
* than a few characters.
*
* <p>
* This feature might not be available for the receiver on all
* platforms. The application code can check if it is supported
* by calling the respective get method. When the feature is not
* available, the get method will always return an empty string.</p>
*
* <p>
* For better cross platform support, the application code should
* first try to set this feature on the <code>TaskItem</code> for the
* main shell then on the <code>TaskItem</code> for the application.</p>
*
* @param overlayText the new overlay text
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the overlayText is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setOverlayText (String overlayText) {
checkWidget ();
if (overlayText == null) error (SWT.ERROR_NULL_ARGUMENT);
this.overlayText = overlayText;
}
/**
* Sets the receiver's progress state, the state can be one of
* the following:
* <p><ul>
* <li>{@link SWT#DEFAULT}</li>
* <li>{@link SWT#NORMAL}</li>
* <li>{@link SWT#PAUSED}</li>
* <li>{@link SWT#ERROR}</li>
* <li>{@link SWT#INDETERMINATE}</li>
* </ul></p>
*
* The percentage of progress shown by the states <code>SWT#NORMAL</code>, <code>SWT#PAUSED</code>,
* <code>SWT#ERROR</code> is set with <code>setProgress()</code>. <br>
* The state <code>SWT#DEFAULT</code> indicates that no progress should be shown.
*
* <p>
* This feature might not be available for the receiver on all
* platforms. The application code can check if it is supported
* by calling the respective get method. When the feature is not
* available, the get method will always return <code>SWT#DEFAULT</code>.</p>
*
* <p>
* For better cross platform support, the application code should
* first try to set this feature on the <code>TaskItem</code> for the
* main shell then on the <code>TaskItem</code> for the application.</p>
*
* @param progressState the new progress state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* #see {@link #setProgress(int)}
*/
public void setProgressState (int progressState) {
checkWidget ();
if (this.progressState == progressState) return;
this.progressState = progressState;
}
/**
* Sets the receiver's progress, the progress represents a percentage and
* should be in range from 0 to 100. The progress is only shown when the progress
* state is different than <code>SWT#DEFAULT</code>.
*
* <p>
* This feature might not be available for the receiver on all
* platforms. The application code can check if it is supported
* by calling the respective get method. When the feature is not
* available, the get method will always return zero.</p>
*
* <p>
* For better cross platform support, the application code should
* first try to set this feature on the <code>TaskItem</code> for the
* main shell then on the <code>TaskItem</code> for the application.</p>
*
* @param progress the new progress
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* #see {@link #setProgressState(int)}
*/
public void setProgress (int progress) {
checkWidget ();
progress = Math.max(0, Math.min(progress, PROGRESS_MAX));
if (this.progress == progress) return;
this.progress = progress;
}
}
|