org.eclipse.nebula.widgets.ctree

Class CTreeEditor

java.lang.Object

org.eclipse.swt.custom.ControlEditor

org.eclipse.nebula.widgets.ctree.CTreeEditor

public class CTreeEditor
extends org.eclipse.swt.custom.ControlEditor

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

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	column
(package private) org.eclipse.swt.events.ControlListener	columnListener
(package private) CTreeItem	item
(package private) CTree	tree
(package private) org.eclipse.swt.events.TreeListener	treeListener

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

grabHorizontal, grabVertical, horizontalAlignment, minimumHeight, minimumWidth, verticalAlignment

Constructor Summary

Constructors

Constructor and Description
CTreeEditor(CTree tree) Creates a CTableTreeEditor for the specified CTableTree.

Method Summary

Modifier and Type	Method and Description
void	dispose() Removes all associations between the CTableTreeEditor and the row in the tree.
int	getColumn() Returns the zero based index of the column of the cell being tracked by this editor.
CTreeItem	getItem() Returns the CTableTreeItem for the row of the cell being tracked by this editor.
void	layout()
void	setColumn(int column) Sets the zero based index of the column of the cell being tracked by this editor.
void	setEditor(org.eclipse.swt.widgets.Control editor, CTreeItem item) Specify the Control that is to be displayed and the cell in the tree that it is to be positioned above.
void	setEditor(org.eclipse.swt.widgets.Control editor, CTreeItem item, int column) Specify the Control that is to be displayed and the cell in the tree that it is to be positioned above.
void	setItem(CTreeItem 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

Field Detail

tree

CTree tree

item

CTreeItem item

column

int column

columnListener

org.eclipse.swt.events.ControlListener columnListener

treeListener

org.eclipse.swt.events.TreeListener treeListener

Constructor Detail

CTreeEditor

public CTreeEditor(CTree tree)

Creates a CTableTreeEditor for the specified CTableTree.

Parameters:

tree - the CTableTree Control above which this editor will be displayed

Method Detail

dispose

public void dispose()

Removes all associations between the CTableTreeEditor and the row in the tree. The tree and the editor Control are not disposed.

Overrides:

dispose in class org.eclipse.swt.custom.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

Since:

3.1

getItem

public CTreeItem getItem()

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

Returns:

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

layout

public void layout()

Overrides:

layout in class org.eclipse.swt.custom.ControlEditor

setColumn

public void setColumn(int column)

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

Parameters:

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

Since:

3.1

setEditor

public void setEditor(org.eclipse.swt.widgets.Control editor,
                      CTreeItem item)

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

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

Parameters:

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

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

setEditor

public void setEditor(org.eclipse.swt.widgets.Control editor,
                      CTreeItem item,
                      int column)

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

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

Parameters:

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

item - the CTableTreeItem 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

Since:

3.1

setItem

public void setItem(CTreeItem item)