org.tentackle.swing

Class FormTableModel<T>

java.lang.Object

javax.swing.table.AbstractTableModel

org.tentackle.swing.AbstractFormTableModel<T>

org.tentackle.swing.FormTableModel<T>

Type Parameters:

T - the type managed by the model

All Implemented Interfaces:

Serializable, TableModel, BindableTableModel<T>

public class FormTableModel<T>
extends AbstractFormTableModel<T>
implements BindableTableModel<T>

Table-model for FormTables.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.tentackle.swing.BindableTableModel

BindableTableModel.BindType

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
FormTableModel(FormTableEntry<T> template) Creates an empty table model for a given template.
FormTableModel(FormTableEntry<T> template, List<T> list) Creates a table model for a list of objects.
FormTableModel(FormTableEntry<T> template, T[] array) Creates a table model for an array of objects.

Method Summary

Modifier and Type	Method and Description
void	bind() Binds the model.
protected FormTableBinder	createBinder() Creates a binder for this form. The default implementation invokes FormBindingFactory.createFormTableBinder(this).
FormTableBinder	getBinder() Gets the binder of this container.
FormTableBinding	getBinding(int columnIndex) Gets the binding for a given column.
String	getBindingPath(int mColumn) Gets the binding path for given model column. The returned path is relative to the object described by this table entry.
Class<?>	getBindingRootClass() Gets the root class where to start scan for Bindables.
BindableTableModel.BindType	getBindType() Determines whether the model using this entry is bindable and if so, which kind of binding to use.
Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
String	getColumnName(int columnIndex)
String	getDisplayedColumnName(int columnIndex) Gets the displayed column name.
FormTableEntry<T>	getEntryAt(int row) Gets the form table entry at given row.
int	getRowCount()
FormTable<T>	getTable() Gets the table.
FormTableEntry<T>	getTemplate() Gets the table entry template from the model.
Object	getValueAt(int rowIndex, int columnIndex)
boolean	isCellEditable(int rowIndex, int columnIndex)
void	listCellUpdated(int rowIndex, int columnIndex) Denotes that a table cell has changed and fires tableCellUpdated.
void	listChanged(List<T> list) Sets a new list of objects and fires tableDataChanged.
void	listChanged(T[] array) Sets a new array of objects and fires tableDataChanged.
void	listDeleted(int firstRow, int lastRow) Denotes that a range of rows have been deleted and fires tableRowsDeleted.
void	listInserted(int firstRow, int lastRow) Denotes that a range of rows have been insert and fires tableRowsInserted.
void	listUpdated(int firstRow, int lastRow) Denotes that a range of rows have been changed and fires tableRowsUpdated.
void	setDataChanged(boolean dataChanged) Sets a flag that model data has changed.
boolean	setEntryAt(FormTableEntry<T> entry, int row) Sets the form table entry at given row. The default implementation just triggers a value changed event for the table.
void	setTemplate(FormTableEntry<T> template) Sets the template. Useful if context has changed.
void	setValueAt(Object aValue, int rowIndex, int columnIndex) Sets the cell value.
String	toString() Prints the classname of the table entry.

Methods inherited from class org.tentackle.swing.AbstractFormTableModel

getMap, getMappedIndex, getMappedIndex, getModelIndex, getModelIndex, isDataChanged, 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, wait, wait, wait

Methods inherited from interface org.tentackle.swing.BindableTableModel

setTable

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, removeTableModelListener

Constructor Detail

FormTableModel

public FormTableModel(FormTableEntry<T> template,
                      List<T> list)

Creates a table model for a list of objects.

Parameters:

template - the table entry as a template to create other entries

list - the list of objects

FormTableModel

public FormTableModel(FormTableEntry<T> template,
                      T[] array)

Creates a table model for an array of objects.

Parameters:

template - the table entry as a template to create other entries

array - the array of objects

FormTableModel

public FormTableModel(FormTableEntry<T> template)

Creates an empty table model for a given template.

Parameters:

template - the table entry as a template to create other entries

Method Detail

setTemplate

public void setTemplate(FormTableEntry<T> template)

Sets the template.
Useful if context has changed.

Parameters:

template - the new template

createBinder

protected FormTableBinder createBinder()

Creates a binder for this form.
The default implementation invokes FormBindingFactory.createFormTableBinder(this).

Returns:

the binder

getBinder

public FormTableBinder getBinder()

Description copied from interface: BindableTableModel

Gets the binder of this container.

Specified by:

getBinder in interface BindableTableModel<T>

Returns:

the binder, never null.

getBindType

public BindableTableModel.BindType getBindType()

Description copied from interface: BindableTableModel

