TableTree

A TableTree is a selectable user interface object that displays a hierarchy of items, and issues notification when an item is selected. A TableTree may be single or multi select. The item children that may be added to instances of this class must be of type <code>TableTreeItem</code>. Note that although this class is a subclass of <code>Composite</code>, it does not make sense to add <code>Control</code> children to it, or set a layout on it. <dl> <dt>Styles: <dd> SINGLE, MULTI, CHECK, FULL_SELECTION <dt>Events: <dd> Selection, DefaultSelection, Collapse, Expand </dl> Note: Only one of the styles SINGLE, and MULTI may be specified.

@deprecated As of 3.1 use Tree, TreeItem and TreeColumn

class TableTree : Composite {

Table table;

TableTreeItem[] items;

Image plusImage;

Image minusImage;

Image sizeImage;

bool inDispose;

TableTreeItem[] EMPTY_ITEMS;

String[] EMPTY_TEXTS;

Image[] EMPTY_IMAGES;

String ITEMID;

this(Composite parent, int style);

void addSelectionListener(SelectionListener listener);

void addTreeListener(TreeListener listener);

void deselectAll();

int getItemCount();

int getItemHeight();

TableTreeItem[] getItems();

TableTreeItem[] getSelection();

int getSelectionCount();

Table getTable();

int indexOf(TableTreeItem item);

TableTreeItem getItem(int index);

TableTreeItem getItem(Point point);

void removeAll();

void removeSelectionListener(SelectionListener listener);

void removeTreeListener(TreeListener listener);

void selectAll();

void setSelection(TableTreeItem[] items);

void showItem(TableTreeItem item);

void showSelection();

}

Constructors

this this(Composite parent, int style): Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. The style value is either one of the style constants defined in class <code>SWT</code> which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Members

Functions

addSelectionListener void addSelectionListener(SelectionListener listener): Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the <code>SelectionListener</code> interface. When <code>widgetSelected</code> is called, the item field of the event object is valid. If the receiver has <code>SWT.CHECK</code> style set and the check selection changes, the event object detail field contains the value <code>SWT.CHECK</code>. <code>widgetDefaultSelected</code> is typically called when an item is double-clicked. The item field of the event object is valid for default selection, but the detail field is not used.
addTreeListener void addTreeListener(TreeListener listener): Adds the listener to the collection of listeners who will be notified when an item in the receiver is expanded or collapsed by sending it one of the messages defined in the <code>TreeListener</code> interface.
deselectAll void deselectAll(): Deselects all items. If an item is selected, it is deselected. If an item is not selected, it remains unselected.
getItem TableTreeItem getItem(int index): Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.
getItem TableTreeItem getItem(Point point): Returns the item at the given point in the receiver or null if no such item exists. The point is in the coordinate system of the receiver.
getItemCount int getItemCount(): Gets the number of items. @return the number of items in the widget
getItemHeight int getItemHeight(): Gets the height of one item. This operation will fail if the height of one item could not be queried from the OS.
getItems TableTreeItem[] getItems(): Gets the items. @return the items in the widget
getSelection TableTreeItem[] getSelection(): Gets the selected items. This operation will fail if the selected items cannot be queried from the OS.
getSelectionCount int getSelectionCount(): Gets the number of selected items. This operation will fail if the number of selected items cannot be queried from the OS.
getTable Table getTable(): Returns the underlying Table control.
indexOf int indexOf(TableTreeItem item): Gets the index of an item.
removeAll void removeAll(): Removes all items. This operation will fail when an item could not be removed in the OS.
removeSelectionListener void removeSelectionListener(SelectionListener listener): Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.
removeTreeListener void removeTreeListener(TreeListener listener): Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.
selectAll void selectAll(): Selects all of the items in the receiver. If the receiver is single-select, do nothing.
setSelection void setSelection(TableTreeItem[] items): Sets the receiver's selection to be the given array of items. The current selection is cleared before the new items are selected. Items that are not in the receiver are ignored. If the receiver is single-select and multiple items are specified, then all items are ignored.
showItem void showItem(TableTreeItem item): Shows the item. If the item is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled and expanded until the item is visible.
showSelection void showSelection(): Shows the selection. If there is no selection or the selection is already visible, this method does nothing. If the selection is scrolled out of view, the top index of the widget is changed such that selection becomes visible.

Inherited Members

From Composite

changed void changed(Control[] changed): Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver. If an ancestor does not have a layout, it is skipped.
getBackgroundMode int getBackgroundMode(): Returns the receiver's background drawing mode. This will be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERTIT_FORCE</code>.
getChildren Control[] getChildren(): Returns a (possibly empty) array containing the receiver's children. Children are returned in the order that they are drawn. The topmost control appears at the beginning of the array. Subsequent controls draw beneath this control and appear later in the array. Note: This is not the actual structure used by the receiver to maintain its list of children, so modifying the array will not affect the receiver.
getLayout Layout getLayout(): Returns layout which is associated with the receiver, or null if one has not been set.
getLayoutDeferred bool getLayoutDeferred(): Returns <code>true</code> if the receiver has deferred the performing of layout, and <code>false</code> otherwise.
getTabList Control[] getTabList(): Gets the (possibly empty) tabbing order for the control.
isLayoutDeferred bool isLayoutDeferred(): Returns <code>true</code> if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts. Otherwise, <code>false</code> is returned.
layout void layout(): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing. This is equivalent to calling <code>layout(true)</code>. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the argument is <code>true</code> the layout must not rely on any information it has cached about the immediate children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing. If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed, bool all): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the changed argument is <code>true</code> the layout must not rely on any information it has cached about its children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the all argument is <code>true</code> the layout will cascade down through all child widgets in the receiver's widget tree, regardless of whether the child has changed size. The changed argument is applied to all layouts. If the all argument is <code>false</code>, the layout will not cascade down through all child widgets in the receiver's widget tree. However, if a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(Control[] changed): Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver. The layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
setBackgroundMode void setBackgroundMode(int mode): Sets the background drawing mode to the argument which should be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERIT_FORCE</code>.
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null.
setLayoutDeferred void setLayoutDeferred(bool defer): If the argument is <code>true</code>, causes subsequent layout operations in the receiver or any of its children to be ignored. No layout of any kind can occur in the receiver or any of its children until the flag is set to false. Layout operations that occurred while the flag was <code>true</code> are remembered and when the flag is set to <code>false</code>, the layout operations are performed in an optimized manner. Nested calls to this method are stacked.
setTabList void setTabList(Control[] tabList): Sets the tabbing order for the specified controls to match the order that they occur in the argument list.