Class TreeItem
- Styles:
- (none)
- Events:
- (none)
IMPORTANT: This class is not intended to be subclassed.
- See Also:
- Restriction:
- This class is not intended to be subclassed by clients.
-
Field Summary
Modifier and TypeFieldDescriptionlong
the handle to the OS resource (Warning: This field is platform dependent)Fields inherited from class org.eclipse.swt.widgets.Widget
nativeZoom
-
Constructor Summary
ConstructorDescriptionConstructsTreeItem
and inserts it intoTree
.ConstructsTreeItem
and inserts it intoTree
.ConstructsTreeItem
and inserts it intoTree
.ConstructsTreeItem
and inserts it intoTree
. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Checks that this class can be subclassed.void
clear
(int index, boolean all) Clears the item at the given zero-relative index in the receiver.void
clearAll
(boolean all) Clears all the items in the receiver.Returns the receiver's background color.getBackground
(int index) Returns the background color at the given column index in the receiver.Returns a rectangle describing the size and location of the receiver's text relative to its parent.getBounds
(int index) Returns a rectangle describing the receiver's size and location relative to its parent at a column in the tree.boolean
Returnstrue
if the receiver is checked, and false otherwise.boolean
Returnstrue
if the receiver is expanded, and false otherwise.getFont()
Returns the font that the receiver will use to paint textual information for this item.getFont
(int index) Returns the font that the receiver will use to paint textual information for the specified cell in this item.Returns the foreground color that the receiver will use to draw.getForeground
(int index) Returns the foreground color at the given column index in the receiver.boolean
Returnstrue
if the receiver is grayed, and false otherwise.getImage()
Returns the receiver's image if it has one, or null if it does not.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
(int index) Returns a rectangle describing the size and location relative to its parent of an image at a column in the tree.getItem
(int index) Returns the item at the given, zero-relative index in the receiver.int
Returns the number of items contained in the receiver that are direct item children of the receiver.TreeItem[]
getItems()
Returns a (possibly empty) array ofTreeItem
s which are the direct item children of the receiver.Returns the receiver's parent, which must be aTree
.Returns the receiver's parent item, which must be aTreeItem
or null when the receiver is a root.getText()
Returns the receiver's text, which will be an empty string if it has never been set.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
(int index) Returns a rectangle describing the size and location relative to its parent of the text at a column in the tree.int
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
Removes all of the items from the receiver.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.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
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
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
(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.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 checkbox for this item.void
Sets the receiver's image at a column.void
Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.void
Sets the image for multiple columns in the tree.void
setItemCount
(int count) Sets the number of child items contained in the receiver.void
Sets the receiver's text at a columnvoid
Sets the receiver's text.void
Sets the text for multiple columns in the tree.Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, addTypedListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, getTypedListeners, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, removeTypedListener, reskin, setData, setData, toString
-
Field Details
-
handle
public long handlethe handle to the OS resource (Warning: This field is platform dependent)IMPORTANT: This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.
- Restriction:
- This field is not intended to be referenced by clients.
-
-
Constructor Details
-
TreeItem
ConstructsTreeItem
and inserts it intoTree
. Item is inserted as last direct child of the tree.The fastest way to insert many items is documented in
TreeItem(Tree,int,int)
andsetItemCount(int)
- Parameters:
parent
- a tree control which will be the parent of the new instance (cannot be null)style
- no styles are currently supported, pass SWT.NONE- 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:
-
TreeItem
ConstructsTreeItem
and inserts it intoTree
. Item is inserted asindex
direct child of the tree.The fastest way to insert many items is:
- Use
Tree.setRedraw(boolean)
to disable drawing during bulk insert - Insert every item at index 0 (insert them in reverse to get the same result)
- Collapse the parent item before inserting (gives massive improvement on Windows)
- Parameters:
parent
- a tree control which will be the parent of the new instance (cannot be null)style
- no styles are currently supported, pass SWT.NONEindex
- 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:
- Use
-
TreeItem
ConstructsTreeItem
and inserts it intoTree
. Item is inserted as last direct child of the specifiedTreeItem
.The fastest way to insert many items is documented in
TreeItem(Tree,int,int)
andsetItemCount(int)
- Parameters:
parentItem
- a tree control which will be the parent of the new instance (cannot be null)style
- no styles are currently supported, pass SWT.NONE- 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:
-
TreeItem
ConstructsTreeItem
and inserts it intoTree
. Item is inserted asindex
direct child of the specifiedTreeItem
.The fastest way to insert many items is documented in
TreeItem(Tree,int,int)
andsetItemCount(int)
- Parameters:
parentItem
- a tree control which will be the parent of the new instance (cannot be null)style
- no styles are currently supported, pass SWT.NONEindex
- 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:
-
-
Method Details
-
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
andCanvas
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 classItem
-
clear
public void clear(int index, boolean 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 theSWT.VIRTUAL
style, these attributes are requested again as needed.- Parameters:
index
- the index of the item to clearall
-true
if all child items of the indexed item should be cleared recursively, andfalse
otherwise- Throws:
IllegalArgumentException
-- ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
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.2
- See Also:
-
clearAll
public void clearAll(boolean 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 theSWT.VIRTUAL
style, these attributes are requested again as needed.- Parameters:
all
-true
if all child items should be cleared recursively, andfalse
otherwise- 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.2
- See Also:
-
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
-
getBackground
Returns the background color at the given column index in the receiver.- Parameters:
index
- 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:
- 3.1
-
getBounds
Returns a rectangle describing the size and location of the receiver's text relative to its parent.- Returns:
- the bounding rectangle of the receiver's text
- 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
Returns a rectangle describing the receiver's size and location relative to its parent at a column in the tree.- Parameters:
index
- 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:
- 3.1
-
getChecked
public boolean getChecked()Returnstrue
if the receiver is checked, and false otherwise. When the parent does not have theCHECK
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()Returnstrue
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
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
-
getFont
Returns the font that the receiver will use to paint textual information for the specified cell in this item.- Parameters:
index
- 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:
- 3.1
-
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
-
getForeground
Returns the foreground color at the given column index in the receiver.- Parameters:
index
- 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:
- 3.1
-
getGrayed
public boolean getGrayed()Returnstrue
if the receiver is grayed, and false otherwise. When the parent does not have theCHECK
style, return false.- Returns:
- the grayed state of the checkbox
- 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
-
getItem
Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.- Parameters:
index
- the index of the item to return- Returns:
- the item at the given index
- Throws:
IllegalArgumentException
-- ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
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.1
-
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
Returns a (possibly empty) array ofTreeItem
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.
- 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
-
getImage
Description copied from class:Item
Returns the receiver's image if it has one, or null if it does not. -
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.- Parameters:
index
- the column index- Returns:
- the image stored at the given column index in the receiver
- 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.1
-
getImageBounds
Returns a rectangle describing the size and location relative to its parent of an image at a column in the tree.- Parameters:
index
- the index that specifies the column- Returns:
- the receiver's bounding image 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:
- 3.1
-
getParent
Returns the receiver's parent, which must be aTree
.- 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
Returns the receiver's parent item, which must be aTreeItem
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
-
getText
Description copied from class:Item
Returns the receiver's text, which will be an empty string if it has never been set. -
getText
Returns the text stored at the given column index in the receiver, or empty string if the text has not been set.- Parameters:
index
- the column index- Returns:
- the text stored at the given column index in the receiver
- 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.1
-
getTextBounds
Returns a rectangle describing the size and location relative to its parent of the text at a column in the tree.- Parameters:
index
- the index that specifies the column- Returns:
- the receiver's bounding text 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:
- 3.3
-
indexOf
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.- Parameters:
item
- the search item- Returns:
- the index of the item
- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the item is null
- ERROR_INVALID_ARGUMENT - if the item 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.1
-
removeAll
public void removeAll()Removes all of the items from the receiver.- 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.1
-
setBackground
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
-
setBackground
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:
index
- the column indexcolor
- 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:
- 3.1
-
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
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
-
setFont
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:
index
- the column indexfont
- 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.1
-
setForeground
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
-
setForeground
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:
index
- the column indexcolor
- 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:
- 3.1
-
setGrayed
public void setGrayed(boolean 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.- Parameters:
grayed
- the new grayed state of the checkbox- 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
Sets the image for multiple columns in the tree.- Parameters:
images
- the array of new images- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the array of images is null
- ERROR_INVALID_ARGUMENT - if one of the images 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.1
-
setImage
Sets the receiver's image at a column.- Parameters:
index
- the column indeximage
- the new image- Throws:
IllegalArgumentException
-- ERROR_INVALID_ARGUMENT - if the image 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.1
-
setImage
Description copied from class:Item
Sets the receiver's image to the argument, which may be null indicating that no image should be displayed. -
setItemCount
public void setItemCount(int count) Sets the number of child items contained in the receiver.The fastest way to insert many items is:
- Use
Tree.setRedraw(boolean)
to disable drawing during bulk insert - Collapse the parent item before inserting (gives massive improvement on Windows)
- Parameters:
count
- 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
- Since:
- 3.2
- Use
-
setText
Sets the text for multiple columns in the tree.Note: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.
- Parameters:
strings
- the array of new strings- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the text is null
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.1
-
setText
Sets the receiver's text at a columnNote: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.
- Parameters:
index
- the column indexstring
- the new text- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the text is null
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.1
-
setText
Description copied from class:Item
Sets the receiver's text.Note: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.
-