|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Item
org.eclipse.swt.widgets.TaskBarItem
public class TaskBarItem
Instances of this class represent a task bar item.
Method Summary | |
---|---|
protected void |
checkSubclass()
Checks that this class can be subclassed. |
Image |
getOverlayImage()
Returns the receiver's overlay image if it has one, or null if it does not. |
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 |
setOverlayImage(Image overlayImage)
Sets the receiver's overlay image, which may be null indicating that no image should be displayed. |
void |
setOverlayText(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: SWT.DEFAULT
SWT.NORMAL
SWT.PAUSED
SWT.ERROR
SWT.INDETERMINATE
The percentage of progress shown by the states SWT#NORMAL , SWT#PAUSED ,
SWT#ERROR is set with setProgress() . |
Methods inherited from class org.eclipse.swt.widgets.Item |
---|
getImage, getText, setImage, setText |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
protected void checkSubclass()
Widget
The SWT class library is intended to be subclassed
only at specific, controlled points (most notably,
Composite
and Canvas
when
implementing new widgets). This method enforces this
rule unless it is overridden.
IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.
The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.
checkSubclass
in class Item
public Image getOverlayImage()
SWTException
- public String getOverlayText()
SWTException
- public TaskBar getParent()
TaskBar
.
SWTException
- public int getProgress()
SWTException
- public int getProgressState()
SWTException
- public void setOverlayImage(Image overlayImage)
overlayImage
- the new overlay image (may be null)
IllegalArgumentException
- SWTException
- public void setOverlayText(String overlayText)
overlayText
- the new overlay text
IllegalArgumentException
- SWTException
- public void setProgress(int progress)
SWT#DEFAULT
.
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.
progressState
- the new progress state
SWTException
- setProgress(int)
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.