Class TableSorter

  • All Implemented Interfaces:
    java.io.Serializable, 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.

    Version:
    2.0 02/27/04
    Author:
    Philip Milne, Brendon McLean, Dan van Enckevort, Parwinder Sekhon
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ASCENDING
      Ascending sort order.
      static java.util.Comparator<java.lang.Object> COMPARABLE_COMAPRATOR
      Compares two objects that must implement Comparable (for a common T)
      static int DESCENDING
      Descending sort order.
      static java.util.Comparator<java.lang.Object> LEXICAL_COMPARATOR
      Compares alphebetically using toString()
      static int NOT_SORTED
      Unsorted sort order.
      protected javax.swing.table.TableModel tableModel  
      • Fields inherited from class javax.swing.table.AbstractTableModel

        listenerList
    • Constructor Summary

      Constructors 
      Constructor Description
      TableSorter()
      Creates a Table Sorter without model.
      TableSorter​(javax.swing.table.TableModel tableModel)
      Creates a Table Sorter with specified model.
      TableSorter​(javax.swing.table.TableModel tableModel, javax.swing.table.JTableHeader tableHeader)
      Creates a TableSorter with specified model and header.
    • 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)  
      protected java.util.Comparator<java.lang.Object> getComparator​(int column)  
      protected javax.swing.Icon getHeaderRendererIcon​(int column, int size)  
      int getRowCount()  
      int getSortingStatus​(int column)
      Returns how the specified column is sorted.
      javax.swing.table.JTableHeader getTableHeader()
      Returns the table header
      javax.swing.table.TableModel getTableModel()
      Returns this sorter's model
      java.lang.Object getValueAt​(int row, int column)  
      boolean isCellEditable​(int row, int column)  
      boolean isSorting()
      Returns true if this sorter is sorting for at least one column.
      int modelIndex​(int viewIndex)
      Returns the row number in the model corresponding to the specified row index of the view.
      void setColumnComparator​(java.lang.Class<?> type, java.util.Comparator<java.lang.Object> comparator)
      Changes the comparator used for sorting columns
      void setSortingStatus​(int column, int status)
      Changes the sorting status of a column.
      void setTableHeader​(javax.swing.table.JTableHeader tableHeader)
      Changes the table header.
      void setTableModel​(javax.swing.table.TableModel tableModel)
      Changes the table model calls AbstractTableModel.fireTableStructureChanged().
      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

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

      • tableModel

        protected javax.swing.table.TableModel tableModel
      • COMPARABLE_COMAPRATOR

        public static final java.util.Comparator<java.lang.Object> COMPARABLE_COMAPRATOR
        Compares two objects that must implement Comparable (for a common T)
      • LEXICAL_COMPARATOR

        public static final java.util.Comparator<java.lang.Object> LEXICAL_COMPARATOR
        Compares alphebetically using toString()
    • Constructor Detail

      • TableSorter

        public TableSorter()
        Creates a Table Sorter without model.
      • TableSorter

        public TableSorter​(javax.swing.table.TableModel tableModel)
        Creates a Table Sorter with specified model.
      • TableSorter

        public TableSorter​(javax.swing.table.TableModel tableModel,
                           javax.swing.table.JTableHeader tableHeader)
        Creates a TableSorter with specified model and header.
    • Method Detail

      • getTableModel

        public javax.swing.table.TableModel getTableModel()
        Returns this sorter's model
        Returns:
        the table model, null if none was set.
      • setTableModel

        public void setTableModel​(javax.swing.table.TableModel tableModel)
        Changes the table model calls AbstractTableModel.fireTableStructureChanged().
      • getTableHeader

        public javax.swing.table.JTableHeader getTableHeader()
        Returns the table header
        Returns:
        the table header or null if none was set.
      • setTableHeader

        public void setTableHeader​(javax.swing.table.JTableHeader tableHeader)
        Changes the table header.
        Parameters:
        tableHeader - The new header
      • isSorting

        public boolean isSorting()
        Returns true if this sorter is sorting for at least one column.
        Returns:
        true if a sorting column has been set
      • getSortingStatus

        public int getSortingStatus​(int column)
        Returns how the specified column is sorted.
        Parameters:
        column - A column number betwwen 0 and (number of columns -1)
        Returns:
        The sorting mode of the column, one of ASCENDING, DESCENDING, or NOT_SORTED
      • setSortingStatus

        public void setSortingStatus​(int column,
                                     int status)
        Changes the sorting status of a column. Appends this column as last of the sorting columns!
        Parameters:
        column - A column number
        status - The new status
      • getHeaderRendererIcon

        protected javax.swing.Icon getHeaderRendererIcon​(int column,
                                                         int size)
      • setColumnComparator

        public void setColumnComparator​(java.lang.Class<?> type,
                                        java.util.Comparator<java.lang.Object> comparator)
        Changes the comparator used for sorting columns
        Parameters:
        type - A column class
        comparator - The new comparator for sorting columns of this type
      • getComparator

        protected java.util.Comparator<java.lang.Object> getComparator​(int column)
      • modelIndex

        public int modelIndex​(int viewIndex)
        Returns the row number in the model corresponding to the specified row index of the view.
        Parameters:
        viewIndex - A row number
        Returns:
        The corresponding row of the model
      • 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
        Overrides:
        getColumnName in class javax.swing.table.AbstractTableModel
      • getColumnClass

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

        public boolean isCellEditable​(int row,
                                      int column)
        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)
      • setValueAt

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