TableEditor

* 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. * <p> Here is an example of using a TableEditor: <code><pre> 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 &lt; 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 !is null) oldEditor.dispose(); * // Identify the selected row TableItem item = (TableItem)e.item; if (item is 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); } }); </pre></code> * @see <a href="http://www.eclipse.org/swt/snippets/#tableeditor">TableEditor snippets</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

Constructors

this
this(Table table)

Creates a TableEditor for the specified Table. * @param table the Table Control above which this editor will be displayed *

Members

Functions

dispose
void dispose()

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

getColumn
int getColumn()

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

getItem
TableItem getItem()

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

setColumn
void setColumn(int column)

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

setEditor
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. * <p>Note: The Control provided as the editor <b>must</b> be created with its parent being the Table control specified in the TableEditor constructor. * @param editor the Control that is displayed above the cell being edited @param item the TableItem for the row of the cell being tracked by this editor @param column the zero based index of the column of the cell being tracked by this editor

setItem
void setItem(TableItem item)

Specifies the <code>TableItem</code> that is to be edited. * @param item the item to be edited

Inherited Members

From ControlEditor

horizontalAlignment
int horizontalAlignment;

Specifies how the editor should be aligned relative to the control. Allowed values are SWT.LEFT, SWT.RIGHT and SWT.CENTER. The default value is SWT.CENTER.

grabHorizontal
bool grabHorizontal;

Specifies whether the editor should be sized to use the entire width of the control. True means resize the editor to the same width as the cell. False means do not adjust the width of the editor. The default value is false.

minimumWidth
int minimumWidth;

Specifies the minimum width the editor can have. This is used in association with a true value of grabHorizontal. If the cell becomes smaller than the minimumWidth, the editor will not made smaller than the minimum width value. The default value is 0.

verticalAlignment
int verticalAlignment;

Specifies how the editor should be aligned relative to the control. Allowed values are SWT.TOP, SWT.BOTTOM and SWT.CENTER. The default value is SWT.CENTER.

grabVertical
bool grabVertical;

Specifies whether the editor should be sized to use the entire height of the control. True means resize the editor to the same height as the underlying control. False means do not adjust the height of the editor. The default value is false.

minimumHeight
int minimumHeight;

Specifies the minimum height the editor can have. This is used in association with a true value of grabVertical. If the control becomes smaller than the minimumHeight, the editor will not made smaller than the minimum height value. The default value is 0.

dispose
void dispose()

Removes all associations between the Editor and the underlying composite. The composite and the editor Control are <b>not</b> disposed.

getEditor
Control getEditor()

Returns the Control that is displayed above the composite being edited. * @return the Control that is displayed above the composite being edited

layout
void 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.

setEditor
void setEditor(Control editor)

Specify the Control that is to be displayed. * <p>Note: The Control provided as the editor <b>must</b> be created with its parent being the Composite specified in the ControlEditor constructor. * @param editor the Control that is displayed above the composite being edited

Meta