Module org.hsqldb

Class TableSorter

  • All Implemented Interfaces:, javax.swing.table.TableModel

    public class TableSorter
    extends javax.swing.table.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.

    Philip Milne, Brendon McLean, Dan van Enckevort, Parwinder Sekhon
    See Also:
    Serialized Form
    • Constructor Summary

      Constructor Description
      TableSorter​(javax.swing.table.TableModel tableModel)  
      TableSorter​(javax.swing.table.TableModel tableModel, javax.swing.table.JTableHeader tableHeader)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Class getColumnClass​(int column)  
      int getColumnCount()  
      java.lang.String getColumnName​(int column)  
      int getRowCount()  
      int getSortingStatus​(int column)  
      javax.swing.table.JTableHeader getTableHeader()  
      javax.swing.table.TableModel getTableModel()  
      java.lang.Object getValueAt​(int row, int column)  
      boolean isCellEditable​(int row, int column)  
      boolean isSorting()  
      int modelIndex​(int viewIndex)  
      void setColumnComparator​(java.lang.Class type, java.util.Comparator comparator)  
      void setSortingStatus​(int column, int status)  
      void setTableHeader​(javax.swing.table.JTableHeader tableHeader)  
      void setTableModel​(javax.swing.table.TableModel tableModel)  
      void setValueAt​(java.lang.Object aValue, int row, int column)  
      • 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

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail


        public static final java.util.Comparator COMPARABLE_COMPARATOR

        public static final java.util.Comparator LEXICAL_COMPARATOR
    • Constructor Detail

      • TableSorter

        public TableSorter()
      • TableSorter

        public TableSorter​(javax.swing.table.TableModel tableModel)
      • TableSorter

        public TableSorter​(javax.swing.table.TableModel tableModel,
                           javax.swing.table.JTableHeader tableHeader)
    • Method Detail

      • getTableModel

        public javax.swing.table.TableModel getTableModel()
      • setTableModel

        public void setTableModel​(javax.swing.table.TableModel tableModel)
      • getTableHeader

        public javax.swing.table.JTableHeader getTableHeader()
      • setTableHeader

        public void setTableHeader​(javax.swing.table.JTableHeader tableHeader)
      • isSorting

        public boolean isSorting()
      • getSortingStatus

        public int getSortingStatus​(int column)
      • setSortingStatus

        public void setSortingStatus​(int column,
                                     int status)
      • setColumnComparator

        public void setColumnComparator​(java.lang.Class type,
                                        java.util.Comparator comparator)
      • modelIndex

        public int modelIndex​(int viewIndex)
      • getRowCount

        public int getRowCount()
      • getColumnCount

        public int getColumnCount()
      • getColumnName

        public java.lang.String getColumnName​(int column)
        Specified by:
        getColumnName in interface javax.swing.table.TableModel
        getColumnName in class javax.swing.table.AbstractTableModel
      • getColumnClass

        public java.lang.Class getColumnClass​(int column)
        Specified by:
        getColumnClass in interface javax.swing.table.TableModel
        getColumnClass in class javax.swing.table.AbstractTableModel
      • isCellEditable

        public boolean isCellEditable​(int row,
                                      int column)
        Specified by:
        isCellEditable in interface javax.swing.table.TableModel
        isCellEditable in class javax.swing.table.AbstractTableModel
      • getValueAt

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

        public void setValueAt​(java.lang.Object aValue,
                               int row,
                               int column)
        Specified by:
        setValueAt in interface javax.swing.table.TableModel
        setValueAt in class javax.swing.table.AbstractTableModel