Class 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:
  • Field Details

    • currentFocusItem

      ToolItem currentFocusItem
    • tabItemList

      ToolItem[] tabItemList
    • imageList

      ImageList imageList
    • hasChildFocus

      boolean hasChildFocus
    • cssBackground

      String cssBackground
    • cssForeground

      String cssForeground
  • 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:
  • Method Details

    • 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 Composite
    • createHandle

      void createHandle(int index)
      Overrides:
      createHandle in class Composite
    • applyThemeBackground

      int applyThemeBackground()
      Overrides:
      applyThemeBackground in class Composite
      Returns:
    • 0 to remove THEME_BACKGROUND
    • 1 to apply THEME_BACKGROUND
    • otherwise don't change THEME_BACKGROUND state
    • computeSizeInPixels

      Point computeSizeInPixels(int wHint, int hHint, boolean changed)
      Overrides:
      computeSizeInPixels in class Composite
    • computeTabGroup

      Widget computeTabGroup()
      Overrides:
      computeTabGroup in class Control
    • computeTabList

      Widget[] computeTabList()
      Overrides:
      computeTabList in class Composite
    • eventHandle

      long eventHandle()
      Overrides:
      eventHandle in class Control
    • enterExitHandle

      long enterExitHandle()
      Overrides:
      enterExitHandle in class Control
    • forceFocus

      boolean forceFocus(long focusHandle)
      Overrides:
      forceFocus 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
    • 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
    • _getItems

      ToolItem[] _getItems()
    • 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
    • _getTabItemList

      ToolItem[] _getTabItemList()
    • gtk3_key_press_event

      long gtk3_key_press_event(long widget, long eventPtr)
      Overrides:
      gtk3_key_press_event in class Composite
    • gtk_focus

      long gtk_focus(long widget, long directionType)
      Overrides:
      gtk_focus in class Composite
    • hasFocus

      boolean hasFocus()
      Overrides:
      hasFocus in class Control
    • 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
    • mnemonicHit

      boolean mnemonicHit(char key)
      Overrides:
      mnemonicHit in class Control
    • mnemonicMatch

      boolean mnemonicMatch(char key)
      Overrides:
      mnemonicMatch in class Control
    • relayout

      void relayout()
    • releaseChildren

      void releaseChildren(boolean destroy)
      Overrides:
      releaseChildren in class Composite
    • releaseWidget

      void releaseWidget()
      Overrides:
      releaseWidget in class Composite
    • removeControl

      void removeControl(Control control)
      Overrides:
      removeControl in class Composite
    • reskinChildren

      void reskinChildren(int flags)
      Overrides:
      reskinChildren in class Composite
    • setBounds

      int setBounds(int x, int y, int width, int height, boolean move, boolean resize)
      Overrides:
      setBounds in class Composite
    • setBackgroundGdkRGBA

      void setBackgroundGdkRGBA(long context, long handle, GdkRGBA rgba)
      Overrides:
      setBackgroundGdkRGBA in class Control
    • setParentBackground

      void setParentBackground()
      Overrides:
      setParentBackground in class Control
    • setForegroundGdkRGBA

      void setForegroundGdkRGBA(long handle, GdkRGBA rgba)
      Overrides:
      setForegroundGdkRGBA in class Control
    • setFontDescription

      void setFontDescription(long font)
      Overrides:
      setFontDescription in class Control
    • setForegroundGdkRGBA

      void setForegroundGdkRGBA(GdkRGBA rgba)
      Overrides:
      setForegroundGdkRGBA in class Control
    • setOrientation

      void setOrientation(boolean create)
      Overrides:
      setOrientation in class Composite
    • setTabItemList

      void setTabItemList(ToolItem[] tabList)
    • setToolTipText

      public void setToolTipText(String string)
      Description copied from class: Control
      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.

      Overrides:
      setToolTipText in class Control
      Parameters:
      string - the new tool tip text (or null)