|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.swt.widgets.Widget org.eclipse.swt.widgets.Item org.eclipse.swt.widgets.TreeItem
public class TreeItem
Instances of this class represent a selectable user interface object that represents a hierarchy of tree items in a tree widget.
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. |
|
|
getAdapter(java.lang.Class<T> adapter)
Implementation of the Adaptable interface. |
|
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 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 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 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 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. |
|
java.lang.String |
getText()
Returns the receiver's text, which will be an empty string if it has never been set. |
|
java.lang.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 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 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 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 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[] value)
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,
java.lang.String text)
Sets the receiver's text at a column |
|
void |
setText(java.lang.String text)
Sets the receiver's text. |
|
void |
setText(java.lang.String[] value)
Sets the text for multiple columns in the tree. |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
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 construct
java.lang.IllegalArgumentException
- 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 parent
java.lang.IllegalArgumentException
- 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 construct
java.lang.IllegalArgumentException
- 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 parent
java.lang.IllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
---|
public <T> T getAdapter(java.lang.Class<T> adapter)
Widget
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.
getAdapter
in interface Adaptable
getAdapter
in class Widget
adapter
- the lookup class
null
if
there is no adapter associated with the given class.public Tree getParent()
Tree
.
SWTException
- public TreeItem getParentItem()
TreeItem
or null when the receiver is a root.
SWTException
- public void setExpanded(boolean expanded)
expanded
- the new expanded state
SWTException
- public boolean getExpanded()
true
if the receiver is expanded, and false otherwise.
SWTException
- public Rectangle getBounds()
SWTException
- public Rectangle getBounds(int columnIndex)
columnIndex
- the index that specifies the column
SWTException
- public Color getBackground(int index)
index
- the column index
SWTException
- public Font getFont(int index)
index
- the column index
SWTException
- public Color getForeground(int index)
index
- the column index
SWTException
- public void setBackground(int index, Color color)
index
- the column indexcolor
- the new color (or null)
java.lang.IllegalArgumentException
- SWTException
- public void setFont(int index, Font font)
index
- the column indexfont
- the new font (or null)
java.lang.IllegalArgumentException
- SWTException
- public void setForeground(int index, Color color)
index
- the column indexcolor
- the new color (or null)
java.lang.IllegalArgumentException
- SWTException
- public void setFont(Font font)
font
- the new font (or null)
java.lang.IllegalArgumentException
- SWTException
- public Font getFont()
SWTException
- public void setBackground(Color value)
value
- the new color (or null)
java.lang.IllegalArgumentException
- SWTException
- public Color getBackground()
SWTException
- public Color getForeground()
SWTException
- public void setForeground(Color value)
value
- the new color (or null)
java.lang.IllegalArgumentException
- SWTException
- public void setChecked(boolean checked)
checked
- the new checked state
SWTException
- public boolean getChecked()
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 grayed)
grayed
- the new grayed state of the checkbox
SWTException
- public boolean getGrayed()
true
if the receiver is grayed, and false otherwise.
When the parent does not have the CHECK 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
public java.lang.String getText()
getText
in class Item
SWTException
- public java.lang.String getText(int index)
index
- the column index
SWTException
- public Rectangle getTextBounds(int index)
index
- the index that specifies the column
SWTException
- public void setText(java.lang.String[] value)
value
- the array of new strings
java.lang.IllegalArgumentException
- SWTException
- public void setText(java.lang.String text)
setText
in class Item
text
- the new text
java.lang.IllegalArgumentException
- SWTException
- public void setText(int index, java.lang.String text)
index
- the column indextext
- the new text
java.lang.IllegalArgumentException
- SWTException
- public Image getImage()
getImage
in class Item
SWTException
- public Image getImage(int index)
index
- the column index
SWTException
- public Rectangle getImageBounds(int columnIndex)
columnIndex
- the index that specifies the column
SWTException
- public void clear(int index, boolean recursive)
SWT.VIRTUAL
style, these attributes
are requested again as needed.
index
- the index of the item to clearrecursive
- true
if all child items of the indexed item
should be cleared recursively, and false
otherwise
java.lang.IllegalArgumentException
- SWTException
- SWT.VIRTUAL
,
SWT.SetData
public void setImage(Image image)
Item
setImage
in class Item
image
- the image to display on the receiver (may be null)public void setImage(int index, Image image)
index
- the column indeximage
- the new image
java.lang.IllegalArgumentException
- SWTException
- public void setImage(Image[] value)
value
- the array of new images
java.lang.IllegalArgumentException
- SWTException
- public void clearAll(boolean recursive)
SWT.VIRTUAL
style, these attributes are requested again as
needed.
recursive
- true
if all child items should be cleared
recursively, and false
otherwise
SWTException
- SWT.VIRTUAL
,
SWT.SetData
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 TreeItem getItem(int index)
index
- the index of the item to return
java.lang.IllegalArgumentException
- SWTException
- public int getItemCount()
SWTException
- public int indexOf(TreeItem item)
item
- the search item
java.lang.IllegalArgumentException
- SWTException
- public void removeAll()
SWTException
- public void setItemCount(int count)
count
- the number of items
SWTException
-
|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2013. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0