org.tbee.swing.table
Class TableSorter

java.lang.Object
  javax.swing.table.AbstractTableModel
      org.tbee.swing.table.AbstractTableModel
          org.tbee.swing.table.TableSorter

All Implemented Interfaces:

Serializable, TableModel

Direct Known Subclasses:

TableSorterForEdit

public class TableSorter
extends AbstractTableModel

TableSorter is a decorator for TableModels; adding sorting functionality to a supplied TableModel. TableSorter does not store or copy the data in its TableModel; instead it maintains a map from the row indexes of the view to the row indexes of the model. As requests are made of the sorter (like getValueAt(row, col)) they are passed to the underlying model after the row numbers have been translated via the internal mapping array. This way, the TableSorter appears to hold another copy of the table with the rows in a different order.

TableSorter registers itself as a listener to the underlying model, just as the JTable itself would. Events recieved from the model are examined, sometimes manipulated (typically widened), and then passed on to the TableSorter's listeners (typically the JTable). If a change to the model has invalidated the order of TableSorter's rows, a note of this is made and the sorter will resort the rows the next time a value is requested.

When the tableHeader property is set, either by using the setTableHeader() method or the two argument constructor, the table header may be used as a complete UI for TableSorter. The default renderer of the tableHeader is decorated with a renderer that indicates the sorting status of each column. In addition, a mouse listener is installed with the following behavior:

• Mouse-click: Clears the sorting status of all other columns and advances the sorting status of that column through three values: {NOT_SORTED, ASCENDING, DESCENDING} (then back to NOT_SORTED again).
• SHIFT-mouse-click: Clears the sorting status of all other columns and cycles the sorting status of the column through the same three values, in the opposite order: {NOT_SORTED, DESCENDING, ASCENDING}.
• CONTROL-mouse-click and CONTROL-SHIFT-mouse-click: as above except that the changes to the column do not cancel the statuses of columns that are already sorting - giving a way to initiate a compound sort.

This is a long overdue rewrite of a class of the same name that first appeared in the swing table demos in 1997. Beware: Because the TableSorter links a table header index with the column index of the table model it is sorting, it must be the outer TableModel wrapper (at least of the TableModels that add columns). TableSorter also is aware of the RowNr class and handles it specially (by not sorting it).

Version:

2.0 02/27/04

Author:

Philip Milne, Brendon McLean, Dan van Enckevort, Parwinder Sekhon

See Also:

Serialized Form

Nested Class Summary

class

TableSorter.TableSorterJPopupMenu To be able to differentiate this popup menu from the rest (e.g.

Field Summary

static int	ASCENDING
static Comparator	COMPARABLE_COMPARATOR
static int	DESCENDING
static Comparator	LEXICAL_COMPARATOR
protected int[]	modelToView
static int	NOT_SORTED
static String	SOURCECODE_VERSION Standard variable for determining version of a class file.
protected TableModel	tableModel
protected org.tbee.swing.table.TableSorter.Row[]	viewToModel

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

TableSorter()

TableSorter(TableModel tableModel)

TableSorter(TableModel tableModel, JTableHeader tableHeader)

Method Summary

void	addSortingStatus(int column, int status)
void	cancelSorting()
int	convertModelIndexToTableIndex(int idx)
int	convertRowIndexToModel(int idx)
int	convertTableIndexToModelIndex(int idx)
Class	getColumnClass(int column)
int	getColumnCount()
String	getColumnName(int column)
protected Comparator	getComparator(int column)
protected Icon	getHeaderRendererIcon(int column, int size)
int	getRowCount()
int	getSortingStatus(int column)
JTableHeader	getTableHeader()
TableModel	getTableModel()
String	getTooltipAt(int row, int column) Tooltip for a cell
Object	getValueAt(int row, int column)
boolean	isCellEditable(int row, int column)
boolean	isSorting()
int	modelIndex(int viewIndex)
void	setColumnComparator(Class type, Comparator comparator)
void	setSortingStatus(int column, int status)
void	setTable(JTable table)
void	setTableHeader(JTableHeader tableHeader)
void	setTableModel(TableModel tableModel)
void	setValueAt(Object aValue, int row, int column)
int	tableIndex(int modelIndex)

Methods inherited from class org.tbee.swing.table.AbstractTableModel

fireTableCellUpdatedInvokeAndWait, fireTableCellUpdatedInvokeLater, fireTableDataChangedInvokeAndWait, fireTableDataChangedInvokeLater

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

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, removeTableModelListener

Field Detail

SOURCECODE_VERSION

public static final String SOURCECODE_VERSION

Standard variable for determining version of a class file.

See Also:

Constant Field Values

tableModel

protected TableModel tableModel

DESCENDING

public static final int DESCENDING

See Also:

Constant Field Values

NOT_SORTED

public static final int NOT_SORTED

See Also:

Constant Field Values

ASCENDING

public static final int ASCENDING

See Also:

Constant Field Values

COMPARABLE_COMPARATOR

public static final Comparator COMPARABLE_COMPARATOR

LEXICAL_COMPARATOR

public static final Comparator LEXICAL_COMPARATOR

viewToModel

protected org.tbee.swing.table.TableSorter.Row[] viewToModel

modelToView

protected int[] modelToView

Constructor Detail

TableSorter

public TableSorter()

TableSorter

public TableSorter(TableModel tableModel)

TableSorter

public TableSorter(TableModel tableModel,
                   JTableHeader tableHeader)

Method Detail

getTableModel

public TableModel getTableModel()

setTableModel

public void setTableModel(TableModel tableModel)

getTableHeader

public JTableHeader getTableHeader()

setTable

public void setTable(JTable table)

setTableHeader

public void setTableHeader(JTableHeader tableHeader)

isSorting

public boolean isSorting()

getSortingStatus

public int getSortingStatus(int column)

setSortingStatus

public void setSortingStatus(int column,
                             int status)

addSortingStatus

public void addSortingStatus(int column,
                             int status)

getHeaderRendererIcon

protected Icon getHeaderRendererIcon(int column,
                                     int size)

cancelSorting

public void cancelSorting()

setColumnComparator

public void setColumnComparator(Class type,
                                Comparator comparator)

getComparator

protected Comparator getComparator(int column)

modelIndex

public int modelIndex(int viewIndex)

convertRowIndexToModel

public int convertRowIndexToModel(int idx)

convertTableIndexToModelIndex

public int convertTableIndexToModelIndex(int idx)

tableIndex

public int tableIndex(int modelIndex)

convertModelIndexToTableIndex

public int convertModelIndexToTableIndex(int idx)

getRowCount

public int getRowCount()

getColumnCount

public int getColumnCount()

getColumnName

public String getColumnName(int column)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getColumnClass

public Class getColumnClass(int column)

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

getValueAt

public Object getValueAt(int row,
                         int column)

getTooltipAt

public String getTooltipAt(int row,
                           int column)

Description copied from class: AbstractTableModel

Tooltip for a cell

Overrides:

getTooltipAt in class AbstractTableModel

setValueAt

public void setValueAt(Object aValue,
                       int row,
                       int column)

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel