Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.widgets.ToolItem

Modifier and Type	Field and Description
pack-priv long	arrowHandle
pack-priv Color	background
pack-priv long	boxHandle GTK4 only field, used to keep track of the containing box of the image & label
pack-priv Control	control
pack-priv Image	currentImage The image that is currently used by the tool item.
pack-priv Image	defaultDisableImage
pack-priv Image	disabledImage
pack-priv boolean	drawHotImage
pack-priv boolean	enabled
pack-priv long	eventHandle
pack-priv Color	foreground
pack-priv long	groupHandle GTK4 only field, used to keep track of the containing box of the image & label
pack-priv Image	hotImage
pack-priv long	imageHandle
pack-priv long	labelHandle
pack-priv boolean	mapHooked True iff map has been hooked for this ToolItem.
pack-priv ToolBar	parent
pack-priv long	provider
pack-priv long	proxyMenuItem
pack-priv String	toolTipText

Access	Constructor and Description
public	ToolItem(ToolBar a composite control which will be the parent of the new instance (cannot be null) parent, int the style of control to construct style) Constructs a new instance of this class given its parent (which must be a `ToolBar`) and a style value describing its behavior and appearance.
public	ToolItem(ToolBar a composite control which will be the parent of the new instance (cannot be null) parent, int the style of control to construct style, int the zero-relative index to store the receiver in its parent index) 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

Modifier and Type	Method and Description
private void	_setEnabledOrDisabledImage()
pack-priv void	_setImage(Image image)
public void	addSelectionListener(SelectionListener the listener which should be notified when the control is selected by the user, listener) Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the `SelectionListener` interface.
pack-priv static int	checkStyle(int style)
protected void	checkSubclass() Overrides org.eclipse.swt.widgets.Item.checkSubclass. Checks that this class can be subclassed.
pack-priv Widget[]	computeTabList()
pack-priv void	createHandle(int index) Overrides org.eclipse.swt.widgets.Widget.createHandle.
pack-priv void	createWidget(int index) Overrides org.eclipse.swt.widgets.Widget.createWidget.
pack-priv void	deregister() Overrides org.eclipse.swt.widgets.Widget.deregister.
public void	dispose() Overrides org.eclipse.swt.widgets.Widget.dispose. Disposes of the operating system resources associated with the receiver and all its descendants.
private void	disposeDefault()
pack-priv long	dpiChanged(long object, long arg0) Overrides org.eclipse.swt.widgets.Widget.dpiChanged.
public Color	Returns: the background color getBackground() Returns the receiver's background color.
public Rectangle	Returns: the receiver's bounding rectangle getBounds() Returns a rectangle describing the receiver's size and location relative to its parent.
pack-priv Rectangle	getBoundsInPixels()
public Control	Returns: the control getControl() Returns the control that is used to fill the bounds of the item when the item is a `SEPARATOR`.
public Image	Returns: the receiver's disabled image getDisabledImage() Returns the receiver's disabled image if it has one, or null if it does not.
public boolean	Returns: the receiver's enabled state getEnabled() Returns `true` if the receiver is enabled, and `false` otherwise.
public Color	Returns: the receiver's foreground color getForeground() Returns the foreground color that the receiver will use to draw.
public Image	Returns: the receiver's hot image getHotImage() Returns the receiver's hot image if it has one, or null if it does not.
public Image	Returns: the receiver's enabled image getImage() Overrides org.eclipse.swt.widgets.Item.getImage. Returns the receiver's enabled image if it has one, or null if it does not.
pack-priv String	getNameText() Overrides org.eclipse.swt.widgets.Item.getNameText.
public ToolBar	Returns: the receiver's parent getParent() Returns the receiver's parent, which must be a `ToolBar`.
public boolean	Returns: the selection state getSelection() Returns `true` if the receiver is selected, and false otherwise.
public String	Returns: the receiver's tool tip text getToolTipText() Returns the receiver's tool tip text, or null if it has not been set.
public int	Returns: the width getWidth() Gets the width of the receiver.
pack-priv int	getWidthInPixels()
pack-priv long	gtk_button_press_event(long widget, long event) Overrides org.eclipse.swt.widgets.Widget.gtk_button_press_event.
pack-priv long	gtk_button_release_event(long widget, long event) Overrides org.eclipse.swt.widgets.Widget.gtk_button_release_event.
pack-priv long	gtk_clicked(long widget) Overrides org.eclipse.swt.widgets.Widget.gtk_clicked.
pack-priv long	gtk_create_menu_proxy(long widget) Overrides org.eclipse.swt.widgets.Widget.gtk_create_menu_proxy.
pack-priv long	gtk_enter_notify_event(long widget, long event) Overrides org.eclipse.swt.widgets.Widget.gtk_enter_notify_event.
pack-priv long	gtk_event_after(long widget, long gdkEvent) Overrides org.eclipse.swt.widgets.Widget.gtk_event_after.
pack-priv long	gtk_focus_in_event(long widget, long event) Overrides org.eclipse.swt.widgets.Widget.gtk_focus_in_event.
pack-priv long	gtk_focus_out_event(long widget, long event) Overrides org.eclipse.swt.widgets.Widget.gtk_focus_out_event.
pack-priv long	gtk_leave_notify_event(long widget, long event) Overrides org.eclipse.swt.widgets.Widget.gtk_leave_notify_event.
pack-priv long	gtk_map(long widget) Overrides org.eclipse.swt.widgets.Widget.gtk_map.
pack-priv long	gtk_mnemonic_activate(long widget, long arg1) Overrides org.eclipse.swt.widgets.Widget.gtk_mnemonic_activate.
pack-priv void	hookEvents() Overrides org.eclipse.swt.widgets.Widget.hookEvents.
public boolean	Returns: the receiver's enabled state isEnabled() Returns `true` if the receiver is enabled and all of the receiver's ancestors are enabled, and `false` otherwise.
pack-priv boolean	isTabGroup()
private void	recreateMenuProxy()
pack-priv void	register() Overrides org.eclipse.swt.widgets.Widget.register.
pack-priv void	releaseHandle() Overrides org.eclipse.swt.widgets.Widget.releaseHandle.
pack-priv void	releaseWidget() Overrides org.eclipse.swt.widgets.Item.releaseWidget.
public void	removeSelectionListener(SelectionListener the listener which should no longer be notified listener) Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
pack-priv void	resizeControl()
pack-priv void	resizeHandle(int width, int height)
pack-priv void	selectRadio()
public void	setBackground(Color the new color (or null) color) Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.
public void	setControl(Control the new control control) Sets the control that is used to fill the bounds of the item when the item is a `SEPARATOR`.
public void	setDisabledImage(Image the disabled image to display on the receiver (may be null) image) Sets the receiver's disabled image to the argument, which may be null indicating that no disabled image should be displayed.
public void	setEnabled(boolean the new enabled state enabled) Enables the receiver if the argument is `true`, and disables it otherwise.
pack-priv boolean	setFocus()
pack-priv void	setFontDescription(long font)
public void	setForeground(Color the new color (or null) color) Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
public void	setHotImage(Image the hot image to display on the receiver (may be null) image) Sets the receiver's hot image to the argument, which may be null indicating that no hot image should be displayed.
public void	setImage(Image the image to display on the receiver (may be null) image) Overrides org.eclipse.swt.widgets.Item.setImage. Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
pack-priv void	setOrientation(boolean create) Overrides org.eclipse.swt.widgets.Widget.setOrientation.
pack-priv boolean	setRadioSelection(boolean value)
public void	setSelection(boolean the new selection state selected) Sets the selection state of the receiver.
pack-priv boolean	setTabItemFocus(boolean next) Overrides org.eclipse.swt.widgets.Widget.setTabItemFocus.
public void	setText(String the new text string) Overrides org.eclipse.swt.widgets.Item.setText. Sets the receiver's text.
public void	setToolTipText(String the new tool tip text (or null) string) Sets the receiver's tool tip text to the argument, which may be null indicating that the default tool tip for the control will be shown.
public void	setWidth(int the new width. If the new value is `SWT.DEFAULT`, the width is a fixed-width area whose amount is determined by the platform. If the new value is 0 a vertical or horizontal line will be drawn, depending on the setting of the corresponding style bit (`SWT.VERTICAL` or `SWT.HORIZONTAL`). If the new value is `SWT.SEPARATOR_FILL` a variable-width space is inserted that acts as a spring between the two adjoining items which will push them out to the extent of the containing ToolBar. width) Sets the width of the receiver, for `SEPARATOR` ToolItems.
pack-priv void	setWidthInPixels(int width)
pack-priv void	showWidget(int index)
pack-priv void	updateStyle()

Inherited from org.eclipse.swt.widgets.Item:: getText updateTextDirection

arrowHandle	back to summary
pack-priv long arrowHandle

background	back to summary
pack-priv Color background

boxHandle	back to summary
pack-priv long boxHandle GTK4 only field, used to keep track of the containing box of the image & label

control	back to summary
pack-priv Control control

currentImage	back to summary
pack-priv Image currentImage The image that is currently used by the tool item. Either the image set by client code via `setImage(Image)` or `setDisabledImage(Image)`, depending on button state. Or if the button is disabled but no disabled image is specified, a grayed out version of the "normal" image.

defaultDisableImage	back to summary
pack-priv Image defaultDisableImage

disabledImage	back to summary
pack-priv Image disabledImage

drawHotImage	back to summary
pack-priv boolean drawHotImage

enabled	back to summary
pack-priv boolean enabled

eventHandle	back to summary
pack-priv long eventHandle

foreground	back to summary
pack-priv Color foreground

groupHandle	back to summary
pack-priv long groupHandle GTK4 only field, used to keep track of the containing box of the image & label

hotImage	back to summary
pack-priv Image hotImage

imageHandle	back to summary
pack-priv long imageHandle

labelHandle	back to summary
pack-priv long labelHandle

mapHooked	back to summary
pack-priv boolean mapHooked True iff map has been hooked for this ToolItem. See bug 546914.

parent	back to summary
pack-priv ToolBar parent

provider	back to summary
pack-priv long provider

proxyMenuItem	back to summary
pack-priv long proxyMenuItem

toolTipText	back to summary
pack-priv String toolTipText

ToolItem	back to summary
public ToolItem(ToolBar parent, int style) 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:ToolBar a composite control which will be the parent of the new instance (cannot be null) style:int the style of control to construct Exceptions 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#PUSH`, `SWT#CHECK`, `SWT#RADIO`, `SWT#SEPARATOR`, `SWT#DROP_DOWN`, `Widget#checkSubclass`, `Widget#getStyle`

ToolItem	back to summary
public ToolItem(ToolBar parent, int style, int index) 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:ToolBar a composite control which will be the parent of the new instance (cannot be null) style:int the style of control to construct index:int the zero-relative index to store the receiver in its parent Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the parent is null ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive) 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#PUSH`, `SWT#CHECK`, `SWT#RADIO`, `SWT#SEPARATOR`, `SWT#DROP_DOWN`, `Widget#checkSubclass`, `Widget#getStyle`

Method Detail

_setEnabledOrDisabledImage	back to summary
private void _setEnabledOrDisabledImage()

_setImage	back to summary
pack-priv void _setImage(Image image)

addSelectionListener back to summary

addSelectionListener	back to summary
public void addSelectionListener(SelectionListener listener) Adds the listener to the collection of listeners who will be notified when the control is selected by the user, 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. When the `SWT.RADIO` style bit is set, the `widgetSelected` method is also called when the receiver loses selection because another item in the same radio group was selected by the user. During `widgetSelected` the application can use `getSelection()` to determine the current selected state of the receiver. Parameters listener:SelectionListener the listener which should be notified when the control is selected by the user, Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the listener 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 See Also `SelectionListener`, `removeSelectionListener`, `SelectionEvent`

public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the control is selected by the user, 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.

When the SWT.RADIO style bit is set, the widgetSelected method is also called when the receiver loses selection because another item in the same radio group was selected by the user. During widgetSelected the application can use getSelection() to determine the current selected state of the receiver.

Parameters

listener:SelectionListener: the listener which should be notified when the control is selected by the user,

Exceptions

IllegalArgumentException:

ERROR_NULL_ARGUMENT - if the listener 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

checkStyle	back to summary
pack-priv static int checkStyle(int style)

checkSubclass back to summary

checkSubclass	back to summary
protected void checkSubclass() Overrides org.eclipse.swt.widgets.Item.checkSubclass. Doc from org.eclipse.swt.widgets.Widget.checkSubclass. 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 Note 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. Annotations @Override

protected void checkSubclass()

Overrides org.eclipse.swt.widgets.Item.checkSubclass.

Doc from org.eclipse.swt.widgets.Widget.checkSubclass.

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 Note

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.

Annotations

@Override

computeTabList	back to summary
pack-priv Widget[] computeTabList()

createHandle	back to summary
pack-priv void createHandle(int index) Overrides org.eclipse.swt.widgets.Widget.createHandle. Annotations @Override

createHandle

public Class ToolItem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail