xdev.vt

Class VirtualTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

xdev.vt.VirtualTableModel

All Implemented Interfaces:

Serializable, EventListener, TableModel, VirtualTableListener, VirtualTableWrapper

public class VirtualTableModel
extends AbstractTableModel
implements VirtualTableListener, VirtualTableWrapper

This class acts as a model implementation for XdevTables using a VirtualTable as the underlying data model.

Calls for retrieving or modifying data are delegated to the VirtualTable.

The number and order of columns of this Model and the VirtualTable may differ. modelColumnIndices is used to map the columns of this Model to the columns of the VirtualTable.

Author:

XDEV Software Corp.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
VirtualTableModel(VirtualTable vt, int[] columnIndices) Initializes a new VirtualTableModel.

Method Summary

Modifier and Type	Method and Description
static Class	getClassForType(DataType type) Helper method for mapping DataTypes to Java classes.
Class	getColumnClass(int col) Returns the class of the underlying VirtualTableColumn.
int	getColumnCount() Returns the number of columns of the model.
String	getColumnName(int col) Returns the column name using the caption of the underlying VirtualTableColumn.
int[]	getModelColumnIndices() Returns the array of column indexes of the model.
int	getRowCount() Returns the number of rows in the VirtualTable.
Object	getValueAt(int row, int col) Returns a value from the VirtualTable at the specified position.
VirtualTable	getVirtualTable() Returns the wrapped VirtualTable.
VirtualTable.VirtualTableRow	getVirtualTableRow(int modelRow) Returns the wrapped VirtualTable.VirtualTableRow behind the index modelRow.
VirtualTable	getVT() Returns the wrapped VirtualTable.
boolean	isCellEditable(int row, int col) Returns, if a cell is editables.
void	setValueAt(Object newValue, int row, int col) Sets a value in the underlying VirtualTable at the specified position.
int	viewToModelColumn(int col) Return the index of the wrapped VirtualTable corresponding to Parameter col.
void	virtualTableDataChanged(VirtualTableEvent event) Notifies listeners that all cell values in the VirtualTable may have changed.
void	virtualTableRowDeleted(VirtualTableEvent event) Notifies all listeners that a row in the VirtualTable has been deleted.
void	virtualTableRowInserted(VirtualTableEvent event) Notifies all listeners that a row in the VirtualTable has been inserted.
void	virtualTableRowUpdated(VirtualTableEvent event) Notifies all listeners that a row in the VirtualTable has been updated.
void	virtualTableStructureChanged(VirtualTableEvent event) Notifies all listeners that the structure of the VirtualTable has been changed and updates the model column indices.

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, 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

VirtualTableModel

public VirtualTableModel(VirtualTable vt,
                         int[] columnIndices)

Initializes a new VirtualTableModel.

Parameters:

vt - the VirtualTable to use

columnIndices - an int array of column indices of the model. The values of the array contain the indexes of the VirtualTable.

Method Detail

getVT

public VirtualTable getVT()

Returns the wrapped VirtualTable.

Returns:

a VirtualTable

getModelColumnIndices

public int[] getModelColumnIndices()

Returns the array of column indexes of the model.

Specified by:

getModelColumnIndices in interface VirtualTableWrapper

Returns:

an int array of indexed

getValueAt

public Object getValueAt(int row,
                         int col)

Returns a value from the VirtualTable at the specified position.

Specified by:

getValueAt in interface TableModel

Parameters:

row - the row index

col - the model column index.

Returns:

a value

getColumnCount

public int getColumnCount()

Returns the number of columns of the model.

Specified by:

getColumnCount in interface TableModel

Returns:

the number of columns

getRowCount

public int getRowCount()

Returns the number of rows in the VirtualTable.

Specified by:

getRowCount in interface TableModel

Specified by:

getRowCount in interface VirtualTableWrapper

Returns:

the number of rows.

getColumnName

public String getColumnName(int col)

Returns the column name using the caption of the underlying VirtualTableColumn.

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

Parameters:

col - the model column index.

Returns:

the column name of the column

getColumnClass

public Class getColumnClass(int col)

Returns the class of the underlying VirtualTableColumn.

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

Parameters:

col - the model column index.

Returns:

the DataType of the column

getClassForType

public static Class getClassForType(DataType type)

Helper method for mapping DataTypes to Java classes.

Parameters:

type - a DataType to get a class for.

Returns:

a Class for the type.

setValueAt

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

Sets a value in the underlying VirtualTable at the specified position.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

Parameters:

newValue - the new value to be set.

row - the index of the row.

col - the model column index.

isCellEditable

public boolean isCellEditable(int row,
                              int col)

Returns, if a cell is editables.

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

Parameters:

row - the index of the row.

col - the model column index.

Returns:

if true, the cell can be edited.

getVirtualTable

public VirtualTable getVirtualTable()

Returns the wrapped VirtualTable.

Specified by:

getVirtualTable in interface VirtualTableWrapper

Returns:

a VirtualTable

viewToModelColumn

public int viewToModelColumn(int col)

Return the index of the wrapped VirtualTable corresponding to Parameter col.

Specified by:

viewToModelColumn in interface VirtualTableWrapper

Parameters:

col - the model column index

Returns:

a column index in the VirtualTable

getVirtualTableRow

public VirtualTable.VirtualTableRow getVirtualTableRow(int modelRow)

Returns the wrapped VirtualTable.VirtualTableRow behind the index modelRow.

Specified by:

getVirtualTableRow in interface VirtualTableWrapper

Parameters:

modelRow - the index in the model

Returns:

the wrapped VirtualTable.VirtualTableRow

virtualTableDataChanged

public void virtualTableDataChanged(VirtualTableEvent event)

Notifies listeners that all cell values in the VirtualTable may have changed.

Specified by:

virtualTableDataChanged in interface VirtualTableListener

Parameters:

event - a VirtualTableEvent with detailed information.

virtualTableRowDeleted

public void virtualTableRowDeleted(VirtualTableEvent event)

Notifies all listeners that a row in the VirtualTable has been deleted.

Specified by:

virtualTableRowDeleted in interface VirtualTableListener

Parameters:

event - a VirtualTableEvent with detailed information.

virtualTableRowInserted

public void virtualTableRowInserted(VirtualTableEvent event)

Notifies all listeners that a row in the VirtualTable has been inserted.

Specified by:

virtualTableRowInserted in interface VirtualTableListener

Parameters:

event - a VirtualTableEvent with detailed information.

virtualTableRowUpdated

public void virtualTableRowUpdated(VirtualTableEvent event)

Notifies all listeners that a row in the VirtualTable has been updated.

Specified by:

virtualTableRowUpdated in interface VirtualTableListener

Parameters:

event - a VirtualTableEvent with detailed information.

virtualTableStructureChanged

public void virtualTableStructureChanged(VirtualTableEvent event)

Notifies all listeners that the structure of the VirtualTable has been changed and updates the model column indices.

Specified by:

virtualTableStructureChanged in interface VirtualTableListener

Parameters:

event - a VirtualTableEvent with detailed information.