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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	TableSorter.Arrow
private static class	TableSorter.Directive
private class	TableSorter.MouseHandler
private class	TableSorter.Row
private class	TableSorter.SortableHeaderRenderer
private class	TableSorter.TableModelHandler

Field Summary

Modifier and Type	Field and Description
public static final int	ASCENDING
private Map<K, V>	columnComparators
public static final Comparator<T>	COMPARABLE_COMPARATOR
public static final int	DESCENDING
private static TableSorter.Directive	EMPTY_DIRECTIVE
public static final Comparator<T>	LEXICAL_COMPARATOR
private int[]	modelToView
private MouseListener	mouseListener
public static final int	NOT_SORTED
private List<E>	sortingColumns
private JTableHeader	tableHeader
protected TableModel	tableModel
private TableModelListener	tableModelListener
private TableSorter.Row[]	viewToModel

Inherited from javax.swing.table.AbstractTableModel:: listenerList

Constructor Summary

Access	Constructor and Description
public	TableSorter()
public	TableSorter(TableModel tableModel)
public	TableSorter(TableModel tableModel, JTableHeader tableHeader)

Method Summary

Modifier and Type	Method and Description
private void	cancelSorting()
private void	clearSortingState()
public Class<T>	getColumnClass(int column) Overrides javax.swing.table.AbstractTableModel.getColumnClass. Implements javax.swing.table.TableModel.getColumnClass. Returns `Object.class` regardless of `columnIndex`.
public int	getColumnCount() Implements javax.swing.table.TableModel.getColumnCount. Returns the number of columns in the model.
public String	getColumnName(int column) Overrides javax.swing.table.AbstractTableModel.getColumnName. Implements javax.swing.table.TableModel.getColumnName. Returns a default name for the column using spreadsheet conventions: A, B, C, ...
protected Comparator<T>	getComparator(int column)
private TableSorter.Directive	getDirective(int column)
protected Icon	getHeaderRendererIcon(int column, int size)
private int[]	getModelToView()
public int	getRowCount() Implements javax.swing.table.TableModel.getRowCount. Returns the number of rows in the model.
public int	getSortingStatus(int column)
public JTableHeader	getTableHeader()
public TableModel	getTableModel()
public Object	getValueAt(int row, int column) Implements javax.swing.table.TableModel.getValueAt. Returns the value for the cell at `columnIndex` and `rowIndex`.
private TableSorter.Row[]	getViewToModel()
public boolean	isCellEditable(int row, int column) Overrides javax.swing.table.AbstractTableModel.isCellEditable. Implements javax.swing.table.TableModel.isCellEditable. Returns false.
public boolean	isSorting()
public int	modelIndex(int viewIndex)
public void	setColumnComparator(Class<T> type, Comparator<T> comparator)
public void	setSortingStatus(int column, int status)
public void	setTableHeader(JTableHeader tableHeader)
public void	setTableModel(TableModel tableModel)
public void	setValueAt(Object aValue, int row, int column) Overrides javax.swing.table.AbstractTableModel.setValueAt. Implements javax.swing.table.TableModel.setValueAt. This empty implementation is provided so users don't have to implement this method if their data model is not editable.
private void	sortingStatusChanged()

Inherited from javax.swing.table.AbstractTableModel:: addTableModelListener findColumn fireTableCellUpdated fireTableChanged fireTableDataChanged fireTableRowsDeleted fireTableRowsInserted fireTableRowsUpdated fireTableStructureChanged getListeners getTableModelListeners removeTableModelListener

Field Detail

ASCENDING	back to summary
public static final int ASCENDING

columnComparators	back to summary
private Map<K, V> columnComparators

COMPARABLE_COMPARATOR	back to summary
public static final Comparator<T> COMPARABLE_COMPARATOR

DESCENDING	back to summary
public static final int DESCENDING

EMPTY_DIRECTIVE	back to summary
private static TableSorter.Directive EMPTY_DIRECTIVE

LEXICAL_COMPARATOR	back to summary
public static final Comparator<T> LEXICAL_COMPARATOR

modelToView	back to summary
private int[] modelToView

mouseListener	back to summary
private MouseListener mouseListener

NOT_SORTED	back to summary
public static final int NOT_SORTED

sortingColumns	back to summary
private List<E> sortingColumns

tableHeader	back to summary
private JTableHeader tableHeader

tableModel	back to summary
protected TableModel tableModel

tableModelListener	back to summary
private TableModelListener tableModelListener

viewToModel	back to summary
private TableSorter.Row[] viewToModel

Constructor Detail

TableSorter	back to summary
public TableSorter()

TableSorter	back to summary
public TableSorter(TableModel tableModel)

TableSorter	back to summary
public TableSorter(TableModel tableModel, JTableHeader tableHeader)

Method Detail

cancelSorting	back to summary
private void cancelSorting()

clearSortingState	back to summary
private void clearSortingState()

getColumnClass back to summary

getColumnClass	back to summary
public Class<T> getColumnClass(int column) Overrides javax.swing.table.AbstractTableModel.getColumnClass. Implements javax.swing.table.TableModel.getColumnClass. Doc from javax.swing.table.AbstractTableModel.getColumnClass. Returns `Object.class` regardless of `columnIndex`.

public Class<T> getColumnClass(int column)

Overrides javax.swing.table.AbstractTableModel.getColumnClass.

Implements javax.swing.table.TableModel.getColumnClass.

Doc from javax.swing.table.AbstractTableModel.getColumnClass.

Returns Object.class regardless of columnIndex.

getColumnCount back to summary

getColumnCount	back to summary
public int getColumnCount() Implements javax.swing.table.TableModel.getColumnCount. Doc from javax.swing.table.TableModel.getColumnCount. Returns the number of columns in the model. A `JTable` uses this method to determine how many columns it should create and display by default.

public int getColumnCount()

Implements javax.swing.table.TableModel.getColumnCount.

Doc from javax.swing.table.TableModel.getColumnCount.

Returns the number of columns in the model. A JTable uses this method to determine how many columns it should create and display by default.

getColumnName back to summary

getColumnName	back to summary
public String getColumnName(int column) Overrides javax.swing.table.AbstractTableModel.getColumnName. Implements javax.swing.table.TableModel.getColumnName. Doc from javax.swing.table.AbstractTableModel.getColumnName. Returns a default name for the column using spreadsheet conventions: A, B, C, ... Z, AA, AB, etc. If `column` cannot be found, returns an empty string.

public String getColumnName(int column)

Overrides javax.swing.table.AbstractTableModel.getColumnName.

Implements javax.swing.table.TableModel.getColumnName.

Doc from javax.swing.table.AbstractTableModel.getColumnName.

Returns a default name for the column using spreadsheet conventions: A, B, C, ... Z, AA, AB, etc. If column cannot be found, returns an empty string.

getComparator	back to summary
protected Comparator<T> getComparator(int column)

getDirective	back to summary
private TableSorter.Directive getDirective(int column)

getHeaderRendererIcon	back to summary
protected Icon getHeaderRendererIcon(int column, int size)

getModelToView	back to summary
private int[] getModelToView()

getRowCount back to summary

getRowCount	back to summary
public int getRowCount() Implements javax.swing.table.TableModel.getRowCount. Doc from javax.swing.table.TableModel.getRowCount. Returns the number of rows in the model. A `JTable` uses this method to determine how many rows it should display. This method should be quick, as it is called frequently during rendering.

public int getRowCount()

Implements javax.swing.table.TableModel.getRowCount.

Doc from javax.swing.table.TableModel.getRowCount.

Returns the number of rows in the model. A JTable uses this method to determine how many rows it should display. This method should be quick, as it is called frequently during rendering.

getSortingStatus	back to summary
public int getSortingStatus(int column)

getTableHeader	back to summary
public JTableHeader getTableHeader()

getTableModel	back to summary
public TableModel getTableModel()

getValueAt back to summary

getValueAt	back to summary
public Object getValueAt(int row, int column) Implements javax.swing.table.TableModel.getValueAt. Doc from javax.swing.table.TableModel.getValueAt. Returns the value for the cell at `columnIndex` and `rowIndex`.

public Object getValueAt(int row, int column)

Implements javax.swing.table.TableModel.getValueAt.

Doc from javax.swing.table.TableModel.getValueAt.

Returns the value for the cell at columnIndex and rowIndex.

getViewToModel	back to summary
private TableSorter.Row[] getViewToModel()

isCellEditable	back to summary
public boolean isCellEditable(int row, int column) Overrides javax.swing.table.AbstractTableModel.isCellEditable. Implements javax.swing.table.TableModel.isCellEditable. Doc from javax.swing.table.AbstractTableModel.isCellEditable. Returns false. This is the default implementation for all cells.

isCellEditable

back to summary

public boolean isCellEditable(int row, int column)

Overrides javax.swing.table.AbstractTableModel.isCellEditable.

Implements javax.swing.table.TableModel.isCellEditable.

Doc from javax.swing.table.AbstractTableModel.isCellEditable.

Returns false. This is the default implementation for all cells.

isSorting	back to summary
public boolean isSorting()

modelIndex	back to summary
public int modelIndex(int viewIndex)

setColumnComparator	back to summary
public void setColumnComparator(Class<T> type, Comparator<T> comparator)

setSortingStatus	back to summary
public void setSortingStatus(int column, int status)

setTableHeader	back to summary
public void setTableHeader(JTableHeader tableHeader)

setTableModel	back to summary
public void setTableModel(TableModel tableModel)

setValueAt	back to summary
public void setValueAt(Object aValue, int row, int column) Overrides javax.swing.table.AbstractTableModel.setValueAt. Implements javax.swing.table.TableModel.setValueAt. Doc from javax.swing.table.AbstractTableModel.setValueAt. This empty implementation is provided so users don't have to implement this method if their data model is not editable.

setValueAt

back to summary

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

Overrides javax.swing.table.AbstractTableModel.setValueAt.

Implements javax.swing.table.TableModel.setValueAt.

Doc from javax.swing.table.AbstractTableModel.setValueAt.

This empty implementation is provided so users don't have to implement this method if their data model is not editable.

sortingStatusChanged	back to summary
private void sortingStatusChanged()

org.hsqldb.util back to summary

private Class TableSorter.Arrow

Class Inheritance

extends Object
implements Icon

java.lang.Object
org.hsqldb.util.TableSorter.Arrow

All Implemented Interfaces

javax.swing.Icon

Field Summary

Modifier and Type	Field and Description
private boolean	descending
private int	priority
private int	size

Constructor Summary

Access	Constructor and Description
public	Arrow(boolean descending, int size, int priority)

Method Summary

Modifier and Type	Method and Description
public int	getIconHeight() Implements javax.swing.Icon.getIconHeight. Returns the icon's height.
public int	getIconWidth() Implements javax.swing.Icon.getIconWidth. Returns the icon's width.
public void	paintIcon(Component c, Graphics g, int x, int y) Implements javax.swing.Icon.paintIcon. Draw the icon at the specified location.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

descending	back to summary
private boolean descending

priority	back to summary
private int priority

size	back to summary
private int size

Constructor Detail

Arrow	back to summary
public Arrow(boolean descending, int size, int priority)

Method Detail

getIconHeight

back to summary

public int getIconHeight()

Implements javax.swing.Icon.getIconHeight.

Doc from javax.swing.Icon.getIconHeight.

Returns the icon's height.

getIconWidth

back to summary

public int getIconWidth()

Implements javax.swing.Icon.getIconWidth.

Doc from javax.swing.Icon.getIconWidth.

Returns the icon's width.

paintIcon

back to summary

public void paintIcon(Component c, Graphics g, int x, int y)

Implements javax.swing.Icon.paintIcon.

Doc from javax.swing.Icon.paintIcon.

Draw the icon at the specified location. Icon implementations may use the Component argument to get properties useful for painting, e.g. the foreground or background color.

org.hsqldb.util back to summary

private Class TableSorter.Directive

Class Inheritance

extends Object

java.lang.Object
org.hsqldb.util.TableSorter.Directive

Field Summary

Modifier and Type	Field and Description
private int	column
private int	direction

Constructor Summary

Access	Constructor and Description
public	Directive(int column, int direction)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

column	back to summary
private int column

direction	back to summary
private int direction

Constructor Detail

Directive	back to summary
public Directive(int column, int direction)

org.hsqldb.util back to summary

private Class TableSorter.MouseHandler

Class Inheritance

extends MouseAdapter

java.lang.Object
java.awt.event.MouseAdapter
org.hsqldb.util.TableSorter.MouseHandler

Constructor Summary

Access	Constructor and Description
private	MouseHandler()

Method Summary

Modifier and Type	Method and Description
public void	mouseClicked(MouseEvent e) Overrides java.awt.event.MouseAdapter.mouseClicked. Implements java.awt.event.MouseListener.mouseClicked. Invoked when the mouse button has been clicked (pressed and released) on a component.

Inherited from java.awt.event.MouseAdapter:: mouseDragged mouseEntered mouseExited mouseMoved mousePressed mouseReleased mouseWheelMoved

Constructor Detail

MouseHandler	back to summary
private MouseHandler()

Method Detail

mouseClicked

back to summary

public void mouseClicked(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mouseClicked.

Implements java.awt.event.MouseListener.mouseClicked.

Doc from java.awt.event.MouseAdapter.mouseClicked.

Invoked when the mouse button has been clicked (pressed and released) on a component.

org.hsqldb.util back to summary

private Class TableSorter.Row

Class Inheritance

extends Object
implements Comparable

java.lang.Object
org.hsqldb.util.TableSorter.Row

All Implemented Interfaces

java.lang.Comparable

Field Summary

Modifier and Type	Field and Description
private int	modelIndex

Constructor Summary

Access	Constructor and Description
public	Row(int index)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(Object o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

modelIndex	back to summary
private int modelIndex

Constructor Detail

Row	back to summary
public Row(int index)

Method Detail

compareTo back to summary

public int compareTo(Object o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

org.hsqldb.util back to summary

private Class TableSorter.SortableHeaderRenderer

Class Inheritance

extends Object
implements TableCellRenderer

java.lang.Object
org.hsqldb.util.TableSorter.SortableHeaderRenderer

All Implemented Interfaces

javax.swing.table.TableCellRenderer

Field Summary

Modifier and Type	Field and Description
private TableCellRenderer	tableCellRenderer

Constructor Summary

Access	Constructor and Description
public	SortableHeaderRenderer(TableCellRenderer tableCellRenderer)

Method Summary

Modifier and Type	Method and Description
public Component	getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) Implements javax.swing.table.TableCellRenderer.getTableCellRendererComponent. Returns the component used for drawing the cell.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

tableCellRenderer	back to summary
private TableCellRenderer tableCellRenderer

Constructor Detail

SortableHeaderRenderer	back to summary
public SortableHeaderRenderer(TableCellRenderer tableCellRenderer)

Method Detail

getTableCellRendererComponent back to summary

public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)

Implements javax.swing.table.TableCellRenderer.getTableCellRendererComponent.

Doc from javax.swing.table.TableCellRenderer.getTableCellRendererComponent.

Returns the component used for drawing the cell. This method is used to configure the renderer appropriately before drawing.

The TableCellRenderer is also responsible for rendering the the cell representing the table's current DnD drop location if it has one. If this renderer cares about rendering the DnD drop location, it should query the table directly to see if the given row and column represent the drop location:

    JTable.DropLocation dropLocation = table.getDropLocation();
    if (dropLocation != null
            && !dropLocation.isInsertRow()
            && !dropLocation.isInsertColumn()
            && dropLocation.getRow() == row
            && dropLocation.getColumn() == column) {

        // this cell represents the current drop location
        // so render it specially, perhaps with a different color
    }

During a printing operation, this method will be called with isSelected and hasFocus values of false to prevent selection and focus from appearing in the printed output. To do other customization based on whether or not the table is being printed, check the return value from javax.swing.JComponent#isPaintingForPrint().

org.hsqldb.util back to summary

private Class TableSorter.TableModelHandler

Class Inheritance

extends Object
implements TableModelListener

java.lang.Object
org.hsqldb.util.TableSorter.TableModelHandler

All Implemented Interfaces

javax.swing.event.TableModelListener, java.util.EventListener

Constructor Summary

Access	Constructor and Description
private	TableModelHandler()

Method Summary

Modifier and Type	Method and Description
public void	tableChanged(TableModelEvent e) Implements javax.swing.event.TableModelListener.tableChanged. This fine grain notification tells listeners the exact range of cells, rows, or columns that changed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

TableModelHandler	back to summary
private TableModelHandler()

Method Detail

tableChanged

back to summary

public void tableChanged(TableModelEvent e)

Implements javax.swing.event.TableModelListener.tableChanged.

Doc from javax.swing.event.TableModelListener.tableChanged.

This fine grain notification tells listeners the exact range of cells, rows, or columns that changed.

public Class TableSorter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TableSorter.Arrow

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TableSorter.Directive

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class TableSorter.MouseHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class TableSorter.Row

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TableSorter.SortableHeaderRenderer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TableSorter.TableModelHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail