org.eclipse.swt.widgets
Class ToolItem

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Item
              |
              +--org.eclipse.swt.widgets.ToolItem

public class ToolItem

extends Item

Safe: Instances of this class represent a selectable user interface object that represents a button in a tool bar.

Styles:

PUSH, CHECK, RADIO, SEPARATOR, DROP_DOWN

Events:

Selection

Note: Only one of the styles CHECK, PUSH, RADIO, SEPARATOR and DROP_DOWN may be specified.

IMPORTANT: This class is not intended to be subclassed.

Field Summary

(package private) Control	control
(package private) Image	disabledImage
(package private) Image	disabledImage2
(package private) Image	hotImage
(package private) int	id
(package private) ToolBar	parent
(package private) String	toolTipText

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

image, text

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

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

Constructor Summary

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

ToolItem(ToolBar parent, int style, int index)
Enabled: Constructs a new instance of this class given its parent (which must be a ToolBar), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

Method Summary

void	addSelectionListener(SelectionListener listener) Enabled: Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
(package private) void	click(boolean dropDown)
(package private) Image	createDisabledImage(Image image, Color color)
Rectangle	getBounds() Enabled: Returns a rectangle describing the receiver's size and location relative to its parent.
Control	getControl() Enabled: Returns the control that is used to fill the bounds of the item when the items is a SEPARATOR.
Image	getDisabledImage() Enabled: Returns the receiver's disabled image if it has one, or null if it does not.
Display	getDisplay() Enabled:
boolean	getEnabled() Enabled: Returns true if the receiver is enabled, and false otherwise.
Image	getHotImage() Enabled: Returns the receiver's hot image if it has one, or null if it does not.
ToolBar	getParent() Enabled: Returns the receiver's parent, which must be a ToolBar.
boolean	getSelection() Enabled: Returns true if the receiver is selected, and false otherwise.
String	getToolTipText() Enabled: Returns the receiver's tool tip text, or null if it has not been set.
int	getWidth() Enabled: Gets the width of the receiver.
boolean	isEnabled() Enabled: Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise.
(package private) void	releaseChild()
(package private) void	releaseImages()
(package private) void	releaseWidget()
void	removeSelectionListener(SelectionListener listener) Enabled: Removes the listener from the collection of listeners who will be notified when the control is selected.
(package private) void	resizeControl()
(package private) void	selectRadio()
void	setControl(Control control) Enabled: Sets the control that is used to fill the bounds of the item when the items is a SEPARATOR.
void	setDisabledImage(Image image) Enabled: Sets the receiver's disabled image to the argument, which may be null indicating that no disabled image should be displayed.
void	setEnabled(boolean enabled) Enabled: Enables the receiver if the argument is true, and disables it otherwise.
void	setHotImage(Image image) Enabled: Sets the receiver's hot image to the argument, which may be null indicating that no hot image should be displayed.
void	setImage(Image image) Enabled:
(package private) boolean	setRadioSelection(boolean value)
void	setSelection(boolean selected) Enabled: Sets the selection state of the receiver.
void	setText(String string) Enabled: Sets the receiver's text.
void	setToolTipText(String string) Enabled: Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.
void	setWidth(int width) Enabled: Sets the width of the receiver.
(package private) void	updateImages()
(package private) int	widgetStyle()
(package private) org.eclipse.swt.internal.win32.LRESULT	wmCommandChild(int wParam, int lParam)

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

getImage, getNameText, getText

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseHandle, 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

parent

ToolBar parent

control

Control control

toolTipText

String toolTipText

disabledImage

Image disabledImage

hotImage

Image hotImage

disabledImage2

Image disabledImage2

id

int id

Constructor Detail

ToolItem

public ToolItem(ToolBar parent,
                int style)

Enabled: Constructs a new instance of this class given its parent (which must be a ToolBar) and a style value describing its behavior and appearance. The item is added to the end of the items maintained by its parent.

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.PUSH, SWT.CHECK, SWT.RADIO, SWT.SEPARATOR, SWT.DROP_DOWN, Widget.checkSubclass(), Widget.getStyle()

ToolItem

public ToolItem(ToolBar parent,
                int style,
                int index)

Enabled: Constructs a new instance of this class given its parent (which must be a ToolBar), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

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

index - the index to store the receiver in its parent

See Also:

SWT.PUSH, SWT.CHECK, SWT.RADIO, SWT.SEPARATOR, SWT.DROP_DOWN, Widget.checkSubclass(), Widget.getStyle()

Method Detail

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Enabled: Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called when the mouse is over the arrow portion of a drop-down tool, the event object detail field contains the value SWT.ARROW. widgetDefaultSelected is not called.

