org.netbeans.swing.outline

Interface RowModel

public interface RowModel

A model for the rows in an Outline. This is passed the object in column 0 of an Outline table (the tree column), and provides objects for the other columns - essentially a model for the data in the rows of an Outline.

Note that all column indexes passed to this interface are 0-based - that is, column 0 is the first column after the tree node column, so the object returned by getValueFor(someObject, 0) is the object that should appear in column 1 of the actual table.

Method Summary

Methods

Modifier and Type	Method and Description
Class	getColumnClass(int column) Get the object class for the column.
int	getColumnCount() Get the column count.
String	getColumnName(int column) Get a localized name of this column that can be displayed in the table header
Object	getValueFor(Object node, int column) Get the value at a given column.
boolean	isCellEditable(Object node, int column) Determine if the cell in this column is editable for the passed node.
void	setValueFor(Object node, int column, Object value) Set the value of the object in this column.

Method Detail

getColumnCount

int getColumnCount()

Get the column count. Do not include the base (nodes) column of the Outline, only the number of columns in addition to it that should be displayed.

Returns:

the number of columns this model will contribute to the OutlineModel, not including the tree column

getValueFor

Object getValueFor(Object node,
                 int column)

Get the value at a given column.

Parameters:

node - The node in column 0 of the Outline

column - The index of the column minus the nodes column

Returns:

the value that should be displayed in the specified column, given the node in the tree column

getColumnClass

Class getColumnClass(int column)

Get the object class for the column. Analogous to TableModel.getColumnClass(int column)

Parameters:

column - an index into the columns represented by this model (0 based - does not include the tree column of the OutlineModel)

Returns:

the class of object that will be displayed in the specified column

isCellEditable

boolean isCellEditable(Object node,
                     int column)

Determine if the cell in this column is editable for the passed node.

Parameters:

node - the object displayed in the tree column of the Outline

column - the column index into the columns defined by this RowModel

setValueFor

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

Set the value of the object in this column. Typically this may call a setter on the node object in column 0.

getColumnName

String getColumnName(int column)

Get a localized name of this column that can be displayed in the table header

Parameters:

column - the column a name is requested for

Returns:

a localized name for the column