Determines whether the model using this entry is bindable and if so, which kind of binding to use.

Specified by:

getBindType in interface BindableTableModel<T>

Returns:

the binding type

getBindingRootClass

public Class<?> getBindingRootClass()

Description copied from interface: BindableTableModel

Gets the root class where to start scan for Bindables.

For FormTableModels this is the class of the FormTableEntry. Other models may refer to other classes.

Specified by:

getBindingRootClass in interface BindableTableModel<T>

Returns:

the class to start the scan

bind

public void bind()

Binds the model.
The method simply binds this model according to its BindableTableModel.BindType. If the bindtype is BindableTableModel.BindType.NONE, nothing will be bound.

See Also:

getBindType(), getBinder()

toString

public String toString()

Prints the classname of the table entry.

Overrides:

toString in class Object

Returns:

the class name of the template

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

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 columnIndex)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getDisplayedColumnName

public String getDisplayedColumnName(int columnIndex)

Description copied from class: AbstractFormTableModel

Gets the displayed column name.

Specified by:

getDisplayedColumnName in class AbstractFormTableModel<T>

Parameters:

columnIndex - column index

Returns:

the column name

getBinding

public FormTableBinding getBinding(int columnIndex)

Gets the binding for a given column.

Specified by:

getBinding in interface BindableTableModel<T>

Parameters:

columnIndex - the model column

Returns:

the binding, null if column not bound

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Specified by:

getValueAt in interface TableModel

setValueAt

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

Sets the cell value.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

getBindingPath

public String getBindingPath(int mColumn)

Gets the binding path for given model column.
The returned path is relative to the object described by this table entry.

Specified by:

getBindingPath in interface BindableTableModel<T>

Parameters:

mColumn - the datamodel-column

Returns:

the binding path, null if not bound

setDataChanged

public void setDataChanged(boolean dataChanged)

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

Overridden to propagate triggerValueChanged()

Overrides:

setDataChanged in class AbstractFormTableModel<T>

Parameters:

dataChanged - true if model data has changed

getTable

public FormTable<T> getTable()

Gets the table.

Overridden to get the table if models are chained

Specified by:

getTable in interface BindableTableModel<T>

Overrides:

getTable in class AbstractFormTableModel<T>

Returns:

the form table or null if this model is not the direct data model for the table

getEntryAt

public FormTableEntry<T> getEntryAt(int row)

Description copied from class: AbstractFormTableModel

Gets the form table entry at given row.

Specified by:

getEntryAt in class AbstractFormTableModel<T>

Parameters:

row - the row of the table entry

Returns:

the table entry, null if rowIndex out of range

setEntryAt

public boolean setEntryAt(FormTableEntry<T> entry,
                          int row)

Description copied from class: AbstractFormTableModel

Sets the form table entry at given row.
The default implementation just triggers a value changed event for the table. Must be overridden for another mapping than 1:1.

Overrides:

setEntryAt in class AbstractFormTableModel<T>

Parameters:

entry - the formtable entry

row - the row of the table entry

Returns:

true if replaced, false if not (rowIndex out of range)

getColumnClass

public Class<?> getColumnClass(int columnIndex)

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

listChanged

public void listChanged(List<T> list)

Sets a new list of objects and fires tableDataChanged.

Parameters:

list - the new list of objects

listChanged

public void listChanged(T[] array)

Sets a new array of objects and fires tableDataChanged.

Parameters:

array - the new array of objects

listUpdated

public void listUpdated(int firstRow,
                        int lastRow)

Denotes that a range of rows have been changed and fires tableRowsUpdated. The row numbers are silently aligned if out of range.

Parameters:

firstRow - the first row

lastRow - the last changed row (≥ firstRow)

listCellUpdated

public void listCellUpdated(int rowIndex,
                            int columnIndex)

Denotes that a table cell has changed and fires tableCellUpdated. If the row is out of range, nothing will be done. The handling of the column depends on the listener for the TableModelEvent.

Parameters:

rowIndex - the row number

columnIndex - the column index

listInserted

public void listInserted(int firstRow,
                         int lastRow)

Denotes that a range of rows have been insert and fires tableRowsInserted. The row numbers are silently aligned if out of range. Will nullpex if not in list-mode.

Parameters:

firstRow - the first row

lastRow - the last changed row (≥firstRow)

listDeleted

public void listDeleted(int firstRow,
                        int lastRow)

Denotes that a range of rows have been deleted and fires tableRowsDeleted. The row numbers are silently aligned if out of range. Will nullpex if not in list-mode.

Parameters:

firstRow - the first row

lastRow - the last changed row (≥ firstRow)