Top Description Fields Constructors Methods
org.eclipse.swt.custom

public Class TableEditor

extends ControlEditor
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.events.*, org.eclipse.swt.graphics.*, org.eclipse.swt.widgets.*

A TableEditor is a manager for a Control that appears above a cell in a Table and tracks with the moving and resizing of that cell. It can be used to display a text widget above a cell in a Table 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 TableEditor:


	final Table table = new Table(shell, SWT.FULL_SELECTION | SWT.HIDE_SELECTION);
	TableColumn column1 = new TableColumn(table, SWT.NONE);
	TableColumn column2 = new TableColumn(table, SWT.NONE);
	for (int i = 0; i < 10; i++) {
		TableItem item = new TableItem(table, SWT.NONE);
		item.setText(new String[] {"item " + i, "edit this value"});
	}
	column1.pack();
	column2.pack();

	final TableEditor editor = new TableEditor(table);
	//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;

	table.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
			TableItem item = (TableItem)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);
		}
	});
 
See Also
TableEditor snippets, Sample code and further information

Field Summary

Modifier and TypeField and Description
pack-priv int
pack-priv ControlListener
pack-priv TableItem
pack-priv Table
pack-priv static final int
pack-priv Runnable
Inherited from org.eclipse.swt.custom.ControlEditor:
editorgrabHorizontalgrabVerticalhorizontalAlignmentminimumHeightminimumWidthparentverticalAlignment

Constructor Summary

AccessConstructor and Description
public
TableEditor(Table
the Table Control above which this editor will be displayed
table
)

Creates a TableEditor for the specified Table.

Method Summary

Modifier and TypeMethod and Description
pack-priv Rectangle
public void
dispose()

Overrides org.eclipse.swt.custom.ControlEditor.dispose.

Removes all associations between the TableEditor and the cell in the table.
public int

Returns:

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

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

public TableItem

Returns:

the TableItem for the row of the cell being tracked by this editor
getItem
()

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

public void
layout()

Overrides org.eclipse.swt.custom.ControlEditor.layout.

Lays out the control within the underlying composite.
pack-priv void
public void
setColumn(int
the zero based index of the column of the cell being tracked by this editor
column
)

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

public void
setEditor(Control
the Control that is displayed above the composite being edited
editor
)

Overrides org.eclipse.swt.custom.ControlEditor.setEditor.

Specify the Control that is to be displayed.
public void
setEditor(Control
the Control that is displayed above the cell being edited
editor
,
TableItem
the TableItem for the row of the cell being tracked by this editor
item
,
int
the zero based index of the column of the cell being tracked by this editor
column
)

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

public void
setItem(TableItem
the item to be edited
item
)

Specifies the TableItem that is to be edited.

Inherited from org.eclipse.swt.custom.ControlEditor:
getEditorscroll

Field Detail

columnback to summary
pack-priv int column
columnListenerback to summary
pack-priv ControlListener columnListener
itemback to summary
pack-priv TableItem item
tableback to summary
pack-priv Table table
TIMEOUTback to summary
pack-priv static final int TIMEOUT
timerback to summary
pack-priv Runnable timer

Constructor Detail

TableEditorback to summary
public TableEditor(Table table)

Creates a TableEditor for the specified Table.

Parameters
table:Table

the Table Control above which this editor will be displayed

Method Detail

computeBoundsback to summary
pack-priv Rectangle computeBounds()

Overrides org.eclipse.swt.custom.ControlEditor.computeBounds.

Annotations
@Override
disposeback to summary
public void dispose()

Overrides org.eclipse.swt.custom.ControlEditor.dispose.

Removes all associations between the TableEditor and the cell in the table. The Table and the editor Control are not disposed.

Annotations
@Override
getColumnback to summary
public int getColumn()

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

Returns:int

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

getItemback to summary
public TableItem getItem()

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

Returns:TableItem

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

layoutback to summary
public void layout()

Overrides org.eclipse.swt.custom.ControlEditor.layout.

Doc from org.eclipse.swt.custom.ControlEditor.layout.

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.

Annotations
@Override
resizeback to summary
pack-priv void resize()
setColumnback to summary
public void setColumn(int column)

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

Parameters
column:int

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

setEditorback to summary
public void setEditor(Control editor)

Overrides org.eclipse.swt.custom.ControlEditor.setEditor.

Doc from org.eclipse.swt.custom.ControlEditor.setEditor.

Specify the Control that is to be displayed.

Note

The Control provided as the editor must be created with its parent being the Composite specified in the ControlEditor constructor.

Parameters
editor:Control

the Control that is displayed above the composite being edited

Annotations
@Override
setEditorback to summary
public void setEditor(Control editor, TableItem item, int column)

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:Control

the Control that is displayed above the cell being edited

item:TableItem

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

column:int

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

setItemback to summary
public void setItem(TableItem item)

Specifies the TableItem that is to be edited.

Parameters
item:TableItem

the item to be edited