org.eclipse.swt.widgets

Class TaskBar

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.TaskBar

public class TaskBar
extends Widget

Instances of this class represent the system task bar.

Styles:

(none)

Events:

(none)

Since:

3.6

See Also:

Display.getSystemTaskBar(), Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static byte[]	CLSID_DestinationList
(package private) static byte[]	CLSID_EnumerableObjectCollection
(package private) static byte[]	CLSID_FileOperation
(package private) static byte[]	CLSID_ShellLink
(package private) static byte[]	CLSID_TaskbarList
(package private) static java.lang.String	EXE_ARGS_KEY
(package private) static char[]	EXE_PATH
(package private) static java.lang.String	EXE_PATH_KEY
(package private) static byte[]	FOLDERID_LocalAppData
(package private) static char[]	ICO_DIR
(package private) static java.lang.String	ICON_INDEX_KEY
(package private) static java.lang.String	ICON_KEY
(package private) static byte[]	IID_ICustomDestinationList
(package private) static byte[]	IID_IFileOperation
(package private) static byte[]	IID_IObjectArray
(package private) static byte[]	IID_IObjectCollection
(package private) static byte[]	IID_IPropertyStore
(package private) static byte[]	IID_IShellItem
(package private) static byte[]	IID_IShellLinkW
(package private) static byte[]	IID_ITaskbarList3
(package private) int	itemCount
(package private) TaskItem[]	items
(package private) int	mTaskbarList3
(package private) static PROPERTYKEY	PKEY_AppUserModel_IsDestListSeparator
(package private) static PROPERTYKEY	PKEY_Title

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
TaskBar(Display display, int style)

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	createHandle()
(package private) void	createItem(TaskItem item, int index)
(package private) void	createItems()
(package private) int	createShellLink(MenuItem item, java.lang.String directory)
(package private) int	createShellLinkArray(MenuItem[] items, java.lang.String directory)
(package private) void	destroyItem(TaskItem item)
(package private) java.lang.String	getDirectory(char[] appName)
(package private) int	getDirectory(int parent, int pfo, char[] name, boolean delete)
TaskItem	getItem(int index) Returns the item at the given, zero-relative index in the receiver.
TaskItem	getItem(Shell shell) Returns the TaskItem for the given Shell or the TaskItem for the application if the Shell parameter is null.
int	getItemCount() Returns the number of items contained in the receiver.
TaskItem[]	getItems() Returns an array of TaskItems which are the items in the receiver.
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseParent()
(package private) void	releaseWidget()
(package private) void	reskinChildren(int flags)
(package private) void	setMenu(Menu menu)

Methods inherited from class org.eclipse.swt.widgets.Widget

_addListener, addDisposeListener, addListener, callWindowProc, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, destroyWidget, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getMenu, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, new_GC, notifyListeners, postEvent, postEvent, release, releaseHandle, removeDisposeListener, removeListener, removeListener, reskin, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendFocusEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, setTabItemFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

itemCount

int itemCount

items

TaskItem[] items

mTaskbarList3

int mTaskbarList3

EXE_PATH

static final char[] EXE_PATH

ICO_DIR

static final char[] ICO_DIR

PKEY_Title

static final PROPERTYKEY PKEY_Title

PKEY_AppUserModel_IsDestListSeparator

static final PROPERTYKEY PKEY_AppUserModel_IsDestListSeparator

EXE_PATH_KEY

static final java.lang.String EXE_PATH_KEY

See Also:

Constant Field Values

EXE_ARGS_KEY

static final java.lang.String EXE_ARGS_KEY

See Also:

Constant Field Values

ICON_KEY

static final java.lang.String ICON_KEY

See Also:

Constant Field Values

ICON_INDEX_KEY

static final java.lang.String ICON_INDEX_KEY

See Also:

Constant Field Values

CLSID_TaskbarList

static final byte[] CLSID_TaskbarList

CLSID_DestinationList

static final byte[] CLSID_DestinationList

CLSID_EnumerableObjectCollection

static final byte[] CLSID_EnumerableObjectCollection

CLSID_ShellLink

static final byte[] CLSID_ShellLink

CLSID_FileOperation

static final byte[] CLSID_FileOperation

IID_ITaskbarList3

static final byte[] IID_ITaskbarList3

IID_ICustomDestinationList

static final byte[] IID_ICustomDestinationList

IID_IObjectArray

static final byte[] IID_IObjectArray

IID_IObjectCollection

static final byte[] IID_IObjectCollection

IID_IShellLinkW

static final byte[] IID_IShellLinkW

IID_IPropertyStore

static final byte[] IID_IPropertyStore

IID_IShellItem

static final byte[] IID_IShellItem

IID_IFileOperation

static final byte[] IID_IFileOperation

FOLDERID_LocalAppData

static final byte[] FOLDERID_LocalAppData

Constructor Detail

TaskBar

TaskBar(Display display,
       int style)

Method Detail

createHandle

void createHandle()

createItem

void createItem(TaskItem item,
              int index)

createItems

void createItems()

createShellLink

int createShellLink(MenuItem item,
                  java.lang.String directory)

createShellLinkArray

int createShellLinkArray(MenuItem[] items,
                       java.lang.String directory)

destroyItem

void destroyItem(TaskItem item)

getDirectory

java.lang.String getDirectory(char[] appName)

getDirectory

int getDirectory(int parent,
               int pfo,
               char[] name,
               boolean delete)

getItem

public TaskItem getItem(int index)

Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:

index - the index of the item to return

Returns:

the item at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItem

public TaskItem getItem(Shell shell)

Returns the TaskItem for the given Shell or the TaskItem for the application if the Shell parameter is null. If the requested item is not supported by the platform it returns null.

Parameters:

shell - the shell for which the task item is requested, or null to request the application item

Returns:

the task item for the given shell or the application

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver.

Returns:

the number of items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItems

public TaskItem[] getItems()

Returns an array of TaskItems which are the items in the receiver.

Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

Returns:

the items in the receiver

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Widget

releaseParent

void releaseParent()

Overrides:

releaseParent in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Widget

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Widget

setMenu

void setMenu(Menu menu)