Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> swt >> [ custom overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.swt.custom.TableTreeItem JAVADOC | Sourc code of org.eclipse.swt.custom.TableTreeItem SOURCE | Download org.eclipse.swt.custom.TableTreeItem DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.swt.custom
Class TableTreeItem  view TableTreeItem download TableTreeItem.java

java.lang.Object
  extended byorg.eclipse.swt.widgets.Widget
      extended byorg.eclipse.swt.widgets.Item
          extended byorg.eclipse.swt.custom.TableTreeItem
public class TableTreeItem
extends org.eclipse.swt.widgets.Item

A TableTreeItem is a selectable user interface object that represents an item in a heirarchy of items in a TableTree.

Field Summary
(package private)  org.eclipse.swt.graphics.Color background
           
(package private)  boolean checked
           
(package private)  boolean expanded
           
(package private)  org.eclipse.swt.graphics.Font font
           
(package private)  org.eclipse.swt.graphics.Color foreground
           
(package private)  boolean grayed
           
(package private)  org.eclipse.swt.graphics.Image[] images
           
(package private)  TableTreeItem[] items
           
(package private)  TableTree parent
           
(package private)  TableTreeItem parentItem
           
(package private)  org.eclipse.swt.widgets.TableItem tableItem
           
(package private)  java.lang.String[] texts
           
 
Fields inherited from class org.eclipse.swt.widgets.Item
 
Fields inherited from class org.eclipse.swt.widgets.Widget
handle
 
Constructor Summary
  TableTreeItem(TableTree parent, int style)
          Constructs a new instance of this class given its parent (which must be a TableTree) and a style value describing its behavior and appearance.
  TableTreeItem(TableTree parent, int style, int index)
          Constructs a new instance of this class given its parent (which must be a TableTree, a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.
  TableTreeItem(TableTreeItem parent, int style)
          Constructs a new instance of this class given its parent (which must be a TableTreeItem) and a style value describing its behavior and appearance.
  TableTreeItem(TableTreeItem parent, int style, int index)
          Constructs a new instance of this class given its parent (which must be a TableTreeItem), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.
(package private) TableTreeItem(TableTree parent, TableTreeItem parentItem, int style, int index)
           
 
Method Summary
(package private)  void addCheck()
           
(package private)  void addItem(TableTreeItem item, int index)
           
 void dispose()
          Disposes of the operating system resources associated with the receiver and all its descendents.
(package private)  void expandAll(boolean notify)
           
(package private)  int expandedIndexOf(TableTreeItem item)
           
 org.eclipse.swt.graphics.Color getBackground()
          Returns the receiver's background color.
 org.eclipse.swt.graphics.Rectangle getBounds(int index)
          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.
 org.eclipse.swt.graphics.Font getFont()
          Returns the font that the receiver will use to paint textual information for this item.
 org.eclipse.swt.graphics.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.
 org.eclipse.swt.graphics.Image getImage()
          Gets the first image.
 org.eclipse.swt.graphics.Image getImage(int index)
          Gets the image at the specified index.
(package private)  int getIndent()
           
(package private)  TableTreeItem getItem(org.eclipse.swt.widgets.TableItem tableItem)
           
 int getItemCount()
          Returns the number of items contained in the receiver that are direct item children of the receiver.
 TableTreeItem[] getItems()
          Returns an array of TableTreeItems which are the direct item children of the receiver.
 TableTree getParent()
          Returns the receiver's parent, which must be a TableTree.
 TableTreeItem getParentItem()
          Returns the receiver's parent item, which must be a TableTreeItem 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)
          Gets the item text at the specified index.
(package private)  boolean getVisible()
           
 int indexOf(TableTreeItem item)
          Gets the index of the specified item.
(package private)  void removeItem(TableTreeItem item)
           
 void setBackground(org.eclipse.swt.graphics.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 checkbox for this item.
 void setExpanded(boolean expanded)
          Sets the expanded state.
 void setFont(org.eclipse.swt.graphics.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(org.eclipse.swt.graphics.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 setImage(org.eclipse.swt.graphics.Image image)
          Sets the first image.
 void setImage(int index, org.eclipse.swt.graphics.Image image)
          Sets the image at an index.
 void setText(int index, java.lang.String text)
          Sets the widget text.
 void setText(java.lang.String string)
          Sets the receiver's text.
(package private)  void setVisible(boolean show)
           
(package private)  int visibleChildrenCount()
           
 
Methods inherited from class org.eclipse.swt.widgets.Item
checkSubclass
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, 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

tableItem

org.eclipse.swt.widgets.TableItem tableItem

parent

TableTree parent

parentItem

TableTreeItem parentItem

items

TableTreeItem[] items

texts

java.lang.String[] texts

images

org.eclipse.swt.graphics.Image[] images

background

org.eclipse.swt.graphics.Color background

foreground

org.eclipse.swt.graphics.Color foreground

font

org.eclipse.swt.graphics.Font font

expanded

boolean expanded

checked

boolean checked

grayed

boolean grayed
Constructor Detail

TableTreeItem

public TableTreeItem(TableTree parent,
                     int style)
Constructs a new instance of this class given its parent (which must be a TableTree) 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.

TableTreeItem

public TableTreeItem(TableTree parent,
                     int style,
                     int index)
Constructs a new instance of this class given its parent (which must be a TableTree, 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.

TableTreeItem

public TableTreeItem(TableTreeItem parent,
                     int style)
Constructs a new instance of this class given its parent (which must be a TableTreeItem) 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.

TableTreeItem

public TableTreeItem(TableTreeItem parent,
                     int style,
                     int index)
Constructs a new instance of this class given its parent (which must be a TableTreeItem), 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.

TableTreeItem

TableTreeItem(TableTree parent,
              TableTreeItem parentItem,
              int style,
              int index)
Method Detail

addCheck

void addCheck()

addItem

void addItem(TableTreeItem item,
             int index)

getBackground

public org.eclipse.swt.graphics.Color getBackground()
Returns the receiver's background color.

Since:
2.0

getBounds

public org.eclipse.swt.graphics.Rectangle getBounds(int index)
Returns a rectangle describing the receiver's size and location relative to its parent.

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.

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.

Since:
2.1

getExpanded

public boolean getExpanded()
Returns true if the receiver is expanded, and false otherwise.

getFont

public org.eclipse.swt.graphics.Font getFont()
Returns the font that the receiver will use to paint textual information for this item.

Since:
3.0

getForeground

public org.eclipse.swt.graphics.Color getForeground()
Returns the foreground color that the receiver will use to draw.

Since:
2.0

getImage

public org.eclipse.swt.graphics.Image getImage()
Gets the first image.

The image in column 0 is reserved for the [+] and [-] images of the tree, therefore getImage(0) will return null.

getImage

public org.eclipse.swt.graphics.Image getImage(int index)
Gets the image at the specified index.

Indexing is zero based. The image can be null. The image in column 0 is reserved for the [+] and [-] images of the tree, therefore getImage(0) will return null. Return null if the index is out of range.

getIndent

int getIndent()

getItemCount

public int getItemCount()
Returns the number of items contained in the receiver that are direct item children of the receiver.

getItems

public TableTreeItem[] getItems()
Returns an array of TableTreeItems 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.

getItem

TableTreeItem getItem(org.eclipse.swt.widgets.TableItem tableItem)

getParent

public TableTree getParent()
Returns the receiver's parent, which must be a TableTree.

getParentItem

public TableTreeItem getParentItem()
Returns the receiver's parent item, which must be a TableTreeItem or null when the receiver is a root.

getText

public java.lang.String getText()
Description copied from class: org.eclipse.swt.widgets.Item
Returns the receiver's text, which will be an empty string if it has never been set.

getText

public java.lang.String getText(int index)
Gets the item text at the specified index.

Indexing is zero based. This operation will fail when the index is out of range or an item could not be queried from the OS.

getVisible

boolean getVisible()

indexOf

public int indexOf(TableTreeItem item)
Gets the index of the specified item.

The widget is searched starting at 0 until an item is found that is equal to the search item. If no item is found, -1 is returned. Indexing is zero based. This index is relative to the parent only.

expandAll

void expandAll(boolean notify)

expandedIndexOf

int expandedIndexOf(TableTreeItem item)

visibleChildrenCount

int visibleChildrenCount()

dispose

public void dispose()
Description copied from class: org.eclipse.swt.widgets.Widget
Disposes of the operating system resources associated with the receiver and all its descendents. After this method has been invoked, the receiver and all descendents will answer true when sent the message isDisposed(). Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection.

NOTE: This method is not called recursively on the descendents of the receiver. This means that, widget implementers can not detect when a widget is being disposed of by re-implementing this method, but should instead listen for the Dispose event.

removeItem

void removeItem(TableTreeItem item)

setBackground

public void setBackground(org.eclipse.swt.graphics.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.

Since:
2.0

setChecked

public void setChecked(boolean checked)
Sets the checked state of the checkbox for this item. This state change only applies if the Table was created with the SWT.CHECK style.

setGrayed

public void setGrayed(boolean grayed)
Sets the grayed state of the checkbox for this item. This state change only applies if the Table was created with the SWT.CHECK style.

Since:
2.1

setExpanded

public void setExpanded(boolean expanded)
Sets the expanded state.

setFont

public void setFont(org.eclipse.swt.graphics.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.

Since:
3.0

setForeground

public void setForeground(org.eclipse.swt.graphics.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.

Since:
2.0, 2.0

setImage

public void setImage(int index,
                     org.eclipse.swt.graphics.Image image)
Sets the image at an index.

The image can be null. The image in column 0 is reserved for the [+] and [-] images of the tree, therefore do nothing if index is 0.

setImage

public void setImage(org.eclipse.swt.graphics.Image image)
Sets the first image.

The image can be null. The image in column 0 is reserved for the [+] and [-] images of the tree, therefore do nothing.

setText

public void setText(int index,
                    java.lang.String text)
Sets the widget text.

The widget text for an item is the label of the item or the label of the text specified by a column number.

setText

public void setText(java.lang.String string)
Description copied from class: org.eclipse.swt.widgets.Item
Sets the receiver's text.

setVisible

void setVisible(boolean show)
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> swt >> [ custom overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.swt.custom.TableTreeItem JAVADOC | Sourc code of org.eclipse.swt.custom.TableTreeItem SOURCE | Download org.eclipse.swt.custom.TableTreeItem DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD