de.javagl.treetable

Interface TreeTableModel

All Superinterfaces:

TreeModel

All Known Implementing Classes:

AbstractTreeTableModel

public interface TreeTableModel
extends TreeModel

TreeTableModel is the model used by a JTreeTable. It extends TreeModel to add methods for getting information about the set of columns each node in the TreeTableModel may have. Each column, like a column in a TableModel, has a name and a type associated with it. Each node in the TreeTableModel can return a value for each of the columns and set that value if isCellEditable() returns true.

Note: In order to actually display the JTree in one column of the JTreeTable, implementors of this class have to return the TreeTableModel.class as the respective column class in their implementation of the getColumnClass(int) method:

 public Class<?> getColumnClass(int column)
 {
     if (column == columnThatShouldContainTheTree)
     {
         return TreeTableModel.class;
     }
     // Return other types as desired:
     return Object.class;
 }
 

Method Summary

Modifier and Type	Method and Description
Class<?>	getColumnClass(int column) Returns the type for the specified column.
int	getColumnCount() Returns the number of available columns.
String	getColumnName(int column) Returns the name for the specified column
Object	getValueAt(Object node, int column) Returns the value to be displayed for the given node in the specified column
boolean	isCellEditable(Object node, int column) Indicates whether the the value for the given node in the specified column is editable
void	setValueAt(Object value, Object node, int column) Sets the value for the given node in the specified column

Methods inherited from interface javax.swing.tree.TreeModel

addTreeModelListener, getChild, getChildCount, getIndexOfChild, getRoot, isLeaf, removeTreeModelListener, valueForPathChanged

Method Detail

getColumnCount

int getColumnCount()

Returns the number of available columns.

Returns:

The number of columns

getColumnName

String getColumnName(int column)

Returns the name for the specified column

Parameters:

column - The column

Returns:

The column name

getColumnClass

Class<?> getColumnClass(int column)

Returns the type for the specified column.

Note: For the column that should display the JTree, this method must return TreeTableModel.class.

Parameters:

column - The column

Returns:

The column name

getValueAt

Object getValueAt(Object node,
                  int column)

Returns the value to be displayed for the given node in the specified column

Parameters:

node - The node

column - The column

Returns:

The object that should be displayed

isCellEditable

boolean isCellEditable(Object node,
                       int column)

Indicates whether the the value for the given node in the specified column is editable

Parameters:

node - The node

column - The column

Returns:

Whether the specified value is editable

setValueAt

void setValueAt(Object value,
                Object node,
                int column)

Sets the value for the given node in the specified column

Parameters:

value - The value to set

node - The node

column - The column