Class TreeTableCellEditor

  extended by javax.swing.AbstractCellEditor
      extended by javax.swing.DefaultCellEditor
          extended by org.jdesktop.swingx.treetable.TreeTableCellEditor
All Implemented Interfaces:
Serializable, CellEditor, TableCellEditor, TreeCellEditor

public class TreeTableCellEditor
extends DefaultCellEditor

An editor that can be used to edit the tree column. This extends DefaultCellEditor and uses a JTextField (actually, TreeTableTextField) to perform the actual editing.

To support editing of the tree column we can not make the tree editable. The reason this doesn't work is that you can not use the same component for editing and rendering. The table may have the need to paint cells, while a cell is being edited. If the same component were used for the rendering and editing the component would be moved around, and the contents would change. When editing, this is undesirable, the contents of the text field must stay the same, including the caret blinking, and selections persisting. For this reason the editing is done via a TableCellEditor.

Another interesting thing to be aware of is how tree positions its render and editor. The render/editor is responsible for drawing the icon indicating the type of node (leaf, branch...). The tree is responsible for drawing any other indicators, perhaps an additional +/- sign, or lines connecting the various nodes. So, the renderer is positioned based on depth. On the other hand, table always makes its editor fill the contents of the cell. To get the allusion that the table cell editor is part of the tree, we don't want the table cell editor to fill the cell bounds. We want it to be placed in the same manner as tree places it editor, and have table message the tree to paint any decorations the tree wants. Then, we would only have to worry about the editing part. The approach taken here is to determine where tree would place the editor, and to override the reshape method in the JTextField component to nudge the textfield to the location tree would place it. Since JXTreeTable will paint the tree behind the editor everything should just work. So, that is what we are doing here. Determining of the icon position will only work if the TreeCellRenderer is an instance of DefaultTreeCellRenderer. If you need custom TreeCellRenderers, that don't descend from DefaultTreeCellRenderer, and you want to support editing in JXTreeTable, you will have to do something similar.

See Also:
Serialized Form

Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.DefaultCellEditor
Field Summary
Fields inherited from class javax.swing.DefaultCellEditor
clickCountToStart, delegate, editorComponent
Fields inherited from class javax.swing.AbstractCellEditor
changeEvent, listenerList
Constructor Summary
TreeTableCellEditor(JTree tree)
Method Summary
 Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)
          Overriden to determine an offset that tree would place the editor at.
protected  void initEditorOffset(JTable table, int row, int column, boolean isSelected)
 boolean isCellEditable(EventObject e)
          This is overriden to forward the event to the tree.
Methods inherited from class javax.swing.DefaultCellEditor
cancelCellEditing, getCellEditorValue, getClickCountToStart, getComponent, getTreeCellEditorComponent, setClickCountToStart, shouldSelectCell, stopCellEditing
Methods inherited from class javax.swing.AbstractCellEditor
addCellEditorListener, fireEditingCanceled, fireEditingStopped, getCellEditorListeners, removeCellEditorListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.swing.CellEditor
addCellEditorListener, removeCellEditorListener

Constructor Detail


public TreeTableCellEditor(JTree tree)
Method Detail


public Component getTableCellEditorComponent(JTable table,
                                             Object value,
                                             boolean isSelected,
                                             int row,
                                             int column)
Overriden to determine an offset that tree would place the editor at. The offset is determined from the getRowBounds JTree method, and additionaly from the icon DefaultTreeCellRenderer will use.

The offset is then set on the TreeTableTextField component created in the constructor, and returned.

Specified by:
getTableCellEditorComponent in interface TableCellEditor
getTableCellEditorComponent in class DefaultCellEditor
table - the JTable that is asking the editor to edit; can be null
value - the value of the cell to be edited; it is up to the specific editor to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. null is a valid value
isSelected - true if the cell is to be rendered with highlighting
row - the row of the cell being edited
column - the column of the cell being edited
the component for editing


protected void initEditorOffset(JTable table,
                                int row,
                                int column,
                                boolean isSelected)
row -
isSelected -


public boolean isCellEditable(EventObject e)
This is overriden to forward the event to the tree. This will return true if the click count >= clickCountToStart, or the event is null.

Specified by:
isCellEditable in interface CellEditor
isCellEditable in class DefaultCellEditor
e - an event object
See Also: