public class TreeItem extends Item
IMPORTANT: This class is not intended to be subclassed.
Modifier and Type | Field and Description |
---|---|
long |
handle
the handle to the OS resource
(Warning: This field is platform dependent)
IMPORTANT: This field is not part of the SWT
public API.
|
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
protected void |
checkSubclass()
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.
|
Color |
getBackground()
Returns the receiver's background color.
|
Color |
getBackground(int index)
Returns the background color at the given column index in the receiver.
|
Rectangle |
getBounds()
Returns a rectangle describing the size and location of the receiver's
text relative to its parent.
|
Rectangle |
getBounds(int index)
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 index)
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 index)
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()
Returns the receiver's image if it has one, or null
if it does not.
|
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.
|
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.
|
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
TreeItem s 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 index)
Returns the text stored at the given column index in the receiver,
or empty string if the text has not been set.
|
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.
|
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 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 |
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 |
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 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.
|
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 |
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 |
setGrayed(boolean grayed)
Sets the grayed state of the checkbox for this item.
|
void |
setImage(Image image)
Sets the receiver's image to the argument, which may be
null indicating that no image should be displayed.
|
void |
setImage(Image[] images)
Sets the image for multiple columns in the tree.
|
void |
setImage(int index,
Image image)
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 index,
String string)
Sets the receiver's text at a column
Note: If control characters like '\n', '\t' etc. are used
in the string, then the behavior is platform dependent.
|
void |
setText(String string)
Sets the receiver's text.
|
void |
setText(String[] strings)
Sets the text for multiple columns in the tree.
|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString
public long handle
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.
public TreeItem(Tree parent, int style)
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.
parent
- a tree control which will be the parent of the new instance (cannot be null)style
- the style of control to constructIllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
public TreeItem(Tree parent, int style, int index)
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.
parent
- a tree control which will be the parent of the new instance (cannot be null)style
- the style of control to constructindex
- the zero-relative index to store the receiver in its parentIllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
public TreeItem(TreeItem parentItem, int style)
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.
parentItem
- a tree control which will be the parent of the new instance (cannot be null)style
- the style of control to constructIllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
public TreeItem(TreeItem parentItem, int style, int index)
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.
parentItem
- a tree control which will be the parent of the new instance (cannot be null)style
- the style of control to constructindex
- the zero-relative index to store the receiver in its parentIllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
protected void checkSubclass()
Widget
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.
checkSubclass
in class Item
public void clear(int index, boolean all)
SWT.VIRTUAL
style,
these attributes are requested again as needed.index
- the index of the item to clearall
- true
if all child items of the indexed item should be
cleared recursively, and false
otherwiseIllegalArgumentException
- SWTException
- SWT.VIRTUAL
,
SWT.SetData
public void clearAll(boolean all)
SWT.VIRTUAL
style, these
attributes are requested again as needed.all
- true
if all child items should be cleared
recursively, and false
otherwiseSWTException
- SWT.VIRTUAL
,
SWT.SetData
public Color getBackground()
SWTException
- public Color getBackground(int index)
index
- the column indexSWTException
- public Rectangle getBounds()
SWTException
- public Rectangle getBounds(int index)
index
- the index that specifies the columnSWTException
- public boolean getChecked()
true
if the receiver is checked,
and false otherwise. When the parent does not have
the CHECK style, return false.
SWTException
- public boolean getExpanded()
true
if the receiver is expanded,
and false otherwise.
SWTException
- public Font getFont()
SWTException
- public Font getFont(int index)
index
- the column indexSWTException
- public Color getForeground()
SWTException
- public Color getForeground(int index)
index
- the column indexSWTException
- public boolean getGrayed()
true
if the receiver is grayed,
and false otherwise. When the parent does not have
the CHECK style, return false.
SWTException
- public TreeItem getItem(int index)
index
- the index of the item to returnIllegalArgumentException
- SWTException
- public int getItemCount()
SWTException
- public TreeItem[] getItems()
TreeItem
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.
SWTException
- public Image getImage()
Item
public Image getImage(int index)
index
- the column indexSWTException
- public Rectangle getImageBounds(int index)
index
- the index that specifies the columnSWTException
- public Tree getParent()
Tree
.SWTException
- public TreeItem getParentItem()
TreeItem
or null when the receiver is a
root.SWTException
- public String getText()
Item
public String getText(int index)
index
- the column indexSWTException
- public Rectangle getTextBounds(int index)
index
- the index that specifies the columnSWTException
- public int indexOf(TreeItem item)
item
- the search itemIllegalArgumentException
- SWTException
- public void removeAll()
SWTException
- public void setBackground(Color color)
color
- the new color (or null)IllegalArgumentException
- SWTException
- public void setBackground(int index, Color color)
index
- the column indexcolor
- the new color (or null)IllegalArgumentException
- SWTException
- public void setChecked(boolean checked)
checked
- the new checked stateSWTException
- public void setExpanded(boolean expanded)
expanded
- the new expanded stateSWTException
- public void setFont(Font font)
font
- the new font (or null)IllegalArgumentException
- SWTException
- public void setFont(int index, Font font)
index
- the column indexfont
- the new font (or null)IllegalArgumentException
- SWTException
- public void setForeground(Color color)
color
- the new color (or null)IllegalArgumentException
- SWTException
- public void setForeground(int index, Color color)
index
- the column indexcolor
- the new color (or null)IllegalArgumentException
- SWTException
- public void setGrayed(boolean grayed)
grayed
- the new grayed state of the checkboxSWTException
- public void setImage(Image[] images)
images
- the array of new imagesIllegalArgumentException
- SWTException
- public void setImage(int index, Image image)
index
- the column indeximage
- the new imageIllegalArgumentException
- SWTException
- public void setImage(Image image)
Item
public void setItemCount(int count)
count
- the number of itemsSWTException
- public void setText(String[] strings)
Note: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.
strings
- the array of new stringsIllegalArgumentException
- SWTException
- public void setText(int index, String string)
Note: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.
index
- the column indexstring
- the new textIllegalArgumentException
- SWTException
-
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.