Class CoolBar

java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.widgets.CoolBar
All Implemented Interfaces:
Drawable
public class CoolBar extends Composite
Instances of this class provide an area for dynamically positioning the items they contain.

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

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, HORIZONTAL, VERTICAL
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

    • items

      CoolItem[][] items

    • originalItems

      CoolItem[] originalItems

    • hoverCursor

      Cursor hoverCursor

    • dragCursor

      Cursor dragCursor

    • cursor

      Cursor cursor

    • dragging

      CoolItem dragging

    • mouseXOffset

      int mouseXOffset

    • itemXOffset

      int itemXOffset

    • isLocked

      boolean isLocked

    • inDispose

      boolean inDispose

    • ROW_SPACING

      static final int ROW_SPACING
      See Also:

    • CLICK_DISTANCE

      static final int CLICK_DISTANCE
      See Also:

    • DEFAULT_COOLBAR_WIDTH

      static final int DEFAULT_COOLBAR_WIDTH
      See Also:

    • DEFAULT_COOLBAR_HEIGHT

      static final int DEFAULT_COOLBAR_HEIGHT
      See Also:

  • Constructor Details

    • CoolBar

      public CoolBar(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)

    • _setCursor

      void _setCursor(Cursor cursor)

    • 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

    • computeSize

      public Point computeSize(int wHint, int hHint, boolean changed)
      Description copied from class: Control
      Returns the preferred size (in points) of the receiver.

      The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

      If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

      Overrides:
      computeSize in class Control
      Parameters:
      wHint - the width hint (can be SWT.DEFAULT)
      hHint - the height hint (can be SWT.DEFAULT)
      changed - true if the control's contents have changed, and false otherwise
      Returns:
      the preferred size of the control.
      See Also:

    • getGrabbedItem

      CoolItem getGrabbedItem(int x, int y)

    • getItem

      public CoolItem getItem(int index)
      Returns the item that is currently displayed at the given, zero-relative index. Throws an exception if the index is out of range.
      Parameters:
      index - the visual index of the item to return
      Returns:
      the item at the given visual 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 CoolItem[] getItems()
      Returns an array of CoolItems in the order in which they are currently being displayed.

      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 receiver's items in their current visual order
      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

    • findItem

      Point findItem(CoolItem item)

    • fixEvent

      void fixEvent(Event event)

    • fixRectangle

      Rectangle fixRectangle(int x, int y, int width, int height)

    • fixPoint

      Point fixPoint(int x, int y)

    • indexOf

      public int indexOf(CoolItem item)
      Searches the receiver's items in the order they are currently being displayed, 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 visual order index of the search item, or -1 if the item is not found
      Throws:
      IllegalArgumentException -
      • ERROR_NULL_ARGUMENT - if the item is null
      • ERROR_INVALID_ARGUMENT - if the item is 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

    • insertItemIntoRow

      boolean insertItemIntoRow(CoolItem item, int rowIndex, int x_root)
      Insert the item into the row. Adjust the x and width values appropriately.

    • internalRedraw

      void internalRedraw(int x, int y, int width, int height)

    • createItem

      void createItem(CoolItem item, int index)

    • destroyItem

      void destroyItem(CoolItem item)

    • moveDown

      void moveDown(CoolItem item, int x_root)

    • moveLeft

      void moveLeft(CoolItem item, int pixels)

    • moveRight

      void moveRight(CoolItem item, int pixels)

    • moveUp

      void moveUp(CoolItem item, int x_root)

    • onDispose

      void onDispose(Event event)

    • onMouseDown

      void onMouseDown(Event event)

    • onMouseExit

      void onMouseExit()

    • onMouseMove

      void onMouseMove(Event event)

    • onMouseUp

      void onMouseUp(Event event)

    • onMouseDoubleClick

      void onMouseDoubleClick(Event event)

    • onPaint

      void onPaint(Event event)

    • onResize

      void onResize()

    • removeControl

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

    • removeItemFromRow

      boolean removeItemFromRow(CoolItem item, int rowIndex, boolean disposed)
      Remove the item from the row. Adjust the x and width values appropriately.

    • layoutItems

      int layoutItems()
      Return the height of the bar after it has been properly laid out for the given width.

    • relayout

      void relayout()

    • getItemOrder

      public int[] getItemOrder()
      Returns an array of zero-relative ints that map the creation order of the receiver's items to the order in which they are currently being displayed.

      Specifically, the indices of the returned array represent the current visual order of the items, and the contents of the array represent the creation order of the items.

      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 current visual order of the receiver's 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

    • setBackground

      public void setBackground(Color color)
      Description copied from class: Control
      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.

      Note: The background color can be overridden by setting a background image.

      Overrides:
      setBackground in class Control
      Parameters:
      color - the new color (or null)

    • setItemOrder

      void setItemOrder(int[] itemOrder)

    • getItemSizes

      public Point[] getItemSizes()
      Returns an array of points whose x and y coordinates describe the widths and heights (respectively) of the items in the receiver in the order in which they are currently being displayed.
      Returns:
      the receiver's item sizes in their current visual order
      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

    • setItemSizes

      void setItemSizes(Point[] sizes)

    • getLocked

      public boolean getLocked()
      Returns whether or not the receiver is 'locked'. When a coolbar is locked, its items cannot be repositioned.
      Returns:
      true if the coolbar is locked, false otherwise
      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:
      2.0

    • getWidth

      int getWidth()

    • getWrapIndices

      public int[] getWrapIndices()
      Returns an array of ints that describe the zero-relative indices of any item(s) in the receiver that will begin on a new row. The 0th visible item always begins the first row, therefore it does not count as a wrap index.
      Returns:
      an array containing the receiver's wrap indices, or an empty array if all items are in one row
      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

    • setLocked

      public void setLocked(boolean locked)
      Sets whether or not the receiver is 'locked'. When a coolbar is locked, its items cannot be repositioned.
      Parameters:
      locked - lock the coolbar if true, otherwise unlock the coolbar
      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:
      2.0

    • setWrapIndices

      public void setWrapIndices(int[] indices)
      Sets the indices of all item(s) in the receiver that will begin on a new row. The indices are given in the order in which they are currently being displayed. The 0th item always begins the first row, therefore it does not count as a wrap index. If indices is null or empty, the items will be placed on one line.
      Parameters:
      indices - an array of wrap indices, 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

    • reskinChildren

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

    • setCursor

      public void setCursor(Cursor cursor)
      Description copied from class: Control
      Sets the receiver's cursor to the cursor specified by the argument, or to the default cursor for that kind of control if the argument is null.

      When the mouse pointer passes over a control its appearance is changed to match the control's cursor.

      Overrides:
      setCursor in class Control
      Parameters:
      cursor - the new cursor (or null)

    • setItemLayout

      public void setItemLayout(int[] itemOrder, int[] wrapIndices, Point[] sizes)
      Sets the receiver's item order, wrap indices, and item sizes all at once. This method is typically used to restore the displayed state of the receiver to a previously stored state.

      The item order is the order in which the items in the receiver should be displayed, given in terms of the zero-relative ordering of when the items were added.

      The wrap indices are the indices of all item(s) in the receiver that will begin on a new row. The indices are given in the order specified by the item order. The 0th item always begins the first row, therefore it does not count as a wrap index. If wrap indices is null or empty, the items will be placed on one line.

      The sizes are specified in an array of points whose x and y coordinates describe the new widths and heights (respectively) of the receiver's items in the order specified by the item order.

      Parameters:
      itemOrder - an array of indices that describe the new order to display the items in
      wrapIndices - an array of wrap indices, or null
      sizes - an array containing the new sizes for each of the receiver's items in visual order
      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
      IllegalArgumentException -
      • ERROR_NULL_ARGUMENT - if item order or sizes is null
      • ERROR_INVALID_ARGUMENT - if item order or sizes is not the same length as the number of items

    • setOrientation

      public void setOrientation(int orientation)
      Description copied from class: Control
      Sets the orientation of the receiver, which must be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.
      Overrides:
      setOrientation in class Control
      Parameters:
      orientation - new orientation style

    • wrapItems

      void wrapItems(int maxWidth)