xal.extension.widgets.swing

Class KeyValueTableModel<RecordType>

java.lang.Object

javax.swing.table.AbstractTableModel

xal.extension.widgets.swing.KeyValueTableModel<RecordType>

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel

Direct Known Subclasses:

KeyValueFilteredTableModel

public class KeyValueTableModel<RecordType>
extends javax.swing.table.AbstractTableModel

Table Model whose records are arbitrary objects and whose values are obtained through the Key-Value adaptor

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyValueAdaptor	KEY_VALUE_ADAPTOR key value adaptor to get the value from a record (row) for the specified key path (column property)

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
KeyValueTableModel() Empty Constructor
KeyValueTableModel(java.util.List<RecordType> records, java.lang.String... keyPaths) Primary Constructor

Method Summary

Modifier and Type	Method and Description
void	addKeyValueRecordListener(KeyValueRecordListener<? extends KeyValueTableModel<RecordType>,RecordType> listener) Add the specified listener as a receiver of record modification events from this instance.
java.lang.Class<?>	getColumnClass(int column) Get the data class for the specified column
int	getColumnCount() Get the number of columns to display
int	getColumnForKeyPath(java.lang.String keyPath) Get the model column for the specified key path
java.lang.String	getColumnName(int column) Get the name of the specified column
java.lang.String	getKeyPathForColumn(int column) Get the key path for the specified model column
RecordType	getRecordAtRow(int row) Get the record at the specified row index
int	getRowCount() Get the number of rows to display
java.util.List<RecordType>	getRowRecords() Get the records indexed by row
java.lang.Object	getValueAt(int row, int column) get the value for the specified cell
boolean	isCellEditable(int row, int column) Determine whether the cell is editable
void	removeKeyValueRecordListener(KeyValueRecordListener<KeyValueTableModel<RecordType>,RecordType> listener) Remove the specified listener from receiving record modification events from this instance.
void	setColumnClass(java.lang.String keyPath, java.lang.Class<?> columnClass) Set the column class for the specified column
void	setColumnClassForKeyPaths(java.lang.Class<?> columnClass, java.lang.String... keyPaths) Set the column class for the columns specified by the key paths
void	setColumnEditable(java.lang.String keyPath, boolean allowsEdit) Set whether the column associated with the specified key path is editable
void	setColumnEditKeyPath(java.lang.String columnKeyPath, java.lang.String editKeyPath) Set whether a cell associated with the specified column key path is editable based on the cell's record value corresponding to the specified edit key path
void	setColumnEditKeyPath(java.lang.String columnKeyPath, java.lang.String editKeyPath, boolean negation) Set whether a cell associated with the specified column key path is editable based on the cell's record value corresponding to the specified edit key path
void	setColumnName(java.lang.String keyPath, java.lang.String name) Set the name of the specified column
void	setDataSource(java.util.List<RecordType> records, java.lang.String... keyPaths) Set the records (row) and key paths (column accessors)
void	setKeyPaths(java.lang.String... keyPaths) Set the key paths (column accessors)
void	setRecords(java.util.List<RecordType> records) Set the records (row)
void	setValueAt(java.lang.Object value, int row, int column) Set the value of the specified cell

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

KEY_VALUE_ADAPTOR

protected final KeyValueAdaptor KEY_VALUE_ADAPTOR

key value adaptor to get the value from a record (row) for the specified key path (column property)

Constructor Detail

KeyValueTableModel

public KeyValueTableModel(java.util.List<RecordType> records,
                          java.lang.String... keyPaths)

Primary Constructor

Parameters:

records - the list of objects (one record for each table row)

keyPaths - specifies the array of key paths to get the data to display (one key path for each column)

KeyValueTableModel

public KeyValueTableModel()

Empty Constructor

Method Detail

addKeyValueRecordListener

public void addKeyValueRecordListener(KeyValueRecordListener<? extends KeyValueTableModel<RecordType>,RecordType> listener)

Add the specified listener as a receiver of record modification events from this instance.

Parameters:

listener - object to receive events

removeKeyValueRecordListener

public void removeKeyValueRecordListener(KeyValueRecordListener<KeyValueTableModel<RecordType>,RecordType> listener)

Remove the specified listener from receiving record modification events from this instance.

Parameters:

listener - object to be removed from receiving events

setDataSource

public void setDataSource(java.util.List<RecordType> records,
                          java.lang.String... keyPaths)

Set the records (row) and key paths (column accessors)

Parameters:

records - the list of objects (one record for each table row)

keyPaths - specifies the array of key paths to get the data to display (one key path for each column)

getRecordAtRow

public RecordType getRecordAtRow(int row)

Get the record at the specified row index

getRowRecords

public java.util.List<RecordType> getRowRecords()

Get the records indexed by row

setRecords

public void setRecords(java.util.List<RecordType> records)

Set the records (row)

Parameters:

records - the list of objects (one record for each table row)

getKeyPathForColumn

public java.lang.String getKeyPathForColumn(int column)

Get the key path for the specified model column

Parameters:

column - model column for which to get the key path

Returns:

key path for the specified model column or null if the column is out of bounds

getColumnForKeyPath

public int getColumnForKeyPath(java.lang.String keyPath)

Get the model column for the specified key path

Parameters:

keyPath - key path to the specified column

Returns:

model column index for the specified key path or -1 if no match

setKeyPaths

public void setKeyPaths(java.lang.String... keyPaths)

Set the key paths (column accessors)

Parameters:

keyPaths - specifies the array of key paths to get the data to display (one key path for each column)

setColumnName

public void setColumnName(java.lang.String keyPath,
                          java.lang.String name)

Set the name of the specified column

Parameters:

keyPath - key path for which to assign the name

name - the new name to assign the column

getColumnName

public java.lang.String getColumnName(int column)

Get the name of the specified column

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

setColumnClass

public void setColumnClass(java.lang.String keyPath,
                           java.lang.Class<?> columnClass)

Set the column class for the specified column

Parameters:

keyPath - key path for which to assign the class

columnClass - the new class to assign the column

setColumnClassForKeyPaths

public void setColumnClassForKeyPaths(java.lang.Class<?> columnClass,
                                      java.lang.String... keyPaths)

Set the column class for the columns specified by the key paths

Parameters:

columnClass - the new class to assign the column

keyPaths - key paths for which to assign the class

getColumnClass

public java.lang.Class<?> getColumnClass(int column)

Get the data class for the specified column

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

getRowCount

public int getRowCount()

Get the number of rows to display

getColumnCount

public int getColumnCount()

Get the number of columns to display

setColumnEditable

public void setColumnEditable(java.lang.String keyPath,
                              boolean allowsEdit)

Set whether the column associated with the specified key path is editable

setColumnEditKeyPath

public void setColumnEditKeyPath(java.lang.String columnKeyPath,
                                 java.lang.String editKeyPath)

Set whether a cell associated with the specified column key path is editable based on the cell's record value corresponding to the specified edit key path

Parameters:

columnKeyPath - key path of the column for which the edit rule applies

editKeyPath - key path (applied to the row's record) whose corresponding value determines whether the cell (of the row's record) is editable

setColumnEditKeyPath

public void setColumnEditKeyPath(java.lang.String columnKeyPath,
                                 java.lang.String editKeyPath,
                                 boolean negation)

Set whether a cell associated with the specified column key path is editable based on the cell's record value corresponding to the specified edit key path

Parameters:

columnKeyPath - key path of the column for which the edit rule applies

editKeyPath - key path (applied to the row's record) whose corresponding value determines whether the cell (of the row's record) is editable

negation - indicates whether to reverse the boolean indication of the edit column

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Determine whether the cell is editable

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

getValueAt

public java.lang.Object getValueAt(int row,
                                   int column)

get the value for the specified cell

setValueAt

public void setValueAt(java.lang.Object value,
                       int row,
                       int column)

Set the value of the specified cell

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class javax.swing.table.AbstractTableModel