org.tentackle.swing

Class FormTableMap<T>

java.lang.Object

javax.swing.table.AbstractTableModel

org.tentackle.swing.AbstractFormTableModel<T>

org.tentackle.swing.FormTableMap<T>

Type Parameters:

T - the model's type

All Implemented Interfaces:

Serializable, EventListener, TableModelListener, TableModel

Direct Known Subclasses:

FormTableSorter

public class FormTableMap<T>
extends AbstractFormTableModel<T>
implements TableModelListener

Generic mapping of the rows within a FormTable.
Implementing a sorter is easily done by subclassing FormTableMap.

Author:

harald

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractFormTableModel<T>	model chained table model

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
FormTableMap(AbstractFormTableModel<T> model) Creates a form table map on top of a given table model.

Method Summary

Modifier and Type	Method and Description
Class<?>	getColumnClass(int col)
int	getColumnCount()
String	getColumnName(int column)
String	getDisplayedColumnName(int column) Gets the displayed column name.
FormTableEntry<T>	getEntryAt(int rowIndex) Gets the form table entry at given row.
int	getMappedIndex(int mappedRow) Gets the mapped row index according to a given model row. Inversion of getModelIndex().
int[]	getMappedIndex(int[] mappedRows) Gets the mapped row indexes according to given model rows. Inversion of getModelIndex().
AbstractFormTableModel<T>	getModel() Gets the table model this table mapper maps.
int	getModelIndex(int row) Gets the row in the original model according to the mapping. The default implementation returns the same row.
int[]	getModelIndex(int[] rows) Gets the rows in the original model according to the mapping. The default implementation returns the same rows.
int	getRowCount()
FormTableEntry<T>	getTemplate() Gets the table entry template from the model.
Object	getValueAt(int rowIndex, int columnIndex)
boolean	isCellEditable(int rowIndex, int columnIndex)
boolean	isDataChanged() Returns whether data has changed.
void	setDataChanged(boolean dataChanged) Sets a flag that model data has changed.
void	setModel(AbstractFormTableModel<T> model) Sets the table model.
void	setValueAt(Object aValue, int rowIndex, int columnIndex)
void	tableChanged(TableModelEvent e)

Methods inherited from class org.tentackle.swing.AbstractFormTableModel

getMap, getTable, setEntryAt, setMap, setTable

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

Field Detail

model

protected AbstractFormTableModel<T> model

chained table model

Constructor Detail

FormTableMap

public FormTableMap(AbstractFormTableModel<T> model)

Creates a form table map on top of a given table model.

Parameters:

model - the chained table model

Method Detail

getModel

public AbstractFormTableModel<T> getModel()

Gets the table model this table mapper maps.

Returns:

the table model

setModel

public void setModel(AbstractFormTableModel<T> model)

Sets the table model.

Parameters:

model - the table model

getTemplate

public FormTableEntry<T> getTemplate()

Description copied from class: AbstractFormTableModel

Gets the table entry template from the model.

Specified by:

getTemplate in class AbstractFormTableModel<T>

Returns:

the form table entry template

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

This method must be overridden for another mapping than 1:1.

Specified by:

getValueAt in interface TableModel

setValueAt

public void setValueAt(Object aValue,
                       int rowIndex,
                       int columnIndex)

This method must be overridden for another mapping than 1:1.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

getEntryAt

public FormTableEntry<T> getEntryAt(int rowIndex)

Description copied from class: AbstractFormTableModel

Gets the form table entry at given row.

Specified by:

getEntryAt in class AbstractFormTableModel<T>

Parameters:

rowIndex - the row of the table entry

Returns:

the table entry, null if rowIndex out of range

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

getColumnName

public String getColumnName(int column)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getDisplayedColumnName

public String getDisplayedColumnName(int column)

Description copied from class: AbstractFormTableModel

Gets the displayed column name.

Specified by:

getDisplayedColumnName in class AbstractFormTableModel<T>

Parameters:

column - column index

Returns:

the column name

getColumnClass

public Class<?> getColumnClass(int col)

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

getMappedIndex

public int getMappedIndex(int mappedRow)

Description copied from class: AbstractFormTableModel

Gets the mapped row index according to a given model row.
Inversion of getModelIndex(). The default implementation returns the same row. Must be overridden for another mapping than 1:1.

Overrides:

getMappedIndex in class AbstractFormTableModel<T>

Parameters:

mappedRow - the original row

Returns:

the mapped row index

getMappedIndex

public int[] getMappedIndex(int[] mappedRows)

Description copied from class: AbstractFormTableModel

Gets the mapped row indexes according to given model rows.
Inversion of getModelIndex(). The default implementation returns the same rows. Must be overridden for another mapping than 1:1.

Overrides:

getMappedIndex in class AbstractFormTableModel<T>

Parameters:

mappedRows - the original rows

Returns:

the mapped row indexes

getModelIndex

public int getModelIndex(int row)

Description copied from class: AbstractFormTableModel

Gets the row in the original model according to the mapping.
The default implementation returns the same row. Must be overridden for another mapping than 1:1.

Overrides:

getModelIndex in class AbstractFormTableModel<T>

Parameters:

row - the row of this model

Returns:

the row of the mapped model

getModelIndex

public int[] getModelIndex(int[] rows)

Description copied from class: AbstractFormTableModel

Gets the rows in the original model according to the mapping.
The default implementation returns the same rows. Must be overridden for another mapping than 1:1.

Overrides:

getModelIndex in class AbstractFormTableModel<T>

Parameters:

rows - the array of rows of this model

Returns:

the rows of the mapped model

tableChanged

public void tableChanged(TableModelEvent e)

Event handler for TableModelListener: table data has changed.
This method must be overridden for another mapping than 1:1. The default implementation just invokes fireTableChanged.

Specified by:

tableChanged in interface TableModelListener

Parameters:

e - the table model event

isDataChanged

public boolean isDataChanged()

Description copied from class: AbstractFormTableModel

Returns whether data has changed. Used to for the famous "discard any changes?"-question.

Overrides:

isDataChanged in class AbstractFormTableModel<T>

Returns:

true if model data has been changed

setDataChanged

public void setDataChanged(boolean dataChanged)

Description copied from class: AbstractFormTableModel

Sets a flag that model data has changed. Will be cleared on listChanged() or cursorChanged().

Overrides:

setDataChanged in class AbstractFormTableModel<T>

Parameters:

dataChanged - true if model data has changed