| /******************************************************************************* |
| * Copyright (c) 2000, 2003 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-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.*; |
| import org.eclipse.swt.graphics.*; |
| |
| /** |
| * Instances of this class represent a selectable user interface object |
| * that represents an item in a table. |
| * <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 TableItem extends Item { |
| Table parent; |
| String [] strings; |
| Image [] images; |
| boolean checked, grayed; |
| Color foreground, background; |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * (which must be a <code>Table</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>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 Widget#checkSubclass |
| * @see Widget#getStyle |
| */ |
| public TableItem (Table parent, int style) { |
| super (parent, style); |
| this.parent = parent; |
| parent.createItem (this, parent.getItemCount ()); |
| } |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * (which must be a <code>Table</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>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 |
| * @param index the index to store the receiver in its parent |
| * |
| * @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 TableItem (Table parent, int style, int index) { |
| super (parent, style); |
| this.parent = parent; |
| parent.createItem (this, index); |
| } |
| |
| protected void checkSubclass () { |
| if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); |
| } |
| |
| int calculateWidth (int index, GC gc) { |
| int width = 0; |
| Image image = getImage (index); |
| String text = getText (index); |
| if (image != null) width = image.getBounds ().width + 2; |
| if (text != null && text.length () > 0) width += gc.stringExtent (text).x; |
| return width; |
| } |
| |
| /** |
| * Returns the receiver's background color. |
| * |
| * @return the background color |
| * |
| * @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 2.0 |
| * |
| */ |
| public Color getBackground () { |
| checkWidget (); |
| return background != null ? background : parent.getBackground (); |
| } |
| |
| /** |
| * Returns a rectangle describing the receiver's size and location |
| * relative to its parent at a column in the table. |
| * |
| * @param index the index that specifies the column |
| * @return the receiver's bounding column rectangle |
| * |
| * @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 Rectangle getBounds (int index) { |
| checkWidget (); |
| if (index != 0 && !(0 <= index && index < parent.columnCount)) return new Rectangle (0, 0, 0, 0);; |
| Rect rect = new Rect(); |
| int itemIndex = parent.indexOf (this); |
| int id = itemIndex + 1; |
| int columnId = index == 0 ? Table.COLUMN_ID : parent.columns [index].id; |
| if (OS.GetDataBrowserItemPartBounds (parent.handle, id, columnId, OS.kDataBrowserPropertyEnclosingPart, rect) != OS.noErr) { |
| return new Rectangle (0, 0, 0, 0); |
| } |
| int x = rect.left, y = rect.top; |
| int width = rect.right - rect.left; |
| int height = rect.bottom - rect.top; |
| OS.GetControlBounds (parent.handle, rect); |
| x -= rect.left; |
| y -= rect.top; |
| return new Rectangle (x, y, width, 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. |
| * |
| * @return the checked state of the checkbox |
| * |
| * @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 boolean getChecked () { |
| checkWidget(); |
| if ((parent.style & SWT.CHECK) == 0) return false; |
| return checked; |
| } |
| |
| public Display getDisplay () { |
| Table parent = this.parent; |
| if (parent == null) error (SWT.ERROR_WIDGET_DISPOSED); |
| return parent.getDisplay (); |
| } |
| |
| /** |
| * Returns the foreground color that the receiver will use to draw. |
| * |
| * @return the receiver's foreground color |
| * |
| * @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 2.0 |
| * |
| */ |
| public Color getForeground () { |
| checkWidget (); |
| return foreground != null ? foreground : parent.getForeground (); |
| } |
| |
| /** |
| * Returns <code>true</code> if the receiver is grayed, |
| * and false otherwise. When the parent does not have |
| * the <code>CHECK</code> style, return false. |
| * |
| * @return the grayed state of the checkbox |
| * |
| * @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 boolean getGrayed () { |
| checkWidget (); |
| if ((parent.style & SWT.CHECK) == 0) return false; |
| return grayed; |
| } |
| |
| /** |
| * 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 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 Image getImage (int index) { |
| checkWidget(); |
| if (index == 0) return super.getImage (); |
| if (images != 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 |
| * table. |
| * |
| * @param index the index that specifies the column |
| * @return the receiver's bounding image rectangle |
| * |
| * @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 Rectangle getImageBounds (int index) { |
| checkWidget(); |
| if (index != 0 && !(0 <= index && index < parent.columnCount)) return new Rectangle (0, 0, 0, 0); |
| Rect rect = new Rect(); |
| int itemIndex = parent.indexOf (this); |
| int id = itemIndex + 1; |
| int columnId = index == 0 ? Table.COLUMN_ID : parent.columns [index].id; |
| if (OS.GetDataBrowserItemPartBounds (parent.handle, id, columnId, OS.kDataBrowserPropertyContentPart, rect) != OS.noErr) { |
| return new Rectangle (0, 0, 0, 0); |
| } |
| int x = rect.left, y = rect.top; |
| int width = 0; |
| if (image != null) { |
| Rectangle bounds = image.getBounds (); |
| width += bounds.width + 2; |
| } |
| int height = rect.bottom - rect.top; |
| OS.GetControlBounds (parent.handle, rect); |
| x -= rect.left; |
| y -= rect.top; |
| System.out.println(new Rectangle (x, y, width, height)); |
| return new Rectangle (x, y, width, height); |
| } |
| |
| /** |
| * Gets the image indent. |
| * |
| * @return the indent |
| * |
| * @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 getImageIndent () { |
| checkWidget(); |
| return 0; |
| } |
| |
| /** |
| * Returns the receiver's parent, which must be a <code>Table</code>. |
| * |
| * @return the receiver's parent |
| * |
| * @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 Table getParent () { |
| checkWidget(); |
| return parent; |
| } |
| |
| /** |
| * 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 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> |
| * @exception SWTError <ul> |
| * <li>ERROR_CANNOT_GET_TEXT - if the column at index does not exist</li> |
| * </ul> |
| */ |
| public String getText (int index) { |
| checkWidget(); |
| if (index == 0) return super.getText (); |
| if (strings != null) { |
| if (0 <= index && index < strings.length) { |
| String string = strings [index]; |
| return string != null ? string : ""; |
| } |
| } |
| return ""; |
| } |
| |
| void redraw () { |
| int itemIndex = parent.indexOf (this); |
| int [] id = new int [] {itemIndex + 1}; |
| OS.UpdateDataBrowserItems (parent.handle, 0, id.length, id, OS.kDataBrowserItemNoProperty, OS.kDataBrowserNoItem); |
| } |
| |
| void releaseChild () { |
| super.releaseChild (); |
| parent.destroyItem (this); |
| } |
| |
| void releaseWidget () { |
| super.releaseWidget (); |
| background = foreground = null; |
| parent = null; |
| } |
| |
| /** |
| * 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 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 2.0 |
| * |
| */ |
| public void setBackground (Color color) { |
| checkWidget (); |
| if (color != null && color.isDisposed ()) { |
| SWT.error (SWT.ERROR_INVALID_ARGUMENT); |
| } |
| background = color; |
| redraw (); |
| } |
| |
| /** |
| * Sets the checked state of the checkbox for this item. This state change |
| * only applies if the Table was created with the SWT.CHECK style. |
| * |
| * @param checked the new checked state of the checkbox |
| * |
| * @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 setChecked (boolean checked) { |
| checkWidget (); |
| if ((parent.style & SWT.CHECK) == 0) return; |
| this.checked = checked; |
| redraw (); |
| } |
| |
| /** |
| * 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) |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</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 2.0 |
| * |
| */ |
| public void setForeground (Color color) { |
| checkWidget (); |
| if (color != null && color.isDisposed ()) { |
| SWT.error (SWT.ERROR_INVALID_ARGUMENT); |
| } |
| foreground = color; |
| redraw (); |
| } |
| |
| /** |
| * Sets the grayed state of the checkbox for this item. This state change |
| * only applies if the Table was created with the SWT.CHECK style. |
| * |
| * @param grayed the new grayed state of the checkbox; |
| * |
| * @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 setGrayed (boolean grayed) { |
| checkWidget (); |
| if ((parent.style & SWT.CHECK) == 0) return; |
| this.grayed = grayed; |
| redraw (); |
| } |
| |
| /** |
| * Sets the image for multiple columns in the Table. |
| * |
| * @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 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 setImage (Image [] images) { |
| checkWidget(); |
| if (images == null) error (SWT.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 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 setImage (int index, Image image) { |
| checkWidget(); |
| if (image != null && image.isDisposed ()) { |
| error(SWT.ERROR_INVALID_ARGUMENT); |
| } |
| int itemIndex = parent.indexOf (this); |
| if (itemIndex == -1) return; |
| if (index == 0) { |
| super.setImage (image); |
| parent.setScrollWidth (this); |
| } |
| int columnCount = parent.columnCount; |
| if (0 <= index && index < columnCount) { |
| if (images == null) images = new Image [columnCount]; |
| if (images.length != columnCount) { |
| Image [] newImages = new Image [columnCount]; |
| System.arraycopy (images, 0, newImages, 0, images.length); |
| images = newImages; |
| } |
| if (0 <= index && index < images.length) images [index] = image; |
| } |
| int [] id = new int [] {itemIndex + 1}; |
| OS.UpdateDataBrowserItems (parent.handle, 0, id.length, id, OS.kDataBrowserItemNoProperty, OS.kDataBrowserNoItem); |
| } |
| |
| public void setImage (Image image) { |
| checkWidget (); |
| setImage (0, image); |
| } |
| |
| /** |
| * Sets the image indent. |
| * |
| * @param indent the new indent |
| * |
| * </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 setImageIndent (int indent) { |
| checkWidget(); |
| if (indent < 0) return; |
| } |
| |
| /** |
| * Sets the text for multiple columns in the table. |
| * |
| * @param strings the array of new strings |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the text 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 setText (String [] strings) { |
| checkWidget(); |
| if (strings == null) error (SWT.ERROR_NULL_ARGUMENT); |
| for (int i=0; i<strings.length; i++) { |
| String string = strings [i]; |
| if (string != 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 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 setText (int index, String string) { |
| checkWidget(); |
| if (string == null) error (SWT.ERROR_NULL_ARGUMENT); |
| int itemIndex = parent.indexOf (this); |
| if (itemIndex == -1) return; |
| if (index == 0) { |
| super.setText (string); |
| parent.setScrollWidth (this); |
| } |
| int columnCount = parent.columnCount; |
| if (0 <= index && index < columnCount) { |
| if (strings == null) strings = new String [columnCount]; |
| if (strings.length != columnCount) { |
| String [] newStrings = new String [columnCount]; |
| System.arraycopy (strings, 0, newStrings, 0, strings.length); |
| strings = newStrings; |
| } |
| if (0 <= index && index < strings.length) strings [index] = string; |
| } |
| int [] id = new int [] {itemIndex + 1}; |
| OS.UpdateDataBrowserItems (parent.handle, 0, id.length, id, OS.kDataBrowserItemNoProperty, OS.kDataBrowserNoItem); |
| } |
| |
| public void setText (String string) { |
| checkWidget(); |
| setText (0, string); |
| } |
| |
| } |