Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.swt.widgets
Class TreeItem

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Item
          org.eclipse.swt.widgets.TreeItem

public class TreeItem

extends Item

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

Styles:

(none)

Events:

(none)

IMPORTANT: This class is not intended to be subclassed.

Field Summary

int	handle the handle to the OS resource (Warning: This field is platform dependent)

Constructor Summary

TreeItem(Tree parent, int style)
Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem) and a style value describing its behavior and appearance.

TreeItem(Tree parent, int style, int index)
Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

TreeItem(TreeItem parentItem, int style)
Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem) and a style value describing its behavior and appearance.

TreeItem(TreeItem parentItem, int style, int index)
Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

Method Summary

protected void	checkSubclass() Checks that this class can be subclassed.
Color	getBackground() Returns the receiver's background color.
Rectangle	getBounds() Returns a rectangle describing the receiver's size and location relative to its parent.
boolean	getChecked() Returns true if the receiver is checked, and false otherwise.
boolean	getExpanded() Returns true if the receiver is expanded, and false otherwise.
Font	getFont() Returns the font that the receiver will use to paint textual information for this item.
Color	getForeground() Returns the foreground color that the receiver will use to draw.
boolean	getGrayed() Returns true if the receiver is grayed, and false otherwise.
int	getItemCount() Returns the number of items contained in the receiver that are direct item children of the receiver.
TreeItem[]	getItems() Returns an array of TreeItems which are the direct item children of the receiver.
Tree	getParent() Returns the receiver's parent, which must be a Tree.
TreeItem	getParentItem() Returns the receiver's parent item, which must be a TreeItem or null when the receiver is a root.
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.
void	setChecked(boolean checked) Sets the checked state of the receiver.
void	setExpanded(boolean expanded) Sets the expanded state of the receiver.
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.
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.
void	setGrayed(boolean grayed) Sets the grayed state of the receiver.
void	setImage(Image image) Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
void	setText(String string) Sets the receiver's text.

Methods inherited from class org.eclipse.swt.widgets.Item

getImage, getText

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

handle

public int handle

the handle to the OS resource (Warning: This field is platform dependent)

Constructor Detail

TreeItem

public TreeItem(Tree parent,
                int style)

Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem) 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 SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

TreeItem

public TreeItem(Tree parent,
                int style,
                int index)

Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem), 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 SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

index - the index to store the receiver in its parent

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

TreeItem

public TreeItem(TreeItem parentItem,
                int style)

Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem) 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 SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parentItem - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

TreeItem

public TreeItem(TreeItem parentItem,
                int style,
                int index)

Constructs a new instance of this class given its parent (which must be a Tree or a TreeItem), 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 SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parentItem - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

index - the index to store the receiver in its parent

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

Method Detail

checkSubclass

protected void checkSubclass()

Description copied from class: Widget

Checks that this class can be subclassed.

The SWT class library is intended to be subclassed only at specific, controlled points (most notably, Composite and Canvas when implementing new widgets). This method enforces this rule unless it is overridden.

IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.

The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.

Overrides:

checkSubclass in class Item

getBackground

public Color getBackground()

Returns the receiver's background color.

Returns:

the background color

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

2.0

getBounds

public Rectangle getBounds()

Returns a rectangle describing the receiver's size and location relative to its parent.

Returns:

the receiver's bounding rectangle

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getChecked

public boolean getChecked()

Returns true if the receiver is checked, and false otherwise. When the parent does not have the CHECK style, return false.

Returns:

the checked state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getExpanded

public boolean getExpanded()

Returns true if the receiver is expanded, and false otherwise.

Returns:

the expanded state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getFont

public Font getFont()

Returns the font that the receiver will use to paint textual information for this item.

Returns:

the receiver's font

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.0

getForeground

public Color getForeground()

Returns the foreground color that the receiver will use to draw.

Returns:

the receiver's foreground color

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

2.0

getGrayed

public boolean getGrayed()

Returns true if the receiver is grayed, and false otherwise. When the parent does not have the CHECK style, return false.

Returns:

the grayed state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver that are direct item children of the receiver.

Returns:

the number of items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItems

public TreeItem[] getItems()

Returns an array of TreeItems 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.

Returns:

the receiver's items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getParent

public Tree getParent()

Returns the receiver's parent, which must be a Tree.

Returns:

the receiver's parent

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getParentItem

public TreeItem getParentItem()

Returns the receiver's parent item, which must be a TreeItem or null when the receiver is a root.

Returns:

the receiver's parent item

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setBackground

public 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.

Parameters:

color - the new color (or null)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

2.0

setChecked

public void setChecked(boolean checked)

Sets the checked state of the receiver.

Parameters:

checked - the new checked state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setExpanded

public void setExpanded(boolean expanded)

Sets the expanded state of the receiver.

Parameters:

expanded - the new expanded state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setFont

public 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.

Parameters:

font - the new font (or null)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.0

setForeground

public 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.

Parameters:

color - the new color (or null)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

2.0, 2.0

setGrayed

public void setGrayed(boolean grayed)

Sets the grayed state of the receiver.

Parameters:

grayed - the new grayed state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setImage

public void setImage(Image image)

Description copied from class: Item

Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.

Overrides:

setImage in class Item

Parameters:

image - the image to display on the receiver (may be null)

setText

public void setText(String string)

Description copied from class: Item

Sets the receiver's text.

Overrides:

setText in class Item

Parameters:

string - the new text