|
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:
-
Adaptable
- 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, HORIZONTAL, VERTICAL
-
Events:
- (none)
Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.
IMPORTANT: This class is not intended to be subclassed.
-
Since:
- 1.0
Constructor Summary
|
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
|
Point
|
computeSize
(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver. |
Object
|
getAdapter
(
Class adapter)
Implementation of the Adaptable interface. |
int
|
getBorderWidth
()
Returns the receiver's border width. |
ToolItem
|
getItem
(int index)
Returns the item at the given, zero-relative index in the
receiver. |
int
|
getItemCount
()
Returns the number of items contained in the receiver. |
ToolItem[]
|
getItems
()
Returns an array of ToolItem s 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
|
setBounds
(
Rectangle bounds)
Sets the receiver's size and location to the rectangular
area specified by the argument. |
Methods inherited from class org.eclipse.swt.widgets.
Composite
|
changed,
getBackgroundMode,
getChildren,
getLayout,
getLayoutDeferred,
getTabList,
isLayoutDeferred,
layout,
layout,
layout,
layout,
setBackgroundMode,
setFocus,
setLayout,
setTabList
|
Methods inherited from class org.eclipse.swt.widgets.
Control
|
addControlListener,
addFocusListener,
addKeyListener,
addMouseListener,
addTraverseListener,
computeSize,
forceFocus,
getBackground,
getBackgroundImage,
getBounds,
getCursor,
getEnabled,
getFont,
getForeground,
getLayoutData,
getLocation,
getMenu,
getMonitor,
getParent,
getShell,
getSize,
getToolTipText,
getVisible,
isEnabled,
isFocusControl,
isVisible,
moveAbove,
moveBelow,
pack,
pack,
redraw,
removeControlListener,
removeFocusListener,
removeKeyListener,
removeMouseListener,
removeTraverseListener,
setBackground,
setBackgroundImage,
setBounds,
setCursor,
setEnabled,
setFont,
setForeground,
setLayoutData,
setLocation,
setLocation,
setMenu,
setRedraw,
setSize,
setSize,
setToolTipText,
setVisible,
toControl,
toControl,
toDisplay,
toDisplay
|
Methods inherited from class org.eclipse.swt.widgets.
Widget
|
addDisposeListener,
addListener,
checkSubclass,
checkWidget,
dispose,
getData,
getData,
getDisplay,
getStyle,
isDisposed,
notifyListeners,
removeDisposeListener,
removeListener,
setData,
setData,
toString
|
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:
-
,
,
,
Widget.getStyle()
getAdapter
public
Object getAdapter(
Class adapter)
-
Description copied from class:
Widget
- Implementation of the
Adaptable interface.
IMPORTANT: This method is not part of the RWT
public API. It is marked public only so that it can be shared
within the packages provided by RWT. It should never be accessed
from application code.
-
-
Specified by:
-
getAdapter
in interface
Adaptable
-
Overrides:
-
getAdapter
in class
Composite
-
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
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
ToolItem s 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
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
computeSize
public
Point computeSize(int wHint,
int hHint,
boolean changed)
-
Description copied from class:
Control
- Returns the preferred size of the receiver.
The preferred size of a control is the size that it would
best be displayed at. The width hint and height hint arguments
allow the caller to ask a control questions such as "Given a particular
width, how high does the control need to be to show all of the contents?"
To indicate that the caller does not wish to constrain a particular
dimension, the constant SWT.DEFAULT is passed for the hint.
If the changed flag is true , it indicates that the receiver's
contents have changed, therefore any caches that a layout manager
containing the control may have been keeping need to be flushed. When the
control is resized, the changed flag will be false , so layout
manager caches can be retained.
-
-
Overrides:
-
computeSize
in class
Composite
-
getBorderWidth
public int getBorderWidth()
-
Description copied from class:
Control
- Returns the receiver's border width.
-
-
Overrides:
-
getBorderWidth
in class
Control
-
-
Returns:
- the border width
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
setBounds
public void setBounds(
Rectangle bounds)
-
Description copied from class:
Control
- Sets the receiver's size and location to the rectangular
area specified by the argument. The
x and
y fields of the rectangle are relative to
the receiver's parent (or its display if its parent is null).
Note: Attempting to set the width or height of the
receiver to a negative number will cause that
value to be set to zero instead.
-
-
Overrides:
-
setBounds
in class
Control
-
-
Parameters:
-
bounds - the new bounds for the receiver
Copyright (c) Innoopract Informationssysteme GmbH and others 2002, 2008. All rights reserved.
|
|