Mercurial > projects > dwt-mac
diff dwt/widgets/TreeItem.d @ 0:380af2bdd8e5
Upload of whole dwt tree
author | Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com> |
---|---|
date | Sat, 09 Aug 2008 17:00:02 +0200 |
parents | |
children | 649b8e223d5a |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwt/widgets/TreeItem.d Sat Aug 09 17:00:02 2008 +0200 @@ -0,0 +1,1369 @@ +/******************************************************************************* + * Copyright (c) 2000, 2007 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 + *******************************************************************************/ +module dwt.widgets.TreeItem; + +import dwt.dwthelper.utils; + + +import dwt.DWT; +import dwt.DWTException; +import dwt.graphics.Color; +import dwt.graphics.Font; +import dwt.graphics.GC; +import dwt.graphics.Image; +import dwt.graphics.Rectangle; +import dwt.internal.cocoa.NSAttributedString; +import dwt.internal.cocoa.NSColor; +import dwt.internal.cocoa.NSMutableDictionary; +import dwt.internal.cocoa.NSOutlineView; +import dwt.internal.cocoa.NSRect; +import dwt.internal.cocoa.NSString; +import dwt.internal.cocoa.OS; +import dwt.internal.cocoa.SWTTreeItem; + +/** + * Instances of this class represent a selectable user interface object + * that represents a hierarchy of tree items in a tree widget. + * + * <dl> + * <dt><b>Styles:</b></dt> + * <dd>(none)</dd> + * <dt><b>Events:</b></dt> + * <dd>(none)</dd> + * </dl> + * <p> + * IMPORTANT: This class is <em>not</em> intended to be subclassed. + * </p> + */ +public class TreeItem extends Item { + Tree parent; + TreeItem parentItem; + TreeItem[] items; + int itemCount; + String [] strings; + Image [] images; + bool checked, grayed, cached, expanded; + Color foreground, background; + Color[] cellForeground, cellBackground; + Font font; + Font[] cellFont; + int width = -1; + // + SWTTreeItem handle; + +/** + * Constructs a new instance of this class given its parent + * (which must be a <code>Tree</code> or a <code>TreeItem</code>) + * and a style value describing its behavior and appearance. + * The item is added to the end of the items maintained by its parent. + * <p> + * The style value is either one of the style constants defined in + * class <code>DWT</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>DWT</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 tree 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 DWTException <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 DWT + * @see Widget#checkSubclass + * @see Widget#getStyle + */ +public TreeItem (Tree parent, int style) { + this (checkNull (parent), null, style, -1, true); +} + +/** + * Constructs a new instance of this class given its parent + * (which must be a <code>Tree</code> or a <code>TreeItem</code>), + * a style value describing its behavior and appearance, and the index + * at which to place it in the items maintained by its parent. + * <p> + * The style value is either one of the style constants defined in + * class <code>DWT</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>DWT</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 tree control which will be the parent of the new instance (cannot be null) + * @param style the style of control to construct + * @param index the zero-relative index to store the receiver in its parent + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> + * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li> + * </ul> + * @exception DWTException <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 DWT + * @see Widget#checkSubclass + * @see Widget#getStyle + */ +public TreeItem (Tree parent, int style, int index) { + this (checkNull (parent), null, style, checkIndex (index), true); +} + +/** + * Constructs a new instance of this class given its parent + * (which must be a <code>Tree</code> or a <code>TreeItem</code>) + * and a style value describing its behavior and appearance. + * The item is added to the end of the items maintained by its parent. + * <p> + * The style value is either one of the style constants defined in + * class <code>DWT</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>DWT</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 parentItem a tree 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 DWTException <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 DWT + * @see Widget#checkSubclass + * @see Widget#getStyle + */ +public TreeItem (TreeItem parentItem, int style) { + this (checkNull (parentItem).parent, parentItem, style, -1, true); +} + +/** + * Constructs a new instance of this class given its parent + * (which must be a <code>Tree</code> or a <code>TreeItem</code>), + * a style value describing its behavior and appearance, and the index + * at which to place it in the items maintained by its parent. + * <p> + * The style value is either one of the style constants defined in + * class <code>DWT</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>DWT</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 parentItem a tree control which will be the parent of the new instance (cannot be null) + * @param style the style of control to construct + * @param index the zero-relative index to store the receiver in its parent + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> + * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li> + * </ul> + * @exception DWTException <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 DWT + * @see Widget#checkSubclass + * @see Widget#getStyle + */ +public TreeItem (TreeItem parentItem, int style, int index) { + this (checkNull (parentItem).parent, parentItem, style, checkIndex (index), true); +} + +TreeItem (Tree parent, TreeItem parentItem, int style, int index, bool create) { + super (parent, style); + this.parent = parent; + this.parentItem = parentItem; + if (create) parent.createItem (this, parentItem, index); +} + +static TreeItem checkNull (TreeItem item) { + if (item is null) DWT.error (DWT.ERROR_NULL_ARGUMENT); + return item; +} + +static Tree checkNull (Tree parent) { + if (parent is null) DWT.error (DWT.ERROR_NULL_ARGUMENT); + return parent; +} + +static int checkIndex (int index) { + if (index < 0) DWT.error (DWT.ERROR_INVALID_RANGE); + return index; +} + +int calculateWidth (int index, GC gc) { + if (index is 0 && width !is -1) return width; + int width = 0; + Image image = getImage (index); + String text = getText (index); + gc.setFont (getFont (index)); +// if (image !is null) width += image.getBounds ().width + parent.getGap (); + if (text !is null && text.length () > 0) width += gc.stringExtent (text).x; +// if (parent.hooks (DWT.MeasureItem)) { +// Event event = new Event (); +// event.item = this; +// event.index = index; +// event.gc = gc; +// short [] height = new short [1]; +// OS.GetDataBrowserTableViewRowHeight (parent.handle, height); +// event.width = width; +// event.height = height [0]; +// parent.sendEvent (DWT.MeasureItem, event); +// if (parent.itemHeight < event.height) { +// parent.itemHeight = event.height; +// OS.SetDataBrowserTableViewRowHeight (parent.handle, (short) event.height); +// } +// width = event.width; +// } + if (index is 0) this.width = width; + return width; +} + +protected void checkSubclass () { + if (!isValidSubclass ()) error (DWT.ERROR_INVALID_SUBCLASS); +} + +void clear () { + cached = false; + text = ""; + image = null; + strings = null; + images = null; + checked = grayed = false; + foreground = background = null; + cellForeground = cellBackground = null; + font = null; + cellFont = null; +} + +/** + * Clears the item at the given zero-relative index in the receiver. + * The text, icon and other attributes of the item are set to the default + * value. If the tree was created with the <code>DWT.VIRTUAL</code> style, + * these attributes are requested again as needed. + * + * @param index the index of the item to clear + * @param all <code>true</code> if all child items of the indexed item should be + * cleared recursively, and <code>false</code> otherwise + * + * @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 DWTException <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 DWT#VIRTUAL + * @see DWT#SetData + * + * @since 3.2 + */ +public void clear (int index, bool all) { + checkWidget (); + int count = getItemCount (); + if (index < 0 || index >= count) DWT.error (DWT.ERROR_INVALID_RANGE); + parent.clear (this, index, all); +} + + +/** + * Clears all the items in the receiver. The text, icon and other + * attributes of the items are set to their default values. If the + * tree was created with the <code>DWT.VIRTUAL</code> style, these + * attributes are requested again as needed. + * + * @param all <code>true</code> if all child items should be cleared + * recursively, and <code>false</code> otherwise + * + * @exception DWTException <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 DWT#VIRTUAL + * @see DWT#SetData + * + * @since 3.2 + */ +public void clearAll (bool all) { + checkWidget (); + parent.clearAll (this, all); +} + +NSAttributedString createString(int index) { + NSMutableDictionary dict = NSMutableDictionary.dictionaryWithCapacity(4); + Color foreground = cellForeground !is null ? cellForeground [index] : null; + if (foreground is null) foreground = this.foreground; + if (foreground is null) foreground = parent.foreground; + if (foreground !is null) { + NSColor color = NSColor.colorWithDeviceRed(foreground.handle[0], foreground.handle[1], foreground.handle[2], 1); + dict.setObject(color, OS.NSForegroundColorAttributeName()); + } + Font font = cellFont !is null ? cellFont [index] : null; + if (font is null) font = this.font; +// if (font is null) font = parent.font; + if (font !is null) { + dict.setObject(font.handle, OS.NSFontAttributeName()); + } + Color background = cellBackground !is null ? cellBackground [index] : null; + if (background is null) background = this.background; + if (background !is null) { + NSColor color = NSColor.colorWithDeviceRed(background.handle[0], background.handle[1], background.handle[2], 1); + dict.setObject(color, OS.NSBackgroundColorAttributeName()); + } + String text = getText (index); + int length = text.length(); + char[] chars = new char[length]; + text.getChars(0, length, chars, 0); + NSString str = NSString.stringWithCharacters(chars, length); + NSAttributedString attribStr = ((NSAttributedString)new NSAttributedString().alloc()).initWithString_attributes_(str, dict); + attribStr.autorelease(); + return attribStr; +} + +void destroyWidget () { + parent.destroyItem (this); + releaseHandle (); +} + +/** + * Returns the receiver's background color. + * + * @return the background color + * + * @exception DWTException <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 2.0 + * + */ +public Color getBackground () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + return background !is null ? background : parent.getBackground (); +} + +/** + * Returns the background color at the given column index in the receiver. + * + * @param index the column index + * @return the background color + * + * @exception DWTException <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.1 + */ +public Color getBackground (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + int count = Math.max (1, parent.columnCount); + if (0 > index || index > count -1) return getBackground (); + if (cellBackground is null || cellBackground [index] is null) return getBackground (); + return cellBackground [index]; +} + +/** + * Returns a rectangle describing the receiver's size and location + * relative to its parent. + * + * @return the receiver's bounding rectangle + * + * @exception DWTException <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 Rectangle getBounds () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + NSOutlineView outlineView = (NSOutlineView) parent.view; + int row = outlineView.rowForItem(handle); + NSRect rect = outlineView.rectOfRow (row); + rect = outlineView.convertRect_toView_ (rect, parent.scrollView); + Rectangle result = new Rectangle((int) rect.x, (int) rect.y, (int) rect.width, (int) rect.height); + return result; +} + +/** + * Returns a rectangle describing the receiver's size and location + * relative to its parent at a column in the tree. + * + * @param index the index that specifies the column + * @return the receiver's bounding column rectangle + * + * @exception DWTException <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.1 + */ +public Rectangle getBounds (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + if (index !is 0 && !(0 <= index && index < parent.columnCount)) return new Rectangle (0, 0, 0, 0); + NSOutlineView outlineView = (NSOutlineView) parent.view; + int row = outlineView.rowForItem(handle); + if ((parent.style & DWT.CHECK) !is 0) index ++; + NSRect rect = outlineView.frameOfCellAtColumn(index, row); + rect = outlineView.convertRect_toView_ (rect, parent.scrollView); + return new Rectangle((int)rect.x, (int)rect.y, (int)rect.width, (int)rect.height); +} + +/** + * Returns <code>true</code> if the receiver is checked, + * and false otherwise. When the parent does not have + * the <code>CHECK style, return false. + * <p> + * + * @return the checked state + * + * @exception DWTException <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 bool getChecked () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + if ((parent.style & DWT.CHECK) is 0) return false; + return checked; +} + +/** + * Returns <code>true</code> if the receiver is expanded, + * and false otherwise. + * <p> + * + * @return the expanded state + * + * @exception DWTException <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 bool getExpanded () { + checkWidget (); + return expanded; +} + +/** + * Returns the font that the receiver will use to paint textual information for this item. + * + * @return the receiver's font + * + * @exception DWTException <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.0 + */ +public Font getFont () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + return font !is null ? font : parent.getFont (); +} + +/** + * Returns the font that the receiver will use to paint textual information + * for the specified cell in this item. + * + * @param index the column index + * @return the receiver's font + * + * @exception DWTException <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.1 + */ +public Font getFont (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + int count = Math.max (1, parent.columnCount); + if (0 > index || index > count -1) return getFont (); + if (cellFont is null || cellFont [index] is null) return getFont (); + return cellFont [index]; +} + +/** + * Returns the foreground color that the receiver will use to draw. + * + * @return the receiver's foreground color + * + * @exception DWTException <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 2.0 + * + */ +public Color getForeground () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + return foreground !is null ? foreground : parent.getForeground (); +} + +/** + * + * Returns the foreground color at the given column index in the receiver. + * + * @param index the column index + * @return the foreground color + * + * @exception DWTException <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.1 + */ +public Color getForeground (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + int count = Math.max (1, parent.columnCount); + if (0 > index || index > count -1) return getForeground (); + if (cellForeground is null || cellForeground [index] is null) return getForeground (); + return cellForeground [index]; +} + +/** + * Returns <code>true</code> if the receiver is grayed, + * and false otherwise. When the parent does not have + * the <code>CHECK style, return false. + * <p> + * + * @return the grayed state of the checkbox + * + * @exception DWTException <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 bool getGrayed () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + if ((parent.style & DWT.CHECK) is 0) return false; + return grayed; +} + +public Image getImage () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + return super.getImage (); +} + +/** + * Returns the image stored at the given column index in the receiver, + * or null if the image has not been set or if the column does not exist. + * + * @param index the column index + * @return the image stored at the given column index in the receiver + * + * @exception DWTException <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.1 + */ +public Image getImage (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + if (index is 0) return getImage (); + if (images !is null) { + if (0 <= index && index < images.length) return images [index]; + } + return null; +} + +/** + * Returns a rectangle describing the size and location + * relative to its parent of an image at a column in the + * tree. + * + * @param index the index that specifies the column + * @return the receiver's bounding image rectangle + * + * @exception DWTException <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.1 + */ +public Rectangle getImageBounds (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); +// if (index !is 0 && !(0 <= index && index < parent.columnCount)) return new Rectangle (0, 0, 0, 0); +// Rect rect = new Rect(); +// int columnId = parent.columnCount is 0 ? parent.column_id : parent.columns [index].id; +// if (OS.GetDataBrowserItemPartBounds (parent.handle, id, columnId, OS.kDataBrowserPropertyContentPart, rect) !is OS.noErr) { +// return new Rectangle (0, 0, 0, 0); +// } +// int x = rect.left, y = rect.top; +// int width = 0; +// if (index is 0 && image !is null) { +// Rectangle bounds = image.getBounds (); +// width += bounds.width; +// } +// if (index !is 0 && images !is null && images[index] !is null) { +// Rectangle bounds = images [index].getBounds (); +// width += bounds.width; +// } +// int height = rect.bottom - rect.top + 1; +// return new Rectangle (x, y, width, height); + return 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 DWTException <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.1 + */ +public TreeItem getItem (int index) { + checkWidget (); + if (index < 0) error (DWT.ERROR_INVALID_RANGE); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + if (index >= itemCount) error (DWT.ERROR_INVALID_RANGE); + return parent._getItem (this, index); +} + +/** + * Returns the number of items contained in the receiver + * that are direct item children of the receiver. + * + * @return the number of items + * + * @exception DWTException <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 (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + return itemCount; +} + +/** + * Returns a (possibly empty) array of <code>TreeItem</code>s which + * are the direct item children of 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 receiver's items + * + * @exception DWTException <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 TreeItem [] getItems () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + TreeItem [] result = new TreeItem [itemCount]; + for (int i=0; i<itemCount; i++) { + result [i] = parent._getItem (this, i); + } + return result; +} + +String getNameText () { + if ((parent.style & DWT.VIRTUAL) !is 0) { + if (!cached) return "*virtual*"; //$NON-NLS-1$ + } + return super.getNameText (); +} + +/** + * Returns the receiver's parent, which must be a <code>Tree</code>. + * + * @return the receiver's parent + * + * @exception DWTException <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 Tree getParent () { + checkWidget (); + return parent; +} + +/** + * Returns the receiver's parent item, which must be a + * <code>TreeItem</code> or null when the receiver is a + * root. + * + * @return the receiver's parent item + * + * @exception DWTException <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 TreeItem getParentItem () { + checkWidget (); + return parentItem; +} + +public String getText () { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + return super.getText (); +} + +/** + * Returns the text stored at the given column index in the receiver, + * or empty string if the text has not been set. + * + * @param index the column index + * @return the text stored at the given column index in the receiver + * + * @exception DWTException <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.1 + */ +public String getText (int index) { + checkWidget (); + if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); + if (index is 0) return getText (); + if (strings !is null) { + if (0 <= index && index < strings.length) { + String string = strings [index]; + return string !is null ? string : ""; + } + } + return ""; +} + +/** + * Returns a rectangle describing the size and location + * relative to its parent of the text at a column in the + * tree. + * + * @param index the index that specifies the column + * @return the receiver's bounding text rectangle + * + * @exception DWTException <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.3 + */ +public Rectangle getTextBounds (int index) { + checkWidget (); +// if (!parent.checkData (this, true)) error (DWT.ERROR_WIDGET_DISPOSED); +// if (index !is 0 && !(0 <= index && index < parent.columnCount)) return new Rectangle (0, 0, 0, 0); +// Rect rect = new Rect(); +// int columnId = parent.columnCount is 0 ? parent.column_id : parent.columns [index].id; +// if (OS.GetDataBrowserItemPartBounds (parent.handle, id, columnId, OS.kDataBrowserPropertyEnclosingPart, rect) !is OS.noErr) { +// return new Rectangle (0, 0, 0, 0); +// } +// int[] disclosure = new int [1]; +// OS.GetDataBrowserListViewDisclosureColumn (parent.handle, disclosure, new bool [1]); +// int imageWidth = 0; +// int margin = index is 0 ? 0 : parent.getInsetWidth (columnId, false) / 2; +// Image image = getImage (index); +// if (image !is null) { +// Rectangle bounds = image.getBounds (); +// imageWidth = bounds.width + parent.getGap (); +// } +// int x, y, width, height; +// if (OS.VERSION >= 0x1040 && disclosure [0] !is columnId) { +// if (parent.getLinesVisible ()) { +// rect.left += Tree.GRID_WIDTH; +// rect.top += Tree.GRID_WIDTH; +// } +// x = rect.left + imageWidth + margin; +// y = rect.top; +// width = Math.max (0, rect.right - rect.left - imageWidth - margin * 2);; +// height = rect.bottom - rect.top; +// } else { +// Rect rect2 = new Rect(); +// if (OS.GetDataBrowserItemPartBounds (parent.handle, id, columnId, OS.kDataBrowserPropertyContentPart, rect2) !is OS.noErr) { +// return new Rectangle (0, 0, 0, 0); +// } +// x = rect2.left + imageWidth + margin; +// y = rect2.top; +// width = Math.max (0, rect.right - rect2.left + 1 - imageWidth - margin * 2); +// height = rect2.bottom - rect2.top + 1; +// } +// return new Rectangle (x, y, width, height); + return null; +} + +/** + * 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> + * <li>ERROR_INVALID_ARGUMENT - if the item has been disposed</li> + * </ul> + * @exception DWTException <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.1 + */ +public int indexOf (TreeItem item) { + checkWidget (); + if (item is null) error (DWT.ERROR_NULL_ARGUMENT); + if (item.isDisposed ()) error (DWT.ERROR_INVALID_ARGUMENT); + if (item.parentItem !is this) return -1; + for (int i = 0; i < itemCount; i++) { + if (item is items[i]) return i; + } + return -1; +} + +void releaseChildren (bool destroy) { + for (int i=0; i<items.length; i++) { + TreeItem item = items [i]; + if (item !is null && !item.isDisposed ()) { + item.release (false); + } + } + items = null; + itemCount = 0; + super.releaseChildren (destroy); +} + +void releaseHandle () { + super.releaseHandle (); + if (handle !is null) handle.release(); + handle = null; + parentItem = null; + parent = null; +} + +void releaseWidget () { + super.releaseWidget (); + strings = null; + images = null; + background = foreground = null; + font = null; + cellBackground = cellForeground = null; + cellFont = null; +} + +/** + * Removes all of the items from the receiver. + * <p> + * @exception DWTException <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.1 + */ +public void removeAll () { + checkWidget (); +// for (int i=itemCount - 1; i >= 0; i--) { +// TreeItem item = parent._getItem (childIds [i], false); +// if (item !is null && !item.isDisposed ()) { +// item.dispose (); +// } +// } +} + +/** + * Sets the receiver's background color to the color specified + * by the argument, or to the default system color for the item + * if the argument is null. + * + * @param color the new color (or null) + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <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 2.0 + * + */ +public void setBackground (Color color) { + checkWidget (); + if (color !is null && color.isDisposed ()) { + DWT.error (DWT.ERROR_INVALID_ARGUMENT); + } + Color oldColor = background; + if (oldColor is color) return; + background = color; + if (oldColor !is null && oldColor.equals (color)) return; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the background color at the given column index in the receiver + * to the color specified by the argument, or to the default system color for the item + * if the argument is null. + * + * @param index the column index + * @param color the new color (or null) + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <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.1 + * + */ +public void setBackground (int index, Color color) { + checkWidget (); + if (color !is null && color.isDisposed ()) { + DWT.error (DWT.ERROR_INVALID_ARGUMENT); + } + int count = Math.max (1, parent.columnCount); + if (0 > index || index > count - 1) return; + if (cellBackground is null) { + if (color is null) return; + cellBackground = new Color [count]; + } + Color oldColor = cellBackground [index]; + if (oldColor is color) return; + cellBackground [index] = color; + if (oldColor !is null && oldColor.equals (color)) return; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the checked state of the receiver. + * <p> + * + * @param checked the new checked state + * + * @exception DWTException <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 setChecked (bool checked) { + checkWidget (); + if ((parent.style & DWT.CHECK) is 0) return; + if (this.checked is checked) return; + this.checked = checked; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the expanded state of the receiver. + * <p> + * + * @param expanded the new expanded state + * + * @exception DWTException <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 setExpanded (bool expanded) { + checkWidget (); + if (expanded is getExpanded ()) return; + parent.ignoreExpand = true; + if (expanded) { + ((NSOutlineView)parent.view).expandItem_(handle); + } else { + ((NSOutlineView)parent.view).collapseItem_(handle); + } + parent.ignoreExpand = false; + cached = true; +// if (expanded) { +// parent.setScrollWidth (false, childIds, false); +// } else { +// parent.setScrollWidth (true); +// parent.fixScrollBar (); +// } +} + +/** + * Sets the font that the receiver will use to paint textual information + * for this item to the font specified by the argument, or to the default font + * for that kind of control if the argument is null. + * + * @param font the new font (or null) + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <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.0 + */ +public void setFont (Font font) { + checkWidget (); + if (font !is null && font.isDisposed ()) { + DWT.error (DWT.ERROR_INVALID_ARGUMENT); + } + Font oldFont = this.font; + if (oldFont is font) return; + this.font = font; + if (oldFont !is null && oldFont.equals (font)) return; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the font that the receiver will use to paint textual information + * for the specified cell in this item to the font specified by the + * argument, or to the default font for that kind of control if the + * argument is null. + * + * @param index the column index + * @param font the new font (or null) + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <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.1 + */ +public void setFont (int index, Font font) { + checkWidget (); + if (font !is null && font.isDisposed ()) { + DWT.error (DWT.ERROR_INVALID_ARGUMENT); + } + int count = Math.max (1, parent.columnCount); + if (0 > index || index > count - 1) return; + if (cellFont is null) { + if (font is null) return; + cellFont = new Font [count]; + } + Font oldFont = this.font; + if (oldFont is font) return; + cellFont [index] = font; + if (oldFont !is null && oldFont.equals (font)) return; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the receiver's foreground color to the color specified + * by the argument, or to the default system color for the item + * if the argument is null. + * + * @param color the new color (or null) + * + * @since 2.0 + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <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 2.0 + * + */ +public void setForeground (Color color) { + checkWidget (); + if (color !is null && color.isDisposed ()) { + DWT.error (DWT.ERROR_INVALID_ARGUMENT); + } + Color oldColor = foreground; + if (oldColor is color) return; + foreground = color; + if (oldColor !is null && oldColor.equals (color)) return; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the foreground color at the given column index in the receiver + * to the color specified by the argument, or to the default system color for the item + * if the argument is null. + * + * @param index the column index + * @param color the new color (or null) + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <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.1 + * + */ +public void setForeground (int index, Color color){ + checkWidget (); + if (color !is null && color.isDisposed ()) { + DWT.error (DWT.ERROR_INVALID_ARGUMENT); + } + int count = Math.max (1, parent.columnCount); + if (0 > index || index > count - 1) return; + if (cellForeground is null) { + if (color is null) return; + cellForeground = new Color [count]; + } + Color oldColor = cellForeground [index]; + if (oldColor is color) return; + cellForeground [index] = color; + if (oldColor !is null && oldColor.equals (color)) return; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the grayed state of the checkbox for this item. This state change + * only applies if the Tree was created with the DWT.CHECK style. + * + * @param grayed the new grayed state of the checkbox + * + * @exception DWTException <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 setGrayed (bool grayed) { + checkWidget (); + if ((parent.style & DWT.CHECK) is 0) return; + if (this.grayed is grayed) return; + this.grayed = grayed; + cached = true; + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +/** + * Sets the image for multiple columns in the tree. + * + * @param images the array of new images + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the array of images is null</li> + * <li>ERROR_INVALID_ARGUMENT - if one of the images has been disposed</li> + * </ul> + * @exception DWTException <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.1 + */ +public void setImage (Image [] images) { + checkWidget (); + if (images is null) error (DWT.ERROR_NULL_ARGUMENT); + for (int i=0; i<images.length; i++) { + setImage (i, images [i]); + } +} + +/** + * Sets the receiver's image at a column. + * + * @param index the column index + * @param image the new image + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li> + * </ul> + * @exception DWTException <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.1 + */ +public void setImage (int index, Image image) { + checkWidget (); + if (image !is null && image.isDisposed ()) { + error(DWT.ERROR_INVALID_ARGUMENT); + } +// if (parent.imageBounds is null && image !is null) { +// parent.setItemHeight (image); +// } + if (index is 0) { + if (image !is null && image.type is DWT.ICON) { + if (image.equals (this.image)) return; + } + width = -1; + super.setImage (image); + } + int count = Math.max (1, parent.columnCount); + if (0 <= index && index < count) { + if (images is null) images = new Image [count]; + if (image !is null && image.type is DWT.ICON) { + if (image.equals (images [index])) return; + } + images [index] = image; + } +// cached = true; +// if (index is 0) parent.setScrollWidth (this); + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +public void setImage (Image image) { + checkWidget (); + setImage (0, image); +} + +/** + * Sets the number of child items contained in the receiver. + * + * @param count the number of items + * + * @exception DWTException <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 setItemCount (int count) { + checkWidget (); + count = Math.max (0, count); + parent.setItemCount (this, count); +} + +/** + * Sets the text for multiple columns in the tree. + * + * @param strings the array of new strings + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the text is null</li> + * </ul> + * @exception DWTException <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.1 + */ +public void setText (String [] strings) { + checkWidget (); + if (strings is null) error (DWT.ERROR_NULL_ARGUMENT); + for (int i=0; i<strings.length; i++) { + String string = strings [i]; + if (string !is null) setText (i, string); + } +} + +/** + * Sets the receiver's text at a column + * + * @param index the column index + * @param string the new text + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the text is null</li> + * </ul> + * @exception DWTException <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.1 + */ +public void setText (int index, String string) { + checkWidget (); + if (string is null) error (DWT.ERROR_NULL_ARGUMENT); + if (index is 0) { + if (string.equals (text)) return; + width = -1; + super.setText (string); + } + int count = Math.max (1, parent.columnCount); + if (0 <= index && index < count) { + if (strings is null) strings = new String [count]; + if (string.equals (strings [index])) return; + strings [index] = string; + } + cached = true; + if (index is 0) parent.setScrollWidth (this); + ((NSOutlineView)parent.view).reloadItem_(handle); +} + +public void setText (String string) { + checkWidget (); + setText (0, string); +} + +}