Package 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

Instances of this class support the layout of selectable tool bar items.

The item children that may be added to instances of this class must be of type ToolItem.

Note that although this class is a subclass of Composite, it does not make sense to add Control children to it, or set a layout on it.

Styles:

FLAT, WRAP, RIGHT, HORIZONTAL, VERTICAL, SHADOW_OUT

Events:

(none)

Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.

IMPORTANT: This class is not intended to be subclassed.

See Also:

• ToolBar, ToolItem snippets
• SWT Example: ControlExample
• Sample code and further information

Restriction:

This class is not intended to be subclassed by clients.

Field Summary

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

handle

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	checkSubclass()	Checks that this class can be subclassed.
ToolItem	getItem(int index)	Returns the item at the given, zero-relative index in the receiver.
ToolItem	getItem(Point point)	Returns the item at the given point in the receiver or null if no such item exists.
int	getItemCount()	Returns the number of items contained in the receiver.
ToolItem[]	getItems()	Returns an array of ToolItems which are the items in the receiver.
int	getRowCount()	Returns the number of rows in the receiver.
int	indexOf(ToolItem item)	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.
void	layout(boolean changed)	If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children.
void	setFont(Font font)	Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.
boolean	setParent(Composite parent)	Changes the parent of the widget to be the one provided.
void	setRedraw(boolean redraw)	If the argument is false, causes subsequent drawing operations in the receiver to be ignored.

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

changed, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList, toString

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

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, setScrollbarsMode

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

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

addDisposeListener, addListener, addTypedListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, getTypedListeners, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, removeTypedListener, reskin, setData, setData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.swt.graphics.Drawable

isAutoScalable

Constructor Details

ToolBar

public ToolBar(Composite parent,
 int style)

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

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

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

Method Details

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

layout

public void layout(boolean changed)

Description copied from class: Composite

If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the argument is true the layout must not rely on any information it has cached about the immediate children. If it is false the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing.

It is normally more efficient to invoke Control.requestLayout() on every control which has changed in the layout than it is to invoke this method on the layout itself. Clients are encouraged to use Control.requestLayout() where possible instead of calling this method.

If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as layout(false)).

Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.

Overrides:

layout in class Composite

Parameters:

changed - true if the layout must flush its caches, and false otherwise

getItem

public ToolItem 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:

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 ToolItem getItem(Point point)

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

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point is null

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 ToolItem[] getItems()

Returns an array of ToolItems 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

getRowCount

public int getRowCount()

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

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

indexOf

public int indexOf(ToolItem item)

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

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the tool item is null
• ERROR_INVALID_ARGUMENT - if the tool item has been disposed

SWTException -

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

setFont

public void setFont(Font font)

Description copied from class: Control

Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.

Overrides:

setFont in class Control

Parameters:

font - the new font (or null)

setParent

public boolean setParent(Composite parent)

Description copied from class: Control

Changes the parent of the widget to be the one provided. Returns true if the parent is successfully changed.

Overrides:

setParent in class Control

Parameters:

parent - the new parent for the control.

Returns:

true if the parent is changed and false otherwise.

setRedraw

public void setRedraw(boolean redraw)

Description copied from class: Control

If the argument is false, causes subsequent drawing operations in the receiver to be ignored. No drawing of any kind can occur in the receiver until the flag is set to true. Graphics operations that occurred while the flag was false are lost. When the flag is set to true, the entire widget is marked as needing to be redrawn. Nested calls to this method are stacked.

Note: This operation is a hint and may not be supported on some platforms or for some widgets.

Overrides:

setRedraw in class Control

Parameters:

redraw - the new redraw state

See Also:

• Control.redraw(int, int, int, int, boolean)
• Control.update()