org.eclipse.swt.widgets
Class TreeItem

java.lang.Object
  

org.eclipse.swt.widgets.Widget
      

org.eclipse.swt.widgets.Item
          
org.eclipse.swt.widgets.TreeItem

All Implemented Interfaces:

Adaptable

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.

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
void	clear (int index, boolean recursive)           Clears the item at the given zero-relative index in the receiver.
void	clearAll (boolean recursive)           Clears all the items in the receiver.
Object	getAdapter ( Class adapter)           Implementation of the Adaptable interface.
Color	getBackground ()           Returns the receiver's background color.
Color	getBackground (int columnIndex)           Returns the background color at the given column index in the receiver.
Rectangle	getBounds ()           Returns a rectangle describing the receiver's size and location relative to its parent.
Rectangle	getBounds (int columnIndex)           Returns a rectangle describing the receiver's size and location relative to its parent at a column in the tree.
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.
Font	getFont (int columnIndex)           Returns the font that the receiver will use to paint textual information for the specified cell in this item.
Color	getForeground ()           Returns the foreground color that the receiver will use to draw.
Color	getForeground (int columnIndex)           Returns the foreground color at the given column index in the receiver.
boolean	getGrayed ()           Returns true if the receiver is grayed, and false otherwise.
Image	getImage (int columnIndex)           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.
Rectangle	getImageBounds (int columnIndex)           Returns a rectangle describing the size and location relative to its parent of an image at a column in the tree.
TreeItem	getItem (int index)           Returns the item at the given, zero-relative index in the receiver.
int	getItemCount ()           Returns the number of items contained in the receiver that are direct item children of the receiver.
TreeItem[]	getItems ()           Returns a (possibly empty) 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.
String	getText ()           Returns the receiver's text, which will be an empty string if it has never been set.
String	getText (int columnIndex)           Returns the text stored at the given column index in the receiver, or empty string if the text has not been set.
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.
void	removeAll ()           Removes all of the items from the receiver.
void	setBackground ( Color value)           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	setBackground (int columnIndex, Color value)           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.
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	setFont (int columnIndex, Font value)           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.
void	setForeground ( Color value)           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	setForeground (int columnIndex, Color value)           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.
void	setGrayed (boolean value)           Sets the grayed state of the checkbox for this item.
void	setImage ( Image[] value)           Sets the image for multiple columns in the tree.
void	setImage (int columnIndex, Image value)           Sets the receiver's image at a column.
void	setItemCount (int count)           Sets the number of child items contained in the receiver.
void	setText (int columnIndex, String value)           Sets the receiver's text at a column
void	setText ( String text)           Sets the receiver's text.
void	setText ( String[] value)           Sets the text for multiple columns in the tree.

 

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

getImage, setImage

 

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

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

 

Methods inherited from class java.lang. Object

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

 

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 tree 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 tree control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

index - the zero-relative index to store the receiver in its parent

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null
• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)

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 tree 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 tree control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

index - the zero-relative index to store the receiver in its parent

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null
• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)

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()

getAdapter

public 
Object getAdapter(
Class adapter)

Description copied from class: Widget

Implementation of the Adaptable interface.

IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class Widget

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

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

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

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

getBounds

public 
Rectangle getBounds(int columnIndex)

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

Parameters:

columnIndex - the index that specifies the column

Returns:

the receiver's bounding column 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

Since:

1.0

getBackground

public 
Color getBackground(int columnIndex)

Returns the background color at the given column index in the receiver.

Parameters:

columnIndex - the column index

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:

1.0

getFont

public 
Font getFont(int columnIndex)

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

Parameters:

columnIndex - the column index

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:

1.0

getForeground

public 
Color getForeground(int columnIndex)

Returns the foreground color at the given column index in the receiver.

Parameters:

columnIndex - the column index

Returns:

the 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:

1.0

setBackground

public void setBackground(int columnIndex,
                          
Color value)

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.

Parameters:

columnIndex - the column index

value - 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:

1.0

setFont

public void setFont(int columnIndex,
                    
Font value)

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.

Parameters:

columnIndex - the column index

value - 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:

1.0

setForeground

public void setForeground(int columnIndex,
                          
Color value)

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.

Parameters:

columnIndex - the column index

value - 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:

1.0

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:

1.0

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:

1.0

setBackground

public void setBackground(
Color value)

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:

value - 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:

1.0

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:

1.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:

1.0

setForeground

public void setForeground(
Color value)

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:

value - 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:

1.0, 1.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

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

public void setGrayed(boolean value)

public boolean getGrayed()

public 
String getText(int columnIndex)

public 
String getText()

public void setText(
String[] value)

public void setText(int columnIndex,
                    
String value)

public void setText(
String text)

public 
Image getImage(int columnIndex)

public 
Rectangle getImageBounds(int columnIndex)

public void clear(int index,
                  boolean recursive)

public void setImage(int columnIndex,
                     
Image value)

public void setImage(
Image[] value)

public void clearAll(boolean recursive)

public 
TreeItem[] getItems()

public 
TreeItem getItem(int index)

public int getItemCount()

public int indexOf(
TreeItem item)

public void removeAll()

public void setItemCount(int count)