diff options
author | Silenio Quarti <silenio> | 2009-07-01 14:50:54 +0000 |
---|---|---|
committer | Silenio Quarti <silenio> | 2009-07-01 14:50:54 +0000 |
commit | 093c579a4ffd9551acb901bba9617e7aa776989d (patch) | |
tree | 71cf23798b651ef92f188390841a8d130908fb11 /bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java | |
parent | f664d297f7bb009784868bf3fcf0b3e3bb9a646b (diff) | |
download | eclipse.platform.swt-093c579a4ffd9551acb901bba9617e7aa776989d.tar.gz eclipse.platform.swt-093c579a4ffd9551acb901bba9617e7aa776989d.tar.xz eclipse.platform.swt-093c579a4ffd9551acb901bba9617e7aa776989d.zip |
restore HEAD after accidental deletion by error in automated build script
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java')
-rw-r--r-- | bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java | 702 |
1 files changed, 702 insertions, 0 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java new file mode 100644 index 0000000000..a09914cfc4 --- /dev/null +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java @@ -0,0 +1,702 @@ +/******************************************************************************* + * Copyright (c) 2000, 2009 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.internal.carbon.OS; +import org.eclipse.swt.internal.carbon.Rect; +import org.eclipse.swt.internal.carbon.CGRect; + +import org.eclipse.swt.*; +import org.eclipse.swt.events.*; +import org.eclipse.swt.graphics.*; + +/** + * Instances of this class implement the notebook user interface + * metaphor. It allows the user to select a notebook page from + * set of pages. + * <p> + * The item children that may be added to instances of this class + * must be of type <code>TabItem</code>. + * <code>Control</code> children are created and then set into a + * tab item using <code>TabItem#setControl</code>. + * </p><p> + * Note that although this class is a subclass of <code>Composite</code>, + * it does not make sense to set a layout on it. + * </p><p> + * <dl> + * <dt><b>Styles:</b></dt> + * <dd>TOP, BOTTOM</dd> + * <dt><b>Events:</b></dt> + * <dd>Selection</dd> + * </dl> + * <p> + * Note: Only one of the styles TOP and BOTTOM may be specified. + * </p><p> + * IMPORTANT: This class is <em>not</em> intended to be subclassed. + * </p> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#tabfolder">TabFolder, TabItem 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> + * @noextend This class is not intended to be subclassed by clients. + */ +public class TabFolder extends Composite { + TabItem [] items; + int lastSelected = -1; + +/** + * 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 + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. + * </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 SWT#TOP + * @see SWT#BOTTOM + * @see Widget#checkSubclass + * @see Widget#getStyle + */ +public TabFolder (Composite parent, int style) { + super (parent, checkStyle (style)); +} + +/** + * Adds the listener to the collection of listeners who will + * be notified when the user changes the receiver's selection, by sending + * it one of the messages defined in the <code>SelectionListener</code> + * interface. + * <p> + * When <code>widgetSelected</code> is called, the item field of the event object is valid. + * <code>widgetDefaultSelected</code> is not called. + * </p> + * + * @param listener the listener which should be notified when the user changes the receiver's selection + * + * @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> + * + * @see SelectionListener + * @see #removeSelectionListener + * @see SelectionEvent + */ +public void addSelectionListener(SelectionListener listener) { + checkWidget (); + if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); + TypedListener typedListener = new TypedListener (listener); + addListener (SWT.Selection,typedListener); + addListener (SWT.DefaultSelection,typedListener); +} + +static int checkStyle (int style) { + style = checkBits (style, SWT.TOP, SWT.BOTTOM, 0, 0, 0, 0); + /* + * 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); +} + +int callPaintEventHandler (int control, int damageRgn, int visibleRgn, int theEvent, int nextHandler) { + /* + * Bug in the Macintosh. The tab folder tabs draw outside the widget + * bounds when they do not fit. The fix is to clip the output to the + * widget bounds. + */ + int [] context = new int [1]; + OS.GetEventParameter (theEvent, OS.kEventParamCGContextRef, OS.typeCGContextRef, null, 4, null, context); + OS.CGContextSaveGState (context[0]); + CGRect rect = new CGRect (); + OS.HIViewGetBounds (handle, rect); + OS.CGContextAddRect (context[0], rect); + OS.CGContextClip (context [0]); + int result = super.callPaintEventHandler (control, damageRgn, visibleRgn, theEvent, nextHandler); + OS.CGContextRestoreGState (context[0]); + return result; +} + +protected void checkSubclass () { + if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); +} + +public Point computeSize (int wHint, int hHint, boolean changed) { + Point size = super.computeSize (wHint, hHint, changed); + if (wHint == SWT.DEFAULT && items.length > 0) { + int width = 0; + GC gc = new GC (this); + for (int i = 0; i < items.length; i++) { + if (items [i] != null) { + width += items [i].calculateWidth (gc); + } + } + gc.dispose (); + Rectangle trim = computeTrim (0, 0, width, 0); + size.x = Math.max (trim.width, size.x); + } + return size; +} + +public Rectangle computeTrim (int x, int y, int width, int height) { + checkWidget (); + CGRect oldBounds = new CGRect (), bounds = oldBounds; + OS.HIViewGetFrame (handle, oldBounds); + int MIN_SIZE = 100; + if (oldBounds.width < MIN_SIZE || oldBounds.height < MIN_SIZE) { + OS.HIViewSetDrawingEnabled (handle, false); + bounds = new CGRect (); + bounds.width = bounds.height = 100; + OS.HIViewSetFrame (handle, bounds); + } + Rect client = new Rect (); + OS.GetTabContentRect (handle, client); + if (oldBounds.width < MIN_SIZE || oldBounds.height < MIN_SIZE) { + OS.HIViewSetFrame (handle, oldBounds); + OS.HIViewSetDrawingEnabled (handle, getDrawing ()); + } + x -= client.left; + y -= client.top; + width += (int) bounds.width - (client.right - client.left); + height += (int) bounds.height - (client.bottom - client.top); + Rect inset = getInset (); + x -= inset.left; + y -= inset.top; + width += inset.left + inset.right; + height += inset.top + inset.bottom; + return new Rectangle (-client.left, -client.top, width, height); +} + +void createHandle () { + int [] outControl = new int [1]; + int window = OS.GetControlOwner (parent.handle); + short direction = (style & SWT.BOTTOM) != 0 ? (short)OS.kControlTabDirectionSouth : (short)OS.kControlTabDirectionNorth; + OS.CreateTabsControl (window, new Rect (), (short)OS.kControlTabSizeLarge, direction, (short) 0, 0, outControl); + if (outControl [0] == 0) error (SWT.ERROR_NO_HANDLES); + handle = outControl [0]; +} + +void createItem (TabItem item, int index) { + int count = OS.GetControl32BitMaximum (handle); + if (!(0 <= index && index <= count)) error (SWT.ERROR_INVALID_RANGE); + OS.SetControl32BitMaximum (handle, count+1); + if (count == items.length) { + TabItem [] newItems = new TabItem [items.length + 4]; + System.arraycopy (items, 0, newItems, 0, items.length); + items = newItems; + } + System.arraycopy (items, index, items, index + 1, count - index); + items [index] = item; + + /* + * Send a selection event when the item that is added becomes + * the new selection. This only happens when the first item + * is added. + */ + if (count == 0) { + OS.SetControl32BitValue (handle, 1); + lastSelected = 0; + Event event = new Event (); + event.item = items [0]; + sendEvent (SWT.Selection, event); + // the widget could be destroyed at this point + } +} + +void createWidget () { + super.createWidget (); + items = new TabItem [4]; +} + +void destroyItem (TabItem item) { + int count = OS.GetControl32BitMaximum (handle); + int index = 0; + while (index < count) { + if (items [index] == item) break; + index++; + } + if (index == count) return; + redrawWidget (handle, false); + int selectionIndex = OS.GetControl32BitValue (handle) - 1; + --count; + OS.SetControl32BitMaximum (handle, count); + System.arraycopy (items, index + 1, items, index, count - index); + items [count] = null; + if (count == 0) { + items = new TabItem [4]; + } + for (int i = index; i < count; i++) { + items [i].update (); + } + if (count > 0 && index == selectionIndex) { + setSelection (Math.max (0, selectionIndex - 1), true, true); + } + invalidateVisibleRegion (handle); +} + +public Rectangle getClientArea () { + checkWidget (); + Rect client = new Rect (); + if (OS.GetControlData (handle, (short)OS.kControlEntireControl, OS.kControlTabContentRectTag, Rect.sizeof, client, null) != OS.noErr) { + return new Rectangle(0, 0, 0, 0); + } + int x = Math.max (0, client.left); + int y = Math.max (0, client.top); + int width = Math.max (0, client.right - client.left); + int height = Math.max (0, client.bottom - client.top); + return new Rectangle (x, y, width, height); +} + +/** + * 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 TabItem getItem (int index) { + checkWidget (); + int count = OS.GetControl32BitMaximum (handle); + if (!(0 <= index && index < count)) error (SWT.ERROR_INVALID_RANGE); + return items [index]; +} + +/** + * Returns the tab 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 tab item at the given point, or null if the point is not in a tab item + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the point 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> + * + * @since 3.4 + */ +public TabItem getItem(Point point) { + checkWidget (); + if (point == null) error (SWT.ERROR_NULL_ARGUMENT); + int count = OS.GetControl32BitMaximum (handle); + for (int index = 0; index < count; index++) { + TabItem item = items[index]; + Rectangle bounds = item.getBounds(); + if (bounds.contains(point)) return item; + } + 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 () { + checkWidget (); + return OS.GetControl32BitMaximum (handle); +} + +/** + * 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 TabItem [] getItems () { + checkWidget (); + int count = OS.GetControl32BitMaximum (handle); + TabItem [] result = new TabItem [count]; + System.arraycopy (items, 0, result, 0, count); + return result; +} + +/** + * Returns an array of <code>TabItem</code>s that are currently + * selected in the receiver. An empty array indicates that no + * items are selected. + * <p> + * Note: This is not the actual structure used by the receiver + * to maintain its selection, so modifying the array will + * not affect the receiver. + * </p> + * @return an array representing the selection + * + * @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 TabItem [] getSelection () { + checkWidget (); + int index = OS.GetControl32BitValue(handle) - 1; + if (index == -1) return new TabItem [0]; + return new TabItem [] {items [index]}; +} + +/** + * Returns the zero-relative index of the item which is currently + * selected in the receiver, or -1 if no item is selected. + * + * @return the index of the selected item + * + * @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 getSelectionIndex () { + checkWidget (); + return OS.GetControl32BitValue (handle) - 1; +} + +float getThemeAlpha () { + return (background != null ? 1 : 0.25f) * parent.getThemeAlpha (); +} + +/** + * 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 item 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 (TabItem item) { + checkWidget (); + if (item == null) error (SWT.ERROR_NULL_ARGUMENT); + int count = OS.GetControl32BitMaximum (handle); + for (int i=0; i<count; i++) { + if (items [i] == item) return i; + } + return -1; +} + +Point minimumSize (int wHint, int hHint, boolean flushCache) { + Control [] children = _getChildren (); + int width = 0, height = 0; + for (int i=0; i<children.length; i++) { + Control child = children [i]; + int index = 0; + int count = OS.GetControl32BitMaximum (handle); + while (index < count) { + if (items [index].control == child) break; + index++; + } + if (index == count) { + Rectangle rect = child.getBounds (); + width = Math.max (width, rect.x + rect.width); + height = Math.max (height, rect.y + rect.height); + } else { + Point size = child.computeSize (wHint, hHint, flushCache); + width = Math.max (width, size.x); + height = Math.max (height, size.y); + } + } + return new Point (width, height); +} + +Rect getInset () { + if (OS.VERSION >= 0x1020) return super.getInset(); + return (style & SWT.BOTTOM) != 0 ? display.tabFolderSouthInset : display.tabFolderNorthInset; +} + +int kEventControlApplyBackground (int nextHandler, int theEvent, int userData) { + /* + * Feature in the Macintosh. For some reason, the tab folder applies the + * theme background when drawing even though a theme has not been set for + * the window. The fix is to avoid running the default handler. + */ + return OS.noErr; +} + +int kEventControlHit (int nextHandler, int theEvent, int userData) { + int result = super.kEventControlHit (nextHandler, theEvent, userData); + if (result == OS.noErr) return result; + int index = OS.GetControl32BitValue (handle) - 1; + if (index == lastSelected) return result; + lastSelected = index; + int count = OS.GetControl32BitMaximum (handle); + for (int i = 0; i < count; i++) { + if (i != index) { + Control control = items [i].control; + if (control != null && !control.isDisposed ()) + control.setVisible (false); + } + } + TabItem item = null; + if (index != -1) item = items [index]; + if (item != null) { + Control control = item.control; + if (control != null && !control.isDisposed ()) { + control.setBounds (getClientArea ()); + control.setVisible (true); + } + } + Event event = new Event (); + event.item = item; + postEvent (SWT.Selection, event); + return OS.noErr; +} + +int kEventControlSetFocusPart (int nextHandler, int theEvent, int userData) { + short [] part = new short [1]; + OS.GetEventParameter (theEvent, OS.kEventParamControlPart, OS.typeControlPartCode, null, 2, null, part); + if (part [0] == OS.kControlFocusNoPart || part [0] == OS.kControlFocusNextPart) { + return super.kEventControlSetFocusPart (nextHandler, theEvent, userData); + } + return OS.eventNotHandledErr; +} + +void releaseChildren (boolean destroy) { + if (items != null) { + for (int i=0; i<items.length; i++) { + TabItem item = items [i]; + if (item != null && !item.isDisposed ()) { + item.release (false); + } + } + items = null; + } + super.releaseChildren (destroy); +} + +void removeControl (Control control) { + super.removeControl (control); + int count = OS.GetControl32BitMaximum (handle); + for (int i=0; i<count; i++) { + TabItem item = items [i]; + if (item.control == control) item.setControl (null); + } +} + +/** + * Removes the listener from the collection of listeners who will + * be notified when the user changes the receiver's selection. + * + * @param listener the listener which should no longer be notified + * + * @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> + * + * @see SelectionListener + * @see #addSelectionListener + */ +public void removeSelectionListener (SelectionListener listener) { + checkWidget (); + if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); + if (eventTable == null) return; + eventTable.unhook (SWT.Selection, listener); + eventTable.unhook (SWT.DefaultSelection,listener); +} + +int setBounds (int x, int y, int width, int height, boolean move, boolean resize, boolean events) { + int result = super.setBounds(x, y, width, height, move, resize, events); + if ((result & RESIZED) != 0) { + int index = OS.GetControl32BitValue (handle) - 1; + if (index != -1) { + TabItem item = items [index]; + Control control = item.control; + if (control != null && !control.isDisposed ()) { + control.setBounds (getClientArea ()); + } + } + } + return result; +} + +/** + * Sets the receiver's selection to the given item. + * The current selected is first cleared, then the new item is + * selected. + * + * @param item the item to select + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the item 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> + * + * @since 3.2 + */ +public void setSelection (TabItem item) { + checkWidget (); + if (item == null) error (SWT.ERROR_NULL_ARGUMENT); + setSelection (new TabItem [] {item}); +} + +/** + * Sets the receiver's selection to be the given array of items. + * The current selected is first cleared, then the new items are + * selected. + * + * @param items the array of items + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the items array 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 void setSelection (TabItem [] items) { + checkWidget (); + if (items == null) error (SWT.ERROR_NULL_ARGUMENT); + if (items.length == 0) { + setSelection (-1, false, false); + } else { + for (int i=items.length - 1; i>=0; --i) { + int index = indexOf (items [i]); + if (index != -1) setSelection (index, false, false); + } + } +} + +/** + * Selects the item at the given zero-relative index in the receiver. + * If the item at the index was already selected, it remains selected. + * The current selection is first cleared, then the new items are + * selected. Indices that are out of range are ignored. + * + * @param index the index of the item to select + * + * @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 void setSelection (int index) { + checkWidget (); + int count = OS.GetControl32BitMaximum (handle); + if (!(0 <= index && index < count)) return; + setSelection (index, false, false); +} + +void setSelection (int index, boolean notify, boolean force) { + if (index >= OS.GetControl32BitMaximum (handle)) return; + int currentIndex = OS.GetControl32BitValue (handle) - 1; + if (!force && currentIndex == index) return; + if (currentIndex != -1) { + TabItem item = items [currentIndex]; + if (item != null) { + Control control = item.control; + if (control != null && !control.isDisposed ()) { + control.setVisible (false); + } + } + } + OS.SetControl32BitValue (handle, index+1); + index = OS.GetControl32BitValue (handle) - 1; + if (hasFocus ()) { + int window = OS.GetControlOwner (handle); + OS.SetKeyboardFocus (window, handle, (short) (index + 1)); + } + lastSelected = index; + if (index != -1) { + TabItem item = items [index]; + if (item != null) { + Control control = item.control; + if (control != null && !control.isDisposed ()) { + control.setBounds (getClientArea ()); + control.setVisible (true); + } + if (notify) { + Event event = new Event (); + event.item = item; + sendEvent (SWT.Selection, event); + } + } + } +} + +boolean traversePage (boolean next) { + int count = getItemCount (); + if (count == 0) return false; + int index = getSelectionIndex (); + if (index == -1) { + index = 0; + } else { + int offset = (next) ? 1 : -1; + index = (index + offset + count) % count; + } + setSelection (index, true, false); + return index == getSelectionIndex (); +} +} |