org.midica.ui.model

Class MidicaTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

javax.swing.table.DefaultTableModel

org.midica.ui.model.MidicaTableModel

All Implemented Interfaces:

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

Direct Known Subclasses:

DrumkitTableModel, ExportResultTableModel, InstrumentTableModel, MessageTableModel, NoteHistoryTableModel, NoteTableModel, PercussionTableModel, SoundbankInstrumentsTableModel, SoundbankResourceTableModel, SoundcheckInstrumentModel, SoundcheckNoteModel, SyntaxTableModel

public abstract class MidicaTableModel
extends javax.swing.table.DefaultTableModel

This class represents the data model of most tables used in this project.

It supports a headline for each column. However the number and content of the columns and headlines has to be specified in the derived class.

This class also supports tooltip texts for table headers. By default, the column name is also used as the tooltip text. However the tooltips can be customized by the derived class by calling setHeaderToolTip(int, String).

Author:

Jan Trukenmüller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<?>[]	columnClasses
protected java.lang.String[]	columnNames
private java.util.TreeMap<java.lang.Integer,java.lang.String>	headerTooltips
private static long	serialVersionUID
protected java.lang.Boolean[]	sortableColumns

Fields inherited from class javax.swing.table.DefaultTableModel

columnIdentifiers, dataVector

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MidicaTableModel() Creates a new table model.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.util.HashMap<java.lang.String,?>>	getCategorizedHashMapRows() Returns null, if not overridden by a child model class.
java.util.ArrayList<CategorizedElement>	getCategorizedRows() Returns null, if not overridden by a child model class.
java.lang.Class<?>	getColumnClass(int colIndex) Returns the class of the column’s content.
int	getColumnCount() Returns the number of columns in the table.
java.lang.String	getColumnName(int index) Returns the column name according to the given index.
java.lang.String	getHeaderTooltip(int col) Returns the tooltip text of the specified column index.
abstract int	getRowCount() Returns the number of table rows.
abstract java.lang.Object	getValueAt(int rowIndex, int colIndex) Returns the value of the queried table cell.
boolean	isCellEditable(int row, int col) Returns always false because none of the table cells is editable.
boolean	isSortable(int colIndex) Indicates if the given column is sortable or not.
protected void	setHeaderToolTip(int col, java.lang.String tooltip) Sets the tooltip text of the given column index.

Methods inherited from class javax.swing.table.DefaultTableModel

addColumn, addColumn, addColumn, addRow, addRow, convertToVector, convertToVector, getDataVector, insertRow, insertRow, moveRow, newDataAvailable, newRowsAdded, removeRow, rowsRemoved, setColumnCount, setColumnIdentifiers, setColumnIdentifiers, setDataVector, setDataVector, setNumRows, setRowCount, setValueAt

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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

columnNames

protected java.lang.String[] columnNames

columnClasses

protected java.lang.Class<?>[] columnClasses

sortableColumns

protected java.lang.Boolean[] sortableColumns

headerTooltips

private java.util.TreeMap<java.lang.Integer,java.lang.String> headerTooltips

Constructor Detail

MidicaTableModel

protected MidicaTableModel()

Creates a new table model.

Method Detail

getColumnName

public java.lang.String getColumnName(int index)

Returns the column name according to the given index. All column names should be initialized in the constructor of the derived class.

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.DefaultTableModel

Parameters:

index - Table column index.

Returns:

Column name.

getHeaderTooltip

public java.lang.String getHeaderTooltip(int col)

Returns the tooltip text of the specified column index.

If there have not been set any custom tooltip using setHeaderToolTip(int, String), the colum name is returned.

Parameters:

col - The column index, beginning with 0.

Returns:

the tooltip text.

setHeaderToolTip

protected void setHeaderToolTip(int col,
                                java.lang.String tooltip)

Sets the tooltip text of the given column index.

Parameters:

col - The column index, beginning with 0.

tooltip - The tooltip text to be set.

getColumnCount

public int getColumnCount()

Returns the number of columns in the table. Same as the column names initialized by the constructor of the derived class.

Specified by:

getColumnCount in interface javax.swing.table.TableModel

Overrides:

getColumnCount in class javax.swing.table.DefaultTableModel

Returns:

Number of columns.

isCellEditable

public boolean isCellEditable(int row,
                              int col)

Returns always false because none of the table cells is editable.

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.DefaultTableModel

Parameters:

row - Queried row index.

col - Queried column index.

Returns:

false - always.

getRowCount

public abstract int getRowCount()

Returns the number of table rows.

Specified by:

getRowCount in interface javax.swing.table.TableModel

Overrides:

getRowCount in class javax.swing.table.DefaultTableModel

Returns:

Number of table rows.

getValueAt

public abstract java.lang.Object getValueAt(int rowIndex,
                                            int colIndex)

Returns the value of the queried table cell.

Specified by:

getValueAt in interface javax.swing.table.TableModel

Overrides:

getValueAt in class javax.swing.table.DefaultTableModel

Parameters:

rowIndex - Row index.

colIndex - Column index.

Returns:

Table cell value.

getColumnClass

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

Returns the class of the column’s content. Used for sorting.

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

Parameters:

colIndex - Column index.

Returns:

column class.

isSortable

public boolean isSortable(int colIndex)

Indicates if the given column is sortable or not. By default all columns are sortable. This can be changed if the field sortableColumns is changed by a derived model class.

Parameters:

colIndex - Column index.

Returns:

true, if the column is sortable, or otherwise false.

getCategorizedRows

public java.util.ArrayList<CategorizedElement> getCategorizedRows()

Returns null, if not overridden by a child model class. Can be overridden to return the underlying data list, if it contains categorized data. That’s needed for the sorter to be able to hide categories, if the sorting is different from the model’s default sorting.

Returns:

null, if not overridden.

getCategorizedHashMapRows

public java.util.ArrayList<java.util.HashMap<java.lang.String,?>> getCategorizedHashMapRows()

Returns null, if not overridden by a child model class. Can be overridden to return the underlying data list, if it contains categorized data. That’s needed for the sorter to be able to hide categories, if the sorting is different from the model’s default sorting.

Returns:

null, if not overridden.