CoolBar

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 <code>CoolItem</code>. Note that although this class is a subclass of <code>Composite</code>, it does not make sense to add <code>Control</code> children to it, or set a layout on it. <dl> <dt>Styles:</dt> <dd>FLAT, HORIZONTAL, VERTICAL</dd> <dt>Events:</dt> <dd>(none)</dd> </dl> Note: Only one of the styles HORIZONTAL and VERTICAL may be specified. IMPORTANT: This class is not intended to be subclassed.

@see <a href="http://www.eclipse.org/swt/snippets/#coolbar">CoolBar snippets</a> @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class CoolBar : Composite {

CoolItem[][] items;

CoolItem[] originalItems;

Cursor hoverCursor;

Cursor dragCursor;

Cursor cursor;

CoolItem dragging;

int mouseXOffset;

int itemXOffset;

bool isLocked;

bool inDispose;

int ROW_SPACING;

int CLICK_DISTANCE;

int DEFAULT_COOLBAR_WIDTH;

int DEFAULT_COOLBAR_HEIGHT;

this(Composite parent, int style);

CoolItem getItem(int index);

int getItemCount();

CoolItem[] getItems();

int indexOf(CoolItem item);

void insertItemIntoRow(CoolItem item, int rowIndex, int x_root);

void removeItemFromRow(CoolItem item, int rowIndex, bool disposed);

int layoutItems();

int[] getItemOrder();

Point[] getItemSizes();

bool getLocked();

int[] getWrapIndices();

void setLocked(bool locked);

void setWrapIndices(int[] indices);

void setItemLayout(int[] itemOrder, int[] wrapIndices, Point[] sizes);

}

Constructors

this this(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 <code>SWT</code> which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Members

Functions

getItem 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.
getItemCount int getItemCount(): Returns the number of items contained in the receiver.
getItemOrder 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.
getItemSizes 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.
getItems CoolItem[] getItems(): Returns an array of <code>CoolItem</code>s 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.
getLocked bool getLocked(): Returns whether or not the receiver is 'locked'. When a coolbar is locked, its items cannot be repositioned.
getWrapIndices 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.
indexOf 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.
insertItemIntoRow void insertItemIntoRow(CoolItem item, int rowIndex, int x_root): Insert the item into 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.
removeItemFromRow void removeItemFromRow(CoolItem item, int rowIndex, bool disposed): Remove the item from the row. Adjust the x and width values appropriately.
setItemLayout 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.
setLocked void setLocked(bool locked): Sets whether or not the receiver is 'locked'. When a coolbar is locked, its items cannot be repositioned.
setWrapIndices 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.

Inherited Members

From Composite

changed void changed(Control[] changed): Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver. If an ancestor does not have a layout, it is skipped.
getBackgroundMode int getBackgroundMode(): Returns the receiver's background drawing mode. This will be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERTIT_FORCE</code>.
getChildren Control[] getChildren(): Returns a (possibly empty) array containing the receiver's children. Children are returned in the order that they are drawn. The topmost control appears at the beginning of the array. Subsequent controls draw beneath this control and appear later in the array. Note: This is not the actual structure used by the receiver to maintain its list of children, so modifying the array will not affect the receiver.
getLayout Layout getLayout(): Returns layout which is associated with the receiver, or null if one has not been set.
getLayoutDeferred bool getLayoutDeferred(): Returns <code>true</code> if the receiver has deferred the performing of layout, and <code>false</code> otherwise.
getTabList Control[] getTabList(): Gets the (possibly empty) tabbing order for the control.
isLayoutDeferred bool isLayoutDeferred(): Returns <code>true</code> if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts. Otherwise, <code>false</code> is returned.
layout void layout(): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing. This is equivalent to calling <code>layout(true)</code>. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the argument is <code>true</code> the layout must not rely on any information it has cached about the immediate children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing. If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed, bool all): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the changed argument is <code>true</code> the layout must not rely on any information it has cached about its children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the all argument is <code>true</code> the layout will cascade down through all child widgets in the receiver's widget tree, regardless of whether the child has changed size. The changed argument is applied to all layouts. If the all argument is <code>false</code>, the layout will not cascade down through all child widgets in the receiver's widget tree. However, if a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(Control[] changed): Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver. The layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
setBackgroundMode void setBackgroundMode(int mode): Sets the background drawing mode to the argument which should be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERIT_FORCE</code>.
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null.
setLayoutDeferred void setLayoutDeferred(bool defer): If the argument is <code>true</code>, causes subsequent layout operations in the receiver or any of its children to be ignored. No layout of any kind can occur in the receiver or any of its children until the flag is set to false. Layout operations that occurred while the flag was <code>true</code> are remembered and when the flag is set to <code>false</code>, the layout operations are performed in an optimized manner. Nested calls to this method are stacked.
setTabList void setTabList(Control[] tabList): Sets the tabbing order for the specified controls to match the order that they occur in the argument list.