TreeItem

Instances of this class represent a selectable user interface object that represents a hierarchy of tree items in a tree widget.

<dl> <dt>Styles:</dt> <dd>(none)</dd> <dt>Events:</dt> <dd>(none)</dd> </dl> IMPORTANT: This class is not intended to be subclassed.

@see <a href="http://www.eclipse.org/swt/snippets/#tree">Tree, TreeItem, TreeColumn snippets</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class TreeItem : Item {

Tree parent;

Font font;

Font[] cellFont;

bool cached;

bool grayed;

int EXPANDER_EXTRA_PADDING;

this(Tree parent, int style);

this(Tree parent, int style, int index);

this(TreeItem parentItem, int style);

this(TreeItem parentItem, int style, int index);

void clear(int index, bool all);

void clearAll(bool all);

Color getBackground();

Color getBackground(int index);

Rectangle getBounds(int index);

Rectangle getBounds();

bool getChecked();

bool getExpanded();

Font getFont();

Font getFont(int index);

Color getForeground();

Color getForeground(int index);

bool getGrayed();

Image getImage(int index);

Rectangle getImageBounds(int index);

int getItemCount();

TreeItem getItem(int index);

TreeItem[] getItems();

Tree getParent();

TreeItem getParentItem();

String getText(int index);

Rectangle getTextBounds(int index);

int indexOf(TreeItem item);

void removeAll();

void setBackground(Color color);

void setBackground(int index, Color color);

void setChecked(bool checked);

void setExpanded(bool expanded);

void setFont(Font font);

void setFont(int index, Font font);

void setForeground(Color color);

void setForeground(int index, Color color);

void setGrayed(bool grayed);

void setImage(int index, Image image);

void setImage(Image[] images);

void setItemCount(int count);

void setText(int index, String string);

void setText(String[] strings);

}

Constructors

this this(Tree parent, int style): 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. 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 bitwise OR'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.
this this(Tree parent, int style, int index): 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. 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 bitwise OR'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.
this this(TreeItem parentItem, int style): 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. 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 bitwise OR'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.
this this(TreeItem parentItem, int style, int index): 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. 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 bitwise OR'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.

Members

Functions

clear void clear(int index, bool all): 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>SWT.VIRTUAL</code> style, these attributes are requested again as needed.
clearAll void clearAll(bool 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>SWT.VIRTUAL</code> style, these attributes are requested again as needed.
getBackground Color getBackground(): Returns the receiver's background color.
getBackground Color getBackground(int index): Returns the background color at the given column index in the receiver.
getBounds Rectangle getBounds(int index): Returns a rectangle describing the receiver's size and location relative to its parent at a column in the tree.
getBounds Rectangle getBounds(): Returns a rectangle describing the receiver's size and location relative to its parent.
getChecked bool getChecked(): Returns <code>true</code> if the receiver is checked, and false otherwise. When the parent does not have the <code>CHECK style, return false.
getExpanded bool getExpanded(): Returns <code>true</code> if the receiver is expanded, and false otherwise.
getFont Font getFont(): Returns the font that the receiver will use to paint textual information for this item.
getFont Font getFont(int index): Returns the font that the receiver will use to paint textual information for the specified cell in this item.
getForeground Color getForeground(): Returns the foreground color that the receiver will use to draw.
getForeground Color getForeground(int index): Returns the foreground color at the given column index in the receiver.
getGrayed bool getGrayed(): Returns <code>true</code> if the receiver is grayed, and false otherwise. When the parent does not have the <code>CHECK style, return false.
getImage Image getImage(int index): 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.
getImageBounds Rectangle getImageBounds(int index): Returns a rectangle describing the size and location relative to its parent of an image at a column in the tree.
getItem TreeItem getItem(int index): Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.
getItemCount int getItemCount(): Returns the number of items contained in the receiver that are direct item children of the receiver.
getItems TreeItem[] getItems(): Returns a (possibly empty) array of <code>TreeItem</code>s which are the direct item children of 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.
getParent Tree getParent(): Returns the receiver's parent, which must be a <code>Tree</code>.
getParentItem TreeItem getParentItem(): Returns the receiver's parent item, which must be a <code>TreeItem</code> or null when the receiver is a root.
getText String getText(int index): Returns the text stored at the given column index in the receiver, or empty string if the text has not been set.
getTextBounds Rectangle getTextBounds(int index): Returns a rectangle describing the size and location relative to its parent of the text at a column in the tree.
indexOf int indexOf(TreeItem item): 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.
removeAll void removeAll(): Removes all of the items from 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>
setBackground void setBackground(Color color): 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.
setBackground void setBackground(int index, Color color): 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.
setChecked void setChecked(bool checked): Sets the checked state of the receiver.
setExpanded void setExpanded(bool expanded): Sets the expanded state of the receiver.
setFont void setFont(Font font): 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.
setFont void setFont(int index, Font font): 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.
setForeground void setForeground(Color color): 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.
setForeground void setForeground(int index, Color color): 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.
setGrayed void setGrayed(bool grayed): Sets the grayed state of the checkbox for this item. This state change only applies if the Tree was created with the SWT.CHECK style.
setImage void setImage(int index, Image image): Sets the receiver's image at a column.
setImage void setImage(Image[] images): Sets the image for multiple columns in the tree.
setItemCount void setItemCount(int count): Sets the number of child items contained in the receiver.
setText void setText(int index, String string): Sets the receiver's text at a column
setText void setText(String[] strings): Sets the text for multiple columns in the tree.

Inherited Members

From Item

getImage Image getImage(): Returns the receiver's image if it has one, or null if it does not.
getText String getText(): Returns the receiver's text, which will be an empty string if it has never been set.
setImage void setImage(Image image): Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
setText void setText(String string): Sets the receiver's text.