| package org.eclipse.swt.widgets;
|
|
|
| /*
|
| * (c) Copyright IBM Corp. 2000, 2001.
|
| * All Rights Reserved
|
| */
|
|
|
| import org.eclipse.swt.internal.motif.*;
|
| import org.eclipse.swt.*;
|
| import org.eclipse.swt.graphics.*;
|
|
|
| /** |
| * Instances of this class support the layout of selectable |
| * tool bar items. |
| * <p> |
| * The item children that may be added to instances of this class |
| * must be of type <code>ToolItem</code>. |
| * </p><p> |
| * 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. |
| * </p><p> |
| * <dl> |
| * <dt><b>Styles:</b></dt> |
| * <dd>FLAT, WRAP, RIGHT, HORIZONTAL, VERTICAL</dd>
|
| * <dt><b>Events:</b></dt> |
| * <dd>(none)</dd> |
| * </dl> |
| * <p> |
| * IMPORTANT: This class is <em>not</em> intended to be subclassed. |
| * </p> |
| */ |
| public /*final*/ class ToolBar extends Composite {
|
| int drawCount, itemCount;
|
| ToolItem [] items;
|
| /** |
| * Constructs a new instance of this class given its parent |
| * and a style value describing its behavior and appearance. |
| * <p> |
| * 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 <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * for all SWT widget classes should include a comment which |
| * describes the style constants which are applicable to the class. |
| * </p> |
| * |
| * @param parent a composite control which will be the parent of the new instance (cannot be null) |
| * @param style the style of control to construct |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| * |
| * @see SWT |
| * @see Widget#checkSubclass |
| * @see Widget#getStyle |
| */
|
| public ToolBar (Composite parent, int style) {
|
| super (parent, checkStyle (style));
|
|
|
| /*
|
| * Ensure that either of HORIZONTAL or VERTICAL is set.
|
| * NOTE: HORIZONTAL and VERTICAL have the same values
|
| * as H_SCROLL and V_SCROLL so it is necessary to first
|
| * clear these bits to avoid scroll bars and then reset
|
| * the bits using the original style supplied by the
|
| * programmer.
|
| */
|
| this.style = checkBits (style, SWT.HORIZONTAL, SWT.VERTICAL, 0, 0, 0, 0);
|
| }
|
| static int checkStyle (int style) {
|
| /*
|
| * Even though it is legal to create this widget
|
| * with scroll bars, they serve no useful purpose
|
| * because they do not automatically scroll the
|
| * widget's client area. The fix is to clear
|
| * the SWT style.
|
| */
|
| return style & ~(SWT.H_SCROLL | SWT.V_SCROLL);
|
| }
|
| protected void checkSubclass () {
|
| if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
|
| }
|
| public Point computeSize (int wHint, int hHint, boolean changed) {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| int width = wHint, height = hHint;
|
| if (wHint == SWT.DEFAULT) width = 0x7FFFFFFF;
|
| if (hHint == SWT.DEFAULT) height = 0x7FFFFFFF;
|
| int [] result = layout (width, height, false);
|
| int border = getBorderWidth () * 2;
|
| Point extent = new Point (result [1], result [2]);
|
| if (wHint != SWT.DEFAULT) extent.x = wHint;
|
| if (hHint != SWT.DEFAULT) extent.y = hHint;
|
| extent.x += border;
|
| extent.y += border;
|
| return extent;
|
| }
|
| void createItem (ToolItem item, int index) {
|
| if (!(0 <= index && index <= itemCount)) error (SWT.ERROR_INVALID_RANGE);
|
| if (itemCount == items.length) {
|
| ToolItem [] newItems = new ToolItem [itemCount + 4];
|
| System.arraycopy (items, 0, newItems, 0, items.length);
|
| items = newItems;
|
| }
|
| item.createWidget (index);
|
| System.arraycopy (items, index, items, index + 1, itemCount++ - index);
|
| items [index] = item;
|
| }
|
|
|
| void createHandle (int index) {
|
| super.createHandle (index);
|
| state &= ~CANVAS;
|
| }
|
|
|
| void createWidget (int index) {
|
| super.createWidget (index);
|
| items = new ToolItem [4];
|
| itemCount = 0;
|
| }
|
| void destroyItem (ToolItem item) {
|
| int index = 0;
|
| while (index < itemCount) {
|
| if (items [index] == item) break;
|
| index++;
|
| }
|
| if (index == itemCount) return;
|
| System.arraycopy (items, index + 1, items, index, --itemCount - index);
|
| items [itemCount] = null;
|
| }
|
| /** |
| * Returns the item at the given, zero-relative index in the |
| * receiver. Throws an exception if the index is out of range. |
| * |
| * @param index the index of the item to return |
| * @return the item at the given index |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public ToolItem getItem (int index) {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| ToolItem [] items = getItems ();
|
| if (0 <= index && index < items.length) return items [index];
|
| error (SWT.ERROR_INVALID_RANGE);
|
| return null;
|
| }
|
|
|
| /** |
| * 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. |
| * |
| * @param point the point used to locate the item |
| * @return the item at the given point |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public ToolItem getItem (Point pt) {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| ToolItem [] items = getItems ();
|
| for (int i=0; i<items.length; i++) {
|
| Rectangle rect = items [i].getBounds ();
|
| if (rect.contains (pt)) return items [i];
|
| }
|
| return null;
|
| }
|
|
|
| /** |
| * Returns the number of items contained in the receiver. |
| * |
| * @return the number of items |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public int getItemCount () {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| return itemCount;
|
| }
|
| /** |
| * Returns an array of <code>TabItem</code>s which are the items |
| * in the receiver. |
| * <p> |
| * 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. |
| * </p> |
| * |
| * @return the items in the receiver |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public ToolItem [] getItems () {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| ToolItem [] result = new ToolItem [itemCount];
|
| System.arraycopy (items, 0, result, 0, itemCount);
|
| return result;
|
| }
|
| /** |
| * Returns the number of rows in the receiver. When |
| * the receiver has the <code>WRAP</code> style, the |
| * number of rows can be greater than one. Otherwise, |
| * the number of rows is always one. |
| * |
| * @return the number of items |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public int getRowCount () {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| Rectangle rect = getClientArea ();
|
| return layout (rect.width, rect.height, false) [0];
|
| }
|
| /** |
| * 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. |
| * |
| * @param item the search item |
| * @return the index of the item |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the string is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public int indexOf (ToolItem item) {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| if (item == null) error (SWT.ERROR_NULL_ARGUMENT);
|
| ToolItem [] items = getItems ();
|
| for (int i=0; i<items.length; i++) {
|
| if (items [i] == item) return i;
|
| }
|
| return -1;
|
| }
|
| int [] layoutHorizontal (int nWidth, int nHeight, boolean resize) {
|
| int xSpacing = 0, ySpacing = 4;
|
| int marginWidth = 0, marginHeight = 0;
|
| ToolItem [] children = getItems ();
|
| int length = children.length;
|
| int x = marginWidth, y = marginHeight;
|
| int maxHeight = 0, maxX = 0, rows = 1;
|
| boolean wrap = (style & SWT.WRAP) != 0;
|
| for (int i=0; i<length; i++) {
|
| ToolItem child = children [i];
|
| Rectangle rect = child.getBounds ();
|
| if (wrap && i != 0 && x + rect.width > nWidth) {
|
| rows++;
|
| x = marginWidth; y += ySpacing + maxHeight;
|
| maxHeight = 0;
|
| }
|
| maxHeight = Math.max (maxHeight, rect.height);
|
| if (resize) {
|
| child.setBounds (x, y, rect.width, rect.height);
|
| }
|
| x += xSpacing + rect.width;
|
| maxX = Math.max (maxX, x);
|
| }
|
| return new int [] {rows, maxX, y + maxHeight};
|
| }
|
| int [] layoutVertical (int nWidth, int nHeight, boolean resize) {
|
| int xSpacing = 4, ySpacing = 0;
|
| int marginWidth = 0, marginHeight = 0;
|
| ToolItem [] children = getItems ();
|
| int length = children.length;
|
| int x = marginWidth, y = marginHeight;
|
| int maxWidth = 0, maxY = 0, cols = 1;
|
| boolean wrap = (style & SWT.WRAP) != 0;
|
| for (int i=0; i<length; i++) {
|
| ToolItem child = children [i];
|
| Rectangle rect = child.getBounds ();
|
| if (wrap && i != 0 && y + rect.height > nHeight) {
|
| cols++;
|
| x += xSpacing + maxWidth; y = marginHeight;
|
| maxWidth = 0;
|
| }
|
| maxWidth = Math.max (maxWidth, rect.width);
|
| if (resize) {
|
| child.setBounds (x, y, rect.width, rect.height);
|
| }
|
| y += ySpacing + rect.height;
|
| maxY = Math.max (maxY, y);
|
| }
|
| return new int [] {cols, x + maxWidth, maxY};
|
| }
|
| int [] layout (int nWidth, int nHeight, boolean resize) {
|
| if ((style & SWT.VERTICAL) != 0) {
|
| return layoutVertical (nWidth, nHeight, resize);
|
| } else {
|
| return layoutHorizontal (nWidth, nHeight, resize);
|
| }
|
| }
|
| void relayout () {
|
| if (drawCount > 0) return;
|
| Rectangle rect = getClientArea ();
|
| layout (rect.width, rect.height, true);
|
| }
|
| void relayout (int width, int height) {
|
| if (drawCount > 0) return;
|
| layout (width, height, true);
|
| }
|
| void releaseWidget () {
|
| for (int i=0; i<itemCount; i++) {
|
| ToolItem item = items [i];
|
| if (!item.isDisposed ()) {
|
| item.releaseWidget ();
|
| item.releaseHandle ();
|
| }
|
| }
|
| items = null;
|
| super.releaseWidget ();
|
| }
|
| public void setBounds (int x, int y, int width, int height) {
|
| super.setBounds (x, y, width, height);
|
| Rectangle rect = getClientArea ();
|
| relayout (rect.width, rect.height);
|
| }
|
| public void setRedraw (boolean redraw) {
|
| if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
|
| if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
|
| if (redraw) {
|
| if (--drawCount == 0) relayout();
|
| } else {
|
| drawCount++;
|
| }
|
| }
|
| public void setSize (int width, int height) {
|
| super.setSize (width, height);
|
| Rectangle rect = getClientArea ();
|
| relayout (rect.width, rect.height);
|
| }
|
| }
|