Parameters:

listener - the listener which should be notified

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

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 Item

click

void click(boolean dropDown)

createDisabledImage

Image createDisabledImage(Image image,
                          Color color)

getBounds

public Rectangle getBounds()

Enabled: Returns a rectangle describing the receiver's size and location relative to its parent.

Returns:

the receiver's bounding rectangle

getControl

public Control getControl()

Enabled: Returns the control that is used to fill the bounds of the item when the items is a SEPARATOR.

Returns:

the control

getDisabledImage

public Image getDisabledImage()

Enabled: Returns the receiver's disabled image if it has one, or null if it does not.

The disabled image is displayed when the receiver is disabled.

Returns:

the receiver's disabled image

getDisplay

public Display getDisplay()

Enabled:

Specified by:

getDisplay in class Widget

Returns:

the receiver's display

getEnabled

public boolean getEnabled()

Enabled: Returns true if the receiver is enabled, and false otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Returns:

the receiver's enabled state

See Also:

isEnabled()

getHotImage

public Image getHotImage()

Enabled: Returns the receiver's hot image if it has one, or null if it does not.

The hot image is displayed when the mouse enters the receiver.

Returns:

the receiver's hot image

getParent

public ToolBar getParent()

Enabled: Returns the receiver's parent, which must be a ToolBar.

Returns:

the receiver's parent

getSelection

public boolean getSelection()

Enabled: Returns true if the receiver is selected, and false otherwise.

When the receiver is of type CHECK or RADIO, it is selected when it is checked (which some platforms draw as a pushed in button). If the receiver is of any other type, this method returns false.

Returns:

the selection state

getToolTipText

public String getToolTipText()

Enabled: Returns the receiver's tool tip text, or null if it has not been set.

Returns:

the receiver's tool tip text

getWidth

public int getWidth()

Enabled: Gets the width of the receiver.

Returns:

the width

isEnabled

public boolean isEnabled()

Enabled: Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Returns:

the receiver's enabled state

See Also:

getEnabled()

releaseChild

void releaseChild()

Overrides:

releaseChild in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Item

releaseImages

void releaseImages()

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Enabled: Removes the listener from the collection of listeners who will be notified when the control is selected.

Parameters:

listener - the listener which should be notified

See Also:

SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

resizeControl

void resizeControl()

selectRadio

void selectRadio()

setControl

public void setControl(Control control)

Enabled: Sets the control that is used to fill the bounds of the item when the items is a SEPARATOR.

Parameters:

control - the new control

setEnabled

public void setEnabled(boolean enabled)

Enabled: Enables the receiver if the argument is true, and disables it otherwise.

A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Parameters:

enabled - the new enabled state

setDisabledImage

public void setDisabledImage(Image image)

Enabled: Sets the receiver's disabled image to the argument, which may be null indicating that no disabled image should be displayed.

The disbled image is displayed when the receiver is disabled.

Parameters:

image - the disabled image to display on the receiver (may be null)

setHotImage

public void setHotImage(Image image)

Enabled: Sets the receiver's hot image to the argument, which may be null indicating that no hot image should be displayed.

The hot image is displayed when the mouse enters the receiver.

Parameters:

image - the hot image to display on the receiver (may be null)

setImage

public void setImage(Image image)

Enabled:

Overrides:

setImage in class Item

Parameters:

image - the image to display on the receiver (may be null)

setRadioSelection

boolean setRadioSelection(boolean value)

setSelection

public void setSelection(boolean selected)

Enabled: Sets the selection state of the receiver.

When the receiver is of type CHECK or RADIO, it is selected when it is checked (which some platforms draw as a pushed in button).

Parameters:

selected - the new selection state

setText

public void setText(String string)

Enabled: Sets the receiver's text. The string may include the mnemonic character.

Mnemonics are indicated by an '&' that causes the next character to be the mnemonic. When the user presses a key sequence that matches the mnemonic, a selection event occurs. On most platforms, the mnemonic appears underlined but may be emphasised in a platform specific manner. The mnemonic indicator character '&' can be escaped by doubling it in the string, causing a single '&' to be displayed.

Overrides:

setText in class Item

Parameters:

string - the new text

setToolTipText

public void setToolTipText(String string)

Enabled: Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.

Parameters:

string - the new tool tip text (or null)

setWidth

public void setWidth(int width)

Enabled: Sets the width of the receiver.

Parameters:

width - the new width

updateImages

void updateImages()

widgetStyle

int widgetStyle()

wmCommandChild

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