org.eclipse.swt.widgets
Class ToolBar

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Control
              |
              +--org.eclipse.swt.widgets.Scrollable
                    |
                    +--org.eclipse.swt.widgets.Composite
                          |
                          +--org.eclipse.swt.widgets.ToolBar

All Implemented Interfaces:

Drawable

public class ToolBar

extends Composite

Safe:

Field Summary

(package private) static int	DEFAULT_HEIGHT
(package private) static int	DEFAULT_WIDTH
(package private) ImageList	disabledImageList
(package private) ImageList	hotImageList
(package private) boolean	ignoreResize
(package private) ImageList	imageList
(package private) ToolItem[]	items
(package private) int	lastFocusId
(package private) static org.eclipse.swt.internal.win32.TCHAR	ToolBarClass
(package private) static int	ToolBarProc

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

font, layout, lpwp, tabList

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

horizontalBar, verticalBar

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

ACCENTS, accessible, background, drawCount, foreground, handle, hCursor, layoutData, menu, parent, toolTipText

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

CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values

Constructor Summary

ToolBar(Composite parent, int style)
Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

(package private) int	callWindowProc(int msg, int wParam, int lParam)
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
Point	computeSize(int wHint, int hHint, boolean changed) Enabled:
Rectangle	computeTrim(int x, int y, int width, int height) Enabled:
(package private) void	createHandle()
(package private) void	createItem(ToolItem item, int index)
(package private) void	createWidget()
(package private) int	defaultBackground()
(package private) void	destroyItem(ToolItem item)
(package private) ImageList	getDisabledImageList()
(package private) ImageList	getHotImageList()
(package private) ImageList	getImageList()
ToolItem	getItem(int index) Enabled: Returns the item at the given, zero-relative index in the receiver.
ToolItem	getItem(Point point) Enabled: Returns the item at the given point in the receiver or null if no such item exists.
int	getItemCount() Enabled: Returns the number of items contained in the receiver.
ToolItem[]	getItems() Enabled: Returns an array of TabItems which are the items in the receiver.
int	getRowCount() Enabled: Returns the number of rows in the receiver.
int	indexOf(ToolItem item) Enabled: Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item.
(package private) void	layoutItems()
(package private) boolean	mnemonicHit(char ch)
(package private) boolean	mnemonicMatch(char ch)
(package private) void	releaseWidget()
(package private) void	setBounds(int x, int y, int width, int height, int flags)
(package private) void	setDefaultFont()
(package private) void	setDisabledImageList(ImageList imageList)
(package private) void	setHotImageList(ImageList imageList)
(package private) void	setImageList(ImageList imageList)
(package private) boolean	setTabItemFocus()
(package private) String	toolTipText(org.eclipse.swt.internal.win32.NMTTDISPINFO hdr)
(package private) int	widgetStyle()
(package private) org.eclipse.swt.internal.win32.TCHAR	windowClass()
(package private) int	windowProc()
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_COMMAND(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_GETDLGCODE(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_KEYDOWN(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_NOTIFY(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_SIZE(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_WINDOWPOSCHANGING(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmCommandChild(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmNotifyChild(int wParam, int lParam)

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

_getChildren, _getTabList, computeTabList, getChildren, getChildrenCount, getLayout, getTabList, hooksKeys, layout, layout, minimumSize, moveAbove, moveBelow, releaseChildren, resizeChildren, resizeChildren, setFocus, setLayout, setResizeChildren, setTabGroupFocus, setTabList, translateMnemonic, updateFont, WM_ERASEBKGND, WM_GETFONT, WM_LBUTTONDOWN, WM_PAINT, WM_SETFONT, WM_SYSCOLORCHANGE, WM_SYSCOMMAND

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

createScrollBar, getClientArea, getHorizontalBar, getVerticalBar, widgetExtStyle, WM_HSCROLL, WM_MOUSEWHEEL, WM_VSCROLL, wmScroll

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

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, checkOrientation, computeSize, computeTabGroup, computeTabRoot, defaultFont, defaultForeground, deregister, destroyWidget, drawBackground, drawBackground, findBrush, findCursor, findMnemonic, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundPixel, getBorderWidth, getBounds, getCodePage, getDisplay, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getParent, getPath, getShell, getSize, getToolTipText, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isDisposed, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, moveAbove, moveBelow, new_Accessible, pack, pack, redraw, redraw, register, releaseHandle, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, setBackground, setBackgroundPixel, setBounds, setBounds, setCapture, setCursor, setEnabled, setFont, setForeground, setForegroundPixel, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioFocus, setRadioSelection, setRedraw, setSavedFocus, setSize, setSize, setToolTipText, setVisible, sort, subclass, toControl, toControl, toDisplay, toDisplay, transferActive, transferFocus, translateAccelerator, translateMnemonic, translateTraversal, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, windowProc, WM_ACTIVATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_IME_CHAR, WM_IME_COMPOSITION, WM_INITMENUPOPUP, WM_KEYUP, WM_LBUTTONDBLCLK, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCHITTEST, WM_PALETTECHANGED, WM_PASTE, WM_PRINTCLIENT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TIMER, WM_UNDO, wmColorChild, wmDrawChild, wmMeasureChild, wmScrollChild

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

addDisposeListener, addListener, checkBits, checkParent, checkWidget, dispose, error, filters, getData, getData, getName, getNameText, getStyle, hooks, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseChild, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs

Methods inherited from class java.lang.Object

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

Field Detail

lastFocusId

int lastFocusId

items

ToolItem[] items

ignoreResize

boolean ignoreResize

imageList

ImageList imageList

disabledImageList

ImageList disabledImageList

hotImageList

ImageList hotImageList

ToolBarProc

static final int ToolBarProc

ToolBarClass

static final org.eclipse.swt.internal.win32.TCHAR ToolBarClass

DEFAULT_WIDTH

static final int DEFAULT_WIDTH

DEFAULT_HEIGHT

static final int DEFAULT_HEIGHT

Constructor Detail

ToolBar

public ToolBar(Composite parent,
               int style)

Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

See Also:

SWT.FLAT, SWT.WRAP, SWT.RIGHT, SWT.HORIZONTAL, SWT.SHADOW_OUT, SWT.VERTICAL, Widget.checkSubclass(), Widget.getStyle()

Method Detail

callWindowProc

int callWindowProc(int msg,
                   int wParam,
                   int lParam)

Overrides:

callWindowProc in class Scrollable

checkStyle

static int checkStyle(int style)

checkSubclass

protected void checkSubclass()

Description copied from class: Widget

Checks that this class can be subclassed.

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.

Overrides:

checkSubclass in class Composite

computeSize

public Point computeSize(int wHint,
                         int hHint,
                         boolean changed)

Enabled:

Overrides:

computeSize in class Composite

Parameters:

wHint - the width hint (can be SWT.DEFAULT)

hHint - the height hint (can be SWT.DEFAULT)

changed - true if the control's contents have changed, and false otherwise

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(), "computeTrim, getClientArea for controls that implement them"

computeTrim

public Rectangle computeTrim(int x,
                             int y,
                             int width,
                             int height)

Enabled:

Overrides:

computeTrim in class Scrollable

Returns:

the required bounds to produce the given client area

See Also:

Scrollable.getClientArea()

createHandle

void createHandle()

Overrides:

createHandle in class Composite

createItem

void createItem(ToolItem item,
                int index)

createWidget

void createWidget()

Overrides:

createWidget in class Scrollable

defaultBackground

int defaultBackground()

Overrides:

defaultBackground in class Control

destroyItem

void destroyItem(ToolItem item)

getDisabledImageList

ImageList getDisabledImageList()

getHotImageList

ImageList getHotImageList()

getImageList

ImageList getImageList()

getItem

public ToolItem getItem(int index)

Enabled: 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

getItem

public ToolItem getItem(Point point)

Enabled: Returns the item at the given point in the receiver or null if no such item exists. The point is in the coordinate system of the receiver.

Parameters:

point - the point used to locate the item

Returns:

the item at the given point

getItemCount

public int getItemCount()

Enabled: Returns the number of items contained in the receiver.

Returns:

the number of items

getItems

public ToolItem[] getItems()

Enabled: Returns an array of TabItems 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

getRowCount

public int getRowCount()

Enabled: Returns the number of rows in the receiver. When the receiver has the WRAP style, the number of rows can be greater than one. Otherwise, the number of rows is always one.

Returns:

the number of items

indexOf

public int indexOf(ToolItem item)

Enabled: Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.

Parameters:

item - the search item

Returns:

the index of the item

layoutItems

void layoutItems()

mnemonicHit

boolean mnemonicHit(char ch)

Overrides:

mnemonicHit in class Control

mnemonicMatch

boolean mnemonicMatch(char ch)

Overrides:

mnemonicMatch in class Control

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Composite

setBounds

void setBounds(int x,
               int y,
               int width,
               int height,
               int flags)

Overrides:

setBounds in class Control

setDefaultFont

void setDefaultFont()

Overrides:

setDefaultFont in class Control

setDisabledImageList

void setDisabledImageList(ImageList imageList)

setHotImageList

void setHotImageList(ImageList imageList)

setImageList

void setImageList(ImageList imageList)

setTabItemFocus

boolean setTabItemFocus()

Overrides:

setTabItemFocus in class Composite

toolTipText

String toolTipText(org.eclipse.swt.internal.win32.NMTTDISPINFO hdr)

Overrides:

toolTipText in class Composite

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Composite

windowClass

org.eclipse.swt.internal.win32.TCHAR windowClass()

Overrides:

windowClass in class Scrollable

windowProc

int windowProc()

Overrides:

windowProc in class Scrollable

WM_GETDLGCODE

org.eclipse.swt.internal.win32.LRESULT WM_GETDLGCODE(int wParam,
                                                     int lParam)

Overrides:

WM_GETDLGCODE in class Composite

WM_COMMAND

org.eclipse.swt.internal.win32.LRESULT WM_COMMAND(int wParam,
                                                  int lParam)

Overrides:

WM_COMMAND in class Control

WM_KEYDOWN

org.eclipse.swt.internal.win32.LRESULT WM_KEYDOWN(int wParam,
                                                  int lParam)

Overrides:

WM_KEYDOWN in class Control

WM_KILLFOCUS

org.eclipse.swt.internal.win32.LRESULT WM_KILLFOCUS(int wParam,
                                                    int lParam)

Overrides:

WM_KILLFOCUS in class Control

WM_NOTIFY

org.eclipse.swt.internal.win32.LRESULT WM_NOTIFY(int wParam,
                                                 int lParam)

Overrides:

WM_NOTIFY in class Composite

WM_SETFOCUS

org.eclipse.swt.internal.win32.LRESULT WM_SETFOCUS(int wParam,
                                                   int lParam)

Overrides:

WM_SETFOCUS in class Control

WM_SIZE

org.eclipse.swt.internal.win32.LRESULT WM_SIZE(int wParam,
                                               int lParam)

Overrides:

WM_SIZE in class Composite

WM_WINDOWPOSCHANGING

org.eclipse.swt.internal.win32.LRESULT WM_WINDOWPOSCHANGING(int wParam,
                                                            int lParam)

Overrides:

WM_WINDOWPOSCHANGING in class Control

wmCommandChild

org.eclipse.swt.internal.win32.LRESULT wmCommandChild(int wParam,
                                                      int lParam)

Overrides:

wmCommandChild in class Control

wmNotifyChild

org.eclipse.swt.internal.win32.LRESULT wmNotifyChild(int wParam,
                                                     int lParam)

Overrides:

wmNotifyChild in class Control