net.sf.jguiraffe.gui.platform.swing.builder.components.table

Class SwingTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

net.sf.jguiraffe.gui.platform.swing.builder.components.table.SwingTableModel

All Implemented Interfaces:

Serializable, TableModel

public class SwingTableModel
extends AbstractTableModel

A table model implementation for tables defined by the TableTag tag handler class.

This class implements the typical table model functionality based on the data provided by a TableTag object. Especially the model collection and the constructed renderer and editor forms are used for extracting the required data. The basic idea is as follows: the index of the last accessed row is cached. If a different row is to be accessed, the model will fetch the data bean with this index from the model collection specified for the table tag. Then the forms will be initialized with this bean.

For editable columns special handling is required: If the column defines a special editor component, default form operations can be performed for validating user input and transfering it into the corresponding model bean. Otherwise the data passed to the setValueAt() method must be manually passed to the corresponding ComponentHandler objects; after that typical form operations can be used, too.

Version:

$Id: SwingTableModel.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
SwingTableModel(TableTag tt, JTable tab) Creates a new instance of SwingTableModel and initializes it.

Method Summary

Methods

Modifier and Type	Method and Description
protected List<Object>	fetchModelData(TableTag tt) Prepares the list with the model data.
void	fireTableChanged(TableModelEvent event) Notifies listeners about a change in the data of this model.
Class<?>	getColumnClass(int col) Returns the data class of the specified column.
int	getColumnCount() Returns the number of columns of the represented table.
String	getColumnName(int col) Returns the name for the specified column.
TableCellEditor	getEditor() Returns the cell editor associated with this model.
List<Object>	getModelData() Returns the list with the data of this model.
TableCellRenderer	getRenderer() Returns the cell renderer associated with this model.
int	getRowCount() Returns the number of rows of the represented table.
JTable	getTable() Returns a reference to the associated table.
TableTag	getTableTag() Returns the table tag this model is based onto.
Object	getValueAt(int row, int col) Returns the value at the specified cell.
boolean	hasEditor(int col) Checks whether for the specified column a custom editor is specified.
boolean	hasRenderer(int col) Tests whether for the specified column a custom renderer is specified.
boolean	isCellEditable(int row, int col) Returns a flag whether the specified cell can be modified.
void	setValueAt(Object value, int row, int col) Sets the value for the specified cell.
protected boolean	validateColumn(int col) Validates the column with the specified index.

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwingTableModel

public SwingTableModel(TableTag tt,
               JTable tab)

Creates a new instance of SwingTableModel and initializes it.

Parameters:

tt - the tag defining the underlying table

tab - the associated table

Method Detail

getModelData

public List<Object> getModelData()

Returns the list with the data of this model. The list contains beans that define the values of the single columns.

Returns:

the data list of this model

getTableTag

public TableTag getTableTag()

Returns the table tag this model is based onto.

Returns:

the table tag

getTable

public JTable getTable()

Returns a reference to the associated table.

Returns:

the table

getColumnCount

public int getColumnCount()

Returns the number of columns of the represented table.

Returns:

the number of columns of this table

getRowCount

public int getRowCount()

Returns the number of rows of the represented table.

Returns:

the number of rows of this table

getValueAt

public Object getValueAt(int row,
                int col)

Returns the value at the specified cell.

Parameters:

row - the row index

col - the column index

Returns:

the value of this cell

getColumnClass

public Class<?> getColumnClass(int col)

Returns the data class of the specified column. This implementation checks whether a logic column class was specified. If this is the case, it is mapped to the corresponding Java class. Otherwise, the Java class is directly obtained from the column definition.

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

Parameters:

col - the column index

Returns:

the data class for the specified column

getColumnName

public String getColumnName(int col)

Returns the name for the specified column.

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

Parameters:

col - the column index

Returns:

the title for this column

isCellEditable

public boolean isCellEditable(int row,
                     int col)

Returns a flag whether the specified cell can be modified.

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

Parameters:

row - the row index

col - the column index

Returns:

a flag whether this cell can be edited

setValueAt

public void setValueAt(Object value,
              int row,
              int col)

Sets the value for the specified cell.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

Parameters:

value - the value to set

row - the row index

col - the column index

fireTableChanged

public void fireTableChanged(TableModelEvent event)

Notifies listeners about a change in the data of this model. This implementation checks whether the change affects the cached data about the last read or edited rows.

Overrides:

fireTableChanged in class AbstractTableModel

Parameters:

event - the event

hasEditor

public boolean hasEditor(int col)

Checks whether for the specified column a custom editor is specified.

Parameters:

col - the column index

Returns:

a flag if this column has its own editor

getEditor

public TableCellEditor getEditor()

Returns the cell editor associated with this model. There is exactly one editor that is capable to serve all columns of this table (that define a custom editor).

Returns:

the cell editor used for the represented table

hasRenderer

public boolean hasRenderer(int col)

Tests whether for the specified column a custom renderer is specified.

Parameters:

col - the column index

Returns:

a flag whether this column has a custom renderer

getRenderer

public TableCellRenderer getRenderer()

Returns the cell renderer associated with this model. There is exactly one renderer that is capable of rendering all columns of this table that define a custom renderer.

Returns:

the cell renderer used for the represented table

fetchModelData

protected List<Object> fetchModelData(TableTag tt)

Prepares the list with the model data. This method is called once for initializing the data collection. It tries to extract the data the passed in table tag refers to as a list which can be fast accessed.

Parameters:

tt - the table tag defining the underlying table

Returns:

the data collection as a list

validateColumn

protected boolean validateColumn(int col)

Validates the column with the specified index. This method is always called when the user has entered data into a cell of the table. It delegates to the editor form to validate the input fields used in this column. It will also notify the TableEditorValidationHandler set for this table. If validation is successful, the value(s) will be written into the model.

Parameters:

col - the column to be validated

Returns:

a flag whether the data is valid