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
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.

See Also:

  • Field Details

    • arrowHandle

      long arrowHandle

    • labelHandle

      long labelHandle

    • imageHandle

      long imageHandle

    • eventHandle

      long eventHandle

    • proxyMenuItem

      long proxyMenuItem

    • provider

      long provider

    • boxHandle

      long boxHandle
      GTK4 only field, used to keep track of the containing box of the image invalid input: '&' label

    • groupHandle

      long groupHandle
      GTK4 only field, used to keep track of the containing box of the image invalid input: '&' label

    • parent

      ToolBar parent

    • control

      Control control

    • hotImage

      Image hotImage

    • disabledImage

      Image disabledImage

    • defaultDisableImage

      Image defaultDisableImage

    • background

      Color background

    • foreground

      Color foreground

    • toolTipText

      String toolTipText

    • drawHotImage

      boolean drawHotImage

    • mapHooked

      boolean mapHooked
      True iff map has been hooked for this ToolItem. See bug 546914.

    • enabled

      boolean enabled

    • currentImage

      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.

  • Constructor Details

    • ToolItem

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

    • ToolItem

      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 - a composite control which will be the parent of the new instance (cannot be null)
      style - the style of control to construct
      index - the zero-relative index to store the receiver in its parent
      Throws:
      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:

  • Method Details

    • addSelectionListener

      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 - the listener which should be notified when the control is selected by the user,
      Throws:
      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:

    • 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

    • createHandle

      void createHandle(int index)
      Overrides:
      createHandle in class Widget

    • createWidget

      void createWidget(int index)
      Overrides:
      createWidget in class Widget

    • computeTabList

      Widget[] computeTabList()

    • deregister

      void deregister()
      Overrides:
      deregister in class Widget

    • dispose

      public void dispose()
      Description copied from class: Widget
      Disposes of the operating system resources associated with the receiver and all its descendants. After this method has been invoked, the receiver and all descendants will answer true when sent the message isDisposed(). Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection. This method does nothing if the widget is already disposed.

      NOTE: This method is not called recursively on the descendants of the receiver. This means that, widget implementers can not detect when a widget is being disposed of by re-implementing this method, but should instead listen for the Dispose event.

      Overrides:
      dispose in class Widget
      See Also:

    • getBackground

      public Color getBackground()
      Returns the receiver's background color.

      Note: This operation is a hint and may be overridden by the platform. For example, on some versions of Windows the background of a TabFolder, is a gradient rather than a solid color.

      Returns:
      the background color
      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
      Since:
      3.120

    • getBounds

      public Rectangle getBounds()
      Returns a rectangle describing the receiver's size and location relative to its parent.
      Returns:
      the receiver's bounding rectangle
      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

    • getControl

      public Control getControl()
      Returns the control that is used to fill the bounds of the item when the item is a SEPARATOR.
      Returns:
      the control
      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

    • getDisabledImage

      public Image getDisabledImage()
      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
      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

    • getEnabled

      public boolean getEnabled()
      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
      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
      See Also:

    • getForeground

      public Color getForeground()
      Returns the foreground color that the receiver will use to draw.
      Returns:
      the receiver's foreground color
      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
      Since:
      3.120

    • getHotImage

      public Image getHotImage()
      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
      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

    • getImage

      public Image getImage()
      Returns the receiver's enabled image if it has one, or null if it does not.
      Overrides:
      getImage in class Item
      Returns:
      the receiver's enabled image
      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

    • getParent

      public ToolBar getParent()
      Returns the receiver's parent, which must be a ToolBar.
      Returns:
      the receiver's parent
      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

    • getSelection

      public boolean getSelection()
      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
      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

    • getToolTipText

      public String getToolTipText()
      Returns the receiver's tool tip text, or null if it has not been set.
      Returns:
      the receiver's tool tip text
      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

    • getWidth

      public int getWidth()
      Gets the width of the receiver.
      Returns:
      the width
      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

    • gtk_button_press_event

      long gtk_button_press_event(long widget, long event)
      Overrides:
      gtk_button_press_event in class Widget

    • gtk_button_release_event

      long gtk_button_release_event(long widget, long event)
      Overrides:
      gtk_button_release_event in class Widget

    • gtk_clicked

      long gtk_clicked(long widget)
      Overrides:
      gtk_clicked in class Widget

    • gtk_create_menu_proxy

      long gtk_create_menu_proxy(long widget)
      Overrides:
      gtk_create_menu_proxy in class Widget

    • gtk_enter_notify_event

      long gtk_enter_notify_event(long widget, long event)
      Overrides:
      gtk_enter_notify_event in class Widget

    • gtk4_enter_event

      void gtk4_enter_event(long controller, double x, double y, long event)
      Overrides:
      gtk4_enter_event in class Widget
      Parameters:
      controller - the corresponding controller responsible for capturing the event
      x - x coordinate of pointer location
      y - y coordinate of pointer location
      event - the GdkEvent captured

    • gtk3_event_after

      long gtk3_event_after(long widget, long gdkEvent)
      Overrides:
      gtk3_event_after in class Widget

    • gtk_focus_in_event

      long gtk_focus_in_event(long widget, long event)
      Overrides:
      gtk_focus_in_event in class Widget

    • gtk_focus_out_event

      long gtk_focus_out_event(long widget, long event)
      Overrides:
      gtk_focus_out_event in class Widget

    • gtk_leave_notify_event

      long gtk_leave_notify_event(long widget, long event)
      Overrides:
      gtk_leave_notify_event in class Widget

    • gtk4_leave_event

      void gtk4_leave_event(long controller, long event)
      Overrides:
      gtk4_leave_event in class Widget
      Parameters:
      controller - the corresponding controller responsible for capturing the event
      event - the GdkEvent captured

    • gtk_map

      long gtk_map(long widget)
      Overrides:
      gtk_map in class Widget

    • gtk_mnemonic_activate

      long gtk_mnemonic_activate(long widget, long arg1)
      Overrides:
      gtk_mnemonic_activate in class Widget

    • hookEvents

      void hookEvents()
      Overrides:
      hookEvents in class Widget

    • isEnabled

      public boolean isEnabled()
      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
      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
      See Also:

    • isTabGroup

      boolean isTabGroup()

    • register

      void register()
      Overrides:
      register in class Widget

    • releaseHandle

      void releaseHandle()
      Overrides:
      releaseHandle in class Widget

    • releaseWidget

      void releaseWidget()
      Overrides:
      releaseWidget in class Item

    • removeSelectionListener

      public void removeSelectionListener(SelectionListener listener)
      Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
      Parameters:
      listener - the listener which should no longer be notified
      Throws:
      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:

    • resizeControl

      void resizeControl()

    • resizeHandle

      void resizeHandle(int width, int height)

    • selectRadio

      void selectRadio()

    • setBackground

      public void setBackground(Color 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.

      Note: This operation is a hint and may be overridden by the platform.

      Parameters:
      color - the new color (or null)
      Throws:
      IllegalArgumentException -
      • ERROR_INVALID_ARGUMENT - if the argument 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
      Since:
      3.120

    • setControl

      public void setControl(Control control)
      Sets the control that is used to fill the bounds of the item when the item is a SEPARATOR.
      Parameters:
      control - the new control
      Throws:
      IllegalArgumentException -
      • ERROR_INVALID_ARGUMENT - if the control has been disposed
      • ERROR_INVALID_PARENT - if the control is not in the same widget tree
      SWTException -
      • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

    • setDisabledImage

      public void setDisabledImage(Image image)
      Sets the receiver's disabled image to the argument, which may be null indicating that no disabled image should be displayed.

      The disabled image is displayed when the receiver is disabled.

      Parameters:
      image - the disabled image to display on the receiver (may be null)
      Throws:
      IllegalArgumentException -
      • ERROR_INVALID_ARGUMENT - if the image 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

    • setEnabled

      public void setEnabled(boolean 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
      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

    • _setEnabledOrDisabledImage

      private void _setEnabledOrDisabledImage()

    • setFocus

      boolean setFocus()

    • setFontDescription

      void setFontDescription(long font)

    • setForeground

      public void setForeground(Color 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.

      Note: This operation is a hint and may be overridden by the platform.

      Parameters:
      color - the new color (or null)
      Throws:
      IllegalArgumentException -
      • ERROR_INVALID_ARGUMENT - if the argument 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
      Since:
      3.120

    • setHotImage

      public void setHotImage(Image image)
      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)
      Throws:
      IllegalArgumentException -
      • ERROR_INVALID_ARGUMENT - if the image 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

    • setImage

      public void setImage(Image image)
      Description copied from class: Item
      Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
      Overrides:
      setImage in class Item
      Parameters:
      image - the image to display on the receiver (may be null)

    • disposeDefault

      private void disposeDefault()

    • _setImage

      void _setImage(Image image)

    • setOrientation

      void setOrientation(boolean create)
      Overrides:
      setOrientation in class Widget

    • setRadioSelection

      boolean setRadioSelection(boolean value)

    • setSelection

      public void setSelection(boolean selected)
      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
      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

    • setTabItemFocus

      boolean setTabItemFocus(boolean next)
      Overrides:
      setTabItemFocus in class Widget

    • setText

      public void setText(String string)
      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.

      Note: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.

      Overrides:
      setText in class Item
      Parameters:
      string - the new text
      Throws:
      IllegalArgumentException -
      • ERROR_NULL_ARGUMENT - if the text 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

    • setToolTipText

      public void setToolTipText(String 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. For a control that has a default tool tip, such as the Tree control on Windows, setting the tool tip text to an empty string replaces the default, causing no tool tip text to be shown.

      The mnemonic indicator (character '&') is not displayed in a tool tip. To display a single '&' in the tool tip, the character '&' can be escaped by doubling it in the string.

      NOTE: This operation is a hint and behavior is platform specific, on Windows for CJK-style mnemonics of the form " (&C)" at the end of the tooltip text are not shown in tooltip.

      Parameters:
      string - the new tool tip text (or null)
      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

    • setWidth

      public void setWidth(int width)
      Sets the width of the receiver, for SEPARATOR ToolItems.
      Parameters:
      width - 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.
      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

    • showWidget

      void showWidget(int index)

    • updateStyle

      void updateStyle()

    • getNameText

      String getNameText()
      Overrides:
      getNameText in class Item

    • dpiChanged

      long dpiChanged(long object, long arg0)
      Overrides:
      dpiChanged in class Widget

    • recreateMenuProxy

      private void recreateMenuProxy()