org.eclipse.swt.custom

Class TableTreeEditor

java.lang.Object

org.eclipse.swt.custom.ControlEditor

org.eclipse.swt.custom.TableTreeEditor

Deprecated.

As of 3.1 use TreeEditor with Tree, TreeItem and TreeColumn

public class TableTreeEditor
extends ControlEditor

A TableTreeEditor is a manager for a Control that appears above a cell in a TableTree and tracks with the moving and resizing of that cell. It can be used to display a text widget above a cell in a TableTree so that the user can edit the contents of that cell. It can also be used to display a button that can launch a dialog for modifying the contents of the associated cell.

Here is an example of using a TableTreeEditor:

        final TableTree tableTree = new TableTree(shell, SWT.FULL_SELECTION | SWT.HIDE_SELECTION);
        final Table table = tableTree.getTable();
        TableColumn column1 = new TableColumn(table, SWT.NONE);
        TableColumn column2 = new TableColumn(table, SWT.NONE);
        for (int i = 0; i < 10; i++) {
                TableTreeItem item = new TableTreeItem(tableTree, SWT.NONE);
                item.setText(0, "item " + i);
                item.setText(1, "edit this value");
                for (int j = 0; j < 3; j++) {
                        TableTreeItem subitem = new TableTreeItem(item, SWT.NONE);
                        subitem.setText(0, "subitem " + i + " " + j);
                        subitem.setText(1, "edit this value");
                }
        }
        column1.setWidth(100);
        column2.pack();
        
        final TableTreeEditor editor = new TableTreeEditor(tableTree);
        //The editor must have the same size as the cell and must
        //not be any smaller than 50 pixels.
        editor.horizontalAlignment = SWT.LEFT;
        editor.grabHorizontal = true;
        editor.minimumWidth = 50;
        // editing the second column
        final int EDITABLECOLUMN = 1;
        
        tableTree.addSelectionListener(new SelectionAdapter() {
                public void widgetSelected(SelectionEvent e) {
                        // Clean up any previous editor control
                        Control oldEditor = editor.getEditor();
                        if (oldEditor != null) oldEditor.dispose();
        
                        // Identify the selected row
                        TableTreeItem item = (TableTreeItem)e.item;
                        if (item == null) return;
        
                        // The control that will be the editor must be a child of the Table
                        Text newEditor = new Text(table, SWT.NONE);
                        newEditor.setText(item.getText(EDITABLECOLUMN));
                        newEditor.addModifyListener(new ModifyListener() {
                                public void modifyText(ModifyEvent e) {
                                        Text text = (Text)editor.getEditor();
                                        editor.getItem().setText(EDITABLECOLUMN, text.getText());
                                }
                        });
                        newEditor.selectAll();
                        newEditor.setFocus();
                        editor.setEditor(newEditor, item, EDITABLECOLUMN);
                }
        });
 

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	column Deprecated.
(package private) ControlListener	columnListener Deprecated.
(package private) TableTreeItem	item Deprecated.
(package private) TableTree	tableTree Deprecated.
(package private) TreeListener	treeListener Deprecated.

Fields inherited from class org.eclipse.swt.custom.ControlEditor

editor, grabHorizontal, grabVertical, horizontalAlignment, minimumHeight, minimumWidth, parent, verticalAlignment

Constructor Summary

Constructors

Constructor and Description
TableTreeEditor(TableTree tableTree) Deprecated. Creates a TableTreeEditor for the specified TableTree.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) Rectangle	computeBounds() Deprecated.
void	dispose() Deprecated. Removes all associations between the TableTreeEditor and the cell in the table tree.
int	getColumn() Deprecated. Returns the zero based index of the column of the cell being tracked by this editor.
TableTreeItem	getItem() Deprecated. Returns the TableTreeItem for the row of the cell being tracked by this editor.
void	layout() Deprecated. Lays out the control within the underlying composite.
void	setColumn(int column) Deprecated.
void	setEditor(Control editor, TableTreeItem item, int column) Deprecated. Specify the Control that is to be displayed and the cell in the table that it is to be positioned above.
void	setItem(TableTreeItem item) Deprecated.

Methods inherited from class org.eclipse.swt.custom.ControlEditor

getEditor, scroll, setEditor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tableTree

TableTree tableTree

Deprecated.

item

TableTreeItem item

Deprecated.

column

int column

Deprecated.

columnListener

ControlListener columnListener

Deprecated.

treeListener

TreeListener treeListener

Deprecated.

Constructor Detail

TableTreeEditor

public TableTreeEditor(TableTree tableTree)

Deprecated.

Creates a TableTreeEditor for the specified TableTree.

Parameters:

tableTree - the TableTree Control above which this editor will be displayed

Method Detail

computeBounds

Rectangle computeBounds()

Deprecated.

Overrides:

computeBounds in class ControlEditor

dispose

public void dispose()

Deprecated.

Removes all associations between the TableTreeEditor and the cell in the table tree. The TableTree and the editor Control are not disposed.

Overrides:

dispose in class ControlEditor

getColumn

public int getColumn()

Deprecated.

Returns the zero based index of the column of the cell being tracked by this editor.

Returns:

the zero based index of the column of the cell being tracked by this editor

getItem

public TableTreeItem getItem()

Deprecated.

Returns the TableTreeItem for the row of the cell being tracked by this editor.

Returns:

the TableTreeItem for the row of the cell being tracked by this editor

setColumn

public void setColumn(int column)

Deprecated.

setItem

public void setItem(TableTreeItem item)

Deprecated.

setEditor

public void setEditor(Control editor,
             TableTreeItem item,
             int column)

Deprecated.

Specify the Control that is to be displayed and the cell in the table that it is to be positioned above.

Note: The Control provided as the editor must be created with its parent being the Table control specified in the TableEditor constructor.

Parameters:

editor - the Control that is displayed above the cell being edited

item - the TableItem for the row of the cell being tracked by this editor

column - the zero based index of the column of the cell being tracked by this editor

layout

public void layout()

Deprecated.

Description copied from class: ControlEditor

Lays out the control within the underlying composite. This method should be called after changing one or more fields to force the Editor to resize.

Overrides:

layout in class ControlEditor