org.cytoscape.util.swing

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.

Author:

Philip Milne, Scott Violet

Module: swing-util-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>swing-util-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary

Modifier and Type	Method and Description
Class	getColumnClass(int column) Returns the type for column number column.
int	getColumnCount() Returns the number of available columns.
String	getColumnName(int column) Returns the name for column number column.
Object	getValueAt(Object node, int column) Returns the value to be displayed for node node, at column number column.
boolean	isCellEditable(Object node, int column) Indicates whether the the value for node node, at column number column is editable.
void	setValueAt(Object aValue, Object node, int column) Sets the value for node node, at column number 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 available columns.

getColumnName

String getColumnName(int column)

Returns the name for column number column.

Parameters:

column - the column number.

Returns:

the name for the column number.

getColumnClass

Class getColumnClass(int column)

Returns the type for column number column.

Parameters:

column - the column number.

Returns:

the type for the column.

getValueAt

Object getValueAt(Object node,
                  int column)

Returns the value to be displayed for node node, at column number column.

Parameters:

node - The node to check.

column - the column number.

Returns:

the value to be displayed for node node, at column number column.

isCellEditable

boolean isCellEditable(Object node,
                       int column)

Indicates whether the the value for node node, at column number column is editable.

Parameters:

node - The node to check.

column - The column number.

Returns:

True if editable, false otherwise.

setValueAt

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

Sets the value for node node, at column number column.

Parameters:

aValue - The value to set to.

node - The node to modify.

column - The column number to modify.