|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.swt.widgets.Widget org.eclipse.swt.widgets.Item org.eclipse.swt.widgets.TaskItem
public class TaskItem
Instances of this class represent a task item.
Method Summary | |
---|---|
Menu |
getMenu()
Returns the receiver's pop up menu if it has one, or null if it does not. |
Image |
getOverlayImage()
Returns the receiver's overlay image if it has one, or null if it does not. |
java.lang.String |
getOverlayText()
Returns the receiver's overlay text, which will be an empty string if it has never been set. |
TaskBar |
getParent()
Returns the receiver's parent, which must be a TaskBar . |
int |
getProgress()
Returns the receiver's progress. |
int |
getProgressState()
Returns the receiver's progress state. |
void |
setMenu(Menu menu)
Sets the receiver's pop up menu to the argument. |
void |
setOverlayImage(Image overlayImage)
Sets the receiver's overlay image, which may be null indicating that no image should be displayed. |
void |
setOverlayText(java.lang.String overlayText)
Sets the receiver's overlay text. |
void |
setProgress(int progress)
Sets the receiver's progress, the progress represents a percentage and should be in range from 0 to 100. |
void |
setProgressState(int progressState)
Sets the receiver's progress state, the state can be one of the following: |
Methods inherited from class org.eclipse.swt.widgets.Item |
---|
getImage, getText, setImage, setText |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getAdapter, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public Menu getMenu()
SWTException
- public Image getOverlayImage()
SWTException
- public java.lang.String getOverlayText()
SWTException
- public TaskBar getParent()
TaskBar
.
SWTException
- public int getProgress()
SWTException
- public int getProgressState()
SWTException
- public void setMenu(Menu menu)
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.
For better cross platform support, the application code should
set this feature on the TaskItem
for application.
On Windows, this feature will only work on RCP applications.
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.
menu
- the new pop up menu
java.lang.IllegalArgumentException
- SWTException
- public void setOverlayImage(Image overlayImage)
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.
For better cross platform support, the application code should
first try to set this feature on the TaskItem
for the
main shell then on the TaskItem
for the application.
overlayImage
- the new overlay image (may be null)
java.lang.IllegalArgumentException
- SWTException
- public void setOverlayText(java.lang.String overlayText)
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.
For better cross platform support, the application code should
first try to set this feature on the TaskItem
for the
main shell then on the TaskItem
for the application.
overlayText
- the new overlay text
java.lang.IllegalArgumentException
- SWTException
- public void setProgress(int progress)
SWT#DEFAULT
.
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.
For better cross platform support, the application code should
first try to set this feature on the TaskItem
for the
main shell then on the TaskItem
for the application.
progress
- the new progress
SWTException
- setProgressState(int)
public void setProgressState(int progressState)
SWT#NORMAL
, SWT#PAUSED
,
SWT#ERROR
is set with setProgress()
. SWT#DEFAULT
indicates that no progress should be shown.
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 SWT#DEFAULT
.
For better cross platform support, the application code should
first try to set this feature on the TaskItem
for the
main shell then on the TaskItem
for the application.
progressState
- the new progress state
SWTException
- setProgress(int)
|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2013. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0