/******************************************************************************* * Copyright (c) 2000, 2012 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.*; import org.eclipse.swt.accessibility.*; import org.eclipse.swt.graphics.*; import org.eclipse.swt.internal.cocoa.*; /** * 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 ToolBar, ToolItem snippets * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class ToolBar extends Composite { int itemCount; ToolItem [] items; NSToolbar nsToolbar; NSArray accessibilityAttributes = null; ToolItem lastFocus; static int NEXT_ID; /** * 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. *

* * @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 * @exception SWTException * * @see SWT#FLAT * @see SWT#WRAP * @see SWT#RIGHT * @see SWT#HORIZONTAL * @see SWT#SHADOW_OUT * @see SWT#VERTICAL * @see Widget#checkSubclass() * @see Widget#getStyle() */ public ToolBar (Composite parent, int style) { this(parent, style, false); } ToolBar(Composite parent, int style, boolean internal) { super (parent, checkStyle (parent, style, internal)); /* * 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. */ if ((style & SWT.VERTICAL) != 0) { this.style |= SWT.VERTICAL; } else { this.style |= SWT.HORIZONTAL; } } int /*long*/ accessibilityAttributeValue (int /*long*/ id, int /*long*/ sel, int /*long*/ arg0) { NSString nsAttributeName = new NSString(arg0); if (id == accessibleHandle() && accessible != null) { id returnObject = accessible.internal_accessibilityAttributeValue(nsAttributeName, ACC.CHILDID_SELF); if (returnObject != null) return returnObject.id; } if (nsAttributeName.isEqualToString (OS.NSAccessibilityRoleAttribute) || nsAttributeName.isEqualToString (OS.NSAccessibilityRoleDescriptionAttribute)) { NSString role = OS.NSAccessibilityToolbarRole; if (nsAttributeName.isEqualToString (OS.NSAccessibilityRoleAttribute)) return role.id; else { int /*long*/ roleDescription = OS.NSAccessibilityRoleDescription(role.id, 0); return roleDescription; } } else if (nsAttributeName.isEqualToString(OS.NSAccessibilityChildrenAttribute)) { NSMutableArray returnValue = NSMutableArray.arrayWithCapacity(itemCount); for (int i = 0; i < itemCount; i++) { returnValue.addObject(new id(getItem(i).accessibleHandle())); } return returnValue.id; } else if (nsAttributeName.isEqualToString(OS.NSAccessibilityEnabledAttribute)) { return NSNumber.numberWithBool(isEnabled()).id; } else if (nsAttributeName.isEqualToString(OS.NSAccessibilityFocusedAttribute)) { boolean focused = (view.id == view.window().firstResponder().id); return NSNumber.numberWithBool(focused).id; } return super.accessibilityAttributeValue(id, sel, arg0); } boolean accessibilityIsIgnored(int /*long*/ id, int /*long*/ sel) { // Toolbars aren't ignored. if (id == view.id) return false; return super.accessibilityIsIgnored(id, sel); } static int checkStyle (Composite parent, int style, boolean internal) { /* * 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. */ int newStyle = style & ~(SWT.H_SCROLL | SWT.V_SCROLL); /* * Only internal clients can create an NSToolbar-based ToolBar. */ if (!internal && (newStyle & SWT.SMOOTH) != 0) { newStyle &= ~SWT.SMOOTH; } /* * A unified toolbar can only be parented to a Shell, and * there can only be one unified toolbar per shell. If neither of these * conditions hold, turn off the SMOOTH flag. */ if ((style & SWT.SMOOTH) != 0) { if (parent instanceof Shell) { Shell s = (Shell)parent; if (s.window.toolbar() != null) newStyle &= ~SWT.SMOOTH; } else { newStyle &= ~SWT.SMOOTH; } } /* * Unified toolbar only supports a horizontal layout, and doesn't wrap. */ if ((newStyle & SWT.SMOOTH) != 0) { newStyle &= ~(SWT.VERTICAL | SWT.WRAP); newStyle |= SWT.HORIZONTAL; } return newStyle; } protected void checkSubclass () { if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); } public Point computeSize (int wHint, int hHint, boolean changed) { checkWidget(); int width = wHint, height = hHint; if (wHint == SWT.DEFAULT) width = 0x7FFFFFFF; if (hHint == SWT.DEFAULT) height = 0x7FFFFFFF; int [] result = layout (width, height, false); Point extent = new Point (result [1], result [2]); if (wHint != SWT.DEFAULT) extent.x = wHint; if (hHint != SWT.DEFAULT) extent.y = hHint; Rectangle trim = computeTrim (0, 0, extent.x, extent.y); return new Point (trim.width, trim.height); } public Rectangle computeTrim (int x, int y, int width, int height) { checkWidget(); if (nsToolbar != null) { NSRect outer = view.frame(); NSRect inner = new NSView(view.subviews().objectAtIndex(0)).frame(); width += (int)outer.width - (int)inner.width; } else if (scrollView != null) { NSSize size = new NSSize(); size.width = width; size.height = height; size = NSScrollView.frameSizeForContentSize(size, false, false, OS.NSBezelBorder); width = (int)size.width; height = (int)size.height; NSRect frame = scrollView.contentView().frame(); x -= frame.x; y -= frame.y; } return new Rectangle (x, y, width, height); } void createHandle () { if ((style & SWT.SMOOTH) != 0) { nsToolbar = ((NSToolbar)new SWTToolbar().alloc()).initWithIdentifier(NSString.stringWith(String.valueOf(NEXT_ID++))); nsToolbar.setDelegate(nsToolbar); nsToolbar.setDisplayMode(OS.NSToolbarDisplayModeIconOnly); NSWindow window = parent.view.window(); window.setToolbar(nsToolbar); nsToolbar.setVisible(true); NSArray views = window.contentView().superview().subviews(); for (int i = 0; i < views.count(); i++) { id id = views.objectAtIndex(i); if (new NSObject(id).className().getString().equals("NSToolbarView")) { view = new NSView(id); OS.object_setClass(view.id, OS.objc_getClass("SWTToolbarView")); view.retain(); break; } } style &= ~SWT.SMOOTH; } else { state |= THEME_BACKGROUND; if (hasBorder()) { NSRect rect = new NSRect(); NSScrollView scrollWidget = (NSScrollView)new SWTScrollView().alloc(); scrollWidget.initWithFrame (rect); scrollWidget.setDrawsBackground(false); scrollWidget.setBorderType(OS.NSBezelBorder); scrollView = scrollWidget; } NSView widget = (NSView)new SWTView().alloc(); widget.init(); view = widget; if (scrollView != null) view.setAutoresizingMask(OS.NSViewHeightSizable | OS.NSViewWidthSizable); } } 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(); System.arraycopy (items, index, items, index + 1, itemCount++ - index); items [index] = item; if (nsToolbar != null) { nsToolbar.insertItemWithItemIdentifier(item.getItemID(), index); } else { view.addSubview(item.view); } relayout (); } void createWidget () { super.createWidget (); items = new ToolItem [4]; itemCount = 0; } NSFont defaultNSFont() { return NSFont.systemFontOfSize(11.0f); } void deregister () { super.deregister (); if (nsToolbar != null) display.removeWidget (nsToolbar); } void destroyItem (ToolItem item) { int index = 0; while (index < itemCount) { if (items [index] == item) break; index++; } if (index == itemCount) return; if (item == lastFocus) lastFocus = null; System.arraycopy (items, index + 1, items, index, --itemCount - index); items [itemCount] = null; if (nsToolbar != null) { nsToolbar.removeItemAtIndex(index); } else { item.view.removeFromSuperview(); } relayout (); } void drawBackground (int /*long*/ id, NSGraphicsContext context, NSRect rect) { if (id != view.id) return; if (background != null) { fillBackground (view, context, rect, -1); } } void enableWidget(boolean enabled) { super.enableWidget(enabled); for (int i = 0; i < itemCount; i++) { ToolItem item = items[i]; if (item != null) { item.enableWidget(enabled && item.getEnabled()); } } } Widget findTooltip (NSPoint pt) { pt = view.convertPoint_fromView_ (pt, null); for (int i = 0; i < itemCount; i++) { ToolItem item = items [i]; if (OS.NSPointInRect(pt, item.view.frame())) return item; } return super.findTooltip (pt); } void setZOrder() { if (nsToolbar != null) return; super.setZOrder(); } public Rectangle getBounds () { checkWidget(); if (nsToolbar != null) { // The NSToolbar's view will always be a child of the Shell, so we can just // convert the frame to window-relative coordinates. NSRect rect = view.frame(); rect = view.convertRect_toView_(rect, null); return new Rectangle((int)rect.x, (int)rect.y, (int)rect.width, (int)rect.height); } return super.getBounds(); } boolean forceFocus (NSView focusView) { if (lastFocus != null && lastFocus.setFocus ()) return true; ToolItem [] items = getItems (); for (int i = 0; i < items.length; i++) { ToolItem item = items [i]; if (item.setFocus ()) { lastFocus = item; return true; } } return false; } /** * 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 * @exception SWTException */ public ToolItem getItem (int index) { checkWidget(); if (0 <= index && index < itemCount) 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 * @exception SWTException */ public ToolItem getItem (Point point) { checkWidget(); if (point == null) error (SWT.ERROR_NULL_ARGUMENT); for (int i=0; i *
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • *
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
  • * */ public int getItemCount () { checkWidget(); return itemCount; } /** * 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. *

    * * @return the items in the receiver * * @exception SWTException */ public ToolItem [] getItems () { checkWidget(); 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 WRAP 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 */ public int getRowCount () { checkWidget(); Rectangle rect = getClientArea (); return layout (rect.width, rect.height, false) [0]; } boolean hasKeyboardFocus(int inId) { return hasFocus(); } /** * 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 * @exception SWTException */ public int indexOf (ToolItem item) { checkWidget(); if (item == null) error (SWT.ERROR_NULL_ARGUMENT); if (item.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT); for (int i=0; i width) { rows++; x = marginWidth; y += ySpacing + itemHeight; } if (resize) { item.setBounds (x, y, size.x, itemHeight); boolean visible = x + size.x <= width && y + itemHeight <= height; item.setVisible (visible); Control control = item.control; if (control != null) { control.setBounds (x, y, size.x, itemHeight); } } x += xSpacing + size.x; maxX = Math.max (maxX, x); } return new int [] {rows, maxX, y + itemHeight}; } int [] layoutUnified (int width, int height, boolean resize) { int x = 0, y = 0; int itemHeight = 0, maxX = 0; Point [] sizes = new Point [itemCount]; NSRect [] containerRects = new NSRect[itemCount]; // This next line relies on the observation that all of the toolbar item views are children of the first // subview of the NSToolbarView. NSArray itemViewers = new NSView(view.subviews().objectAtIndex(0)).subviews(); for (int i=0; i height) { cols++; x += xSpacing + itemWidth; y = marginHeight; } if (resize) { item.setBounds (x, y, itemWidth, size.y); boolean visible = x + itemWidth <= width && y + size.y <= height; item.setVisible (visible); Control control = item.control; if (control != null) { control.setBounds (x, y, itemWidth, size.y); } } y += ySpacing + size.y; maxY = Math.max (maxY, y); } return new int [] {cols, x + itemWidth, maxY}; } int [] layout (int nWidth, int nHeight, boolean resize) { if (nsToolbar != null) { return layoutUnified(nWidth, nHeight, resize); } if ((style & SWT.VERTICAL) != 0) { return layoutVertical (nWidth, nHeight, resize); } else { return layoutHorizontal (nWidth, nHeight, resize); } } void register() { super.register(); if (nsToolbar != null) display.addWidget (nsToolbar, this); } void relayout () { if (!getDrawing()) return; Rectangle rect = getClientArea (); layout (rect.width, rect.height, true); } void releaseChildren (boolean destroy) { if (items != null) { for (int i=0; i