Class ExpandBar

All Implemented Interfaces:
Drawable

public class ExpandBar extends Composite
Instances of this class support the layout of selectable expand bar items.

The item children that may be added to instances of this class must be of type ExpandItem.

Styles:
V_SCROLL
Events:
Expand, Collapse

IMPORTANT: This class is not intended to be subclassed.

Since:
3.2
See Also:
  • Field Details

    • items

      ExpandItem[] items
    • lastFocus

      ExpandItem lastFocus
    • itemCount

      int itemCount
    • spacing

      int spacing
  • Constructor Details

    • ExpandBar

      public ExpandBar(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

    • addExpandListener

      public void addExpandListener(ExpandListener listener)
      Adds the listener to the collection of listeners who will be notified when an item in the receiver is expanded or collapsed by sending it one of the messages defined in the ExpandListener interface.
      Parameters:
      listener - the listener which should 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:
    • 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
    • computeSizeInPixels

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

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

      void createItem(ExpandItem item, int style, int index)
    • createWidget

      void createWidget(int index)
      Overrides:
      createWidget in class Scrollable
    • destroyItem

      void destroyItem(ExpandItem item)
    • eventHandle

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

      boolean forceFocus(long focusHandle)
      Overrides:
      forceFocus in class Composite
    • hasFocus

      boolean hasFocus()
      Overrides:
      hasFocus in class Control
    • hookEvents

      void hookEvents()
      Overrides:
      hookEvents in class Composite
    • getItem

      public ExpandItem 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 ExpandItem[] getItems()
      Returns an array of ExpandItems 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
    • getSpacing

      public int getSpacing()
      Returns the receiver's spacing.
      Returns:
      the spacing
      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
    • gtk3_key_press_event

      long gtk3_key_press_event(long widget, long event)
      Overrides:
      gtk3_key_press_event in class Composite
    • indexOf

      public int indexOf(ExpandItem 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 item is null
      • ERROR_INVALID_ARGUMENT - if the 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
    • layoutItems

      void layoutItems()
    • gtk_size_allocate

      long gtk_size_allocate(long widget, long allocation)
      Overrides:
      gtk_size_allocate in class Widget
    • parentingHandle

      long parentingHandle()
      Overrides:
      parentingHandle in class Composite
    • releaseChildren

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

      public void removeExpandListener(ExpandListener listener)
      Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.
      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:
    • reskinChildren

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

      void setWidgetBackground()
      Overrides:
      setWidgetBackground 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
    • setSpacing

      public void setSpacing(int spacing)
      Sets the receiver's spacing. Spacing specifies the number of points allocated around each item.
      Parameters:
      spacing - the spacing around each item
      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
    • updateScrollBarValue

      void updateScrollBarValue(ScrollBar bar)
      Overrides:
      updateScrollBarValue in class Scrollable