Eclipse Platform
2.0

org.eclipse.swt.custom
Class TableEditor

java.lang.Object
  |
  +--org.eclipse.swt.custom.ControlEditor
        |
        +--org.eclipse.swt.custom.TableEditor

public class TableEditor
extends ControlEditor

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:

 Table table = new Table(parent, SWT.FULL_SELECTION);
 TableEditor editor = new TableEditor (table);
 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
		int index = table.getSelectionIndex ();
		if (index == -1) return;
		TableItem item = table.getItem (index);

		// The control that will be the editor must be a child of the Table
		Text text = new Text(table, SWT.NONE);

		//The text 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;

		// Open the text editor in the second column of the selected row.
		editor.setEditor (text, item, 1);

		// Assign focus to the text control
		text.setFocus ();
	}
 });
 


Field Summary
 
Fields inherited from class org.eclipse.swt.custom.ControlEditor
grabHorizontal, grabVertical, horizontalAlignment, minimumHeight, minimumWidth, verticalAlignment
 
Constructor Summary
TableEditor(Table table)
          Creates a TableEditor for the specified Table.
 
Method Summary
 void dispose()
          Removes all associations between the TableEditor and the cell in the table.
 int getColumn()
          Returns the zero based index of the column of the cell being tracked by this editor.
 TableItem getItem()
          Returns the TableItem for the row of the cell being tracked by this editor.
 void setColumn(int column)
           
 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.
 void setItem(TableItem item)
           
 
Methods inherited from class org.eclipse.swt.custom.ControlEditor
getEditor, setEditor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableEditor

public TableEditor(Table table)
Creates a TableEditor for the specified Table.

Parameters:
table - the Table Control above which this editor will be displayed
Method Detail

dispose

public void dispose()
Removes all associations between the TableEditor and the cell in the table. The Table and the editor Control are not disposed.

Overrides:
dispose in class ControlEditor

getColumn

public int getColumn()
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 TableItem getItem()
Returns the TableItem for the row of the cell being tracked by this editor.

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

setColumn

public void setColumn(int column)

setItem

public void setItem(TableItem item)

setEditor

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

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.