Package ca.odell.glazedlists.swing

Class TableComparatorChooser<E>

  • public class TableComparatorChooser<E>
extends AbstractTableComparatorChooser<E>
    A TableComparatorChooser is a tool that allows the user to sort a table by clicking on the table's headers. It requires that the JTables model is an AdvancedTableModel with a SortedList as a source.

    This class includes custom arrow icons that indicate the sort order. The icons used are chosen based on the current Swing look and feel. Icons are available for the following look and feels: Mac OS X, Metal, Windows.

    This class supports multiple sort strategies for each column, specified by having muliple comparators for each column. This may be useful when you want to sort a single column in either of two ways. For example, when sorting movie names, "The Phantom Menace" may be sorted under "T" for "The", or "P" for "Phantom".

    This class supports sorting multiple columns simultaneously. In this mode, the user clicks a first column to sort by, and then the user clicks subsequent columns. The list is sorted by the first column and ties are broken by the second column.

    If the AdvancedTableModel uses an AdvancedTableFormat, its AdvancedTableFormat.getColumnComparator(int) method will be used to populate the initial column Comparators.

    Author:
    Jesse Wilson
    See Also:
    Bug 4, Bug 31, Bug 391

    • Method Detail

      • install

        public static <E> TableComparatorChooser<E> install​(javax.swing.JTable table,
                                                    SortedList<E> sortedList,
                                                    java.lang.Object strategy,
                                                    TableFormat<? super E> tableFormat)
        Installs a new TableComparatorChooser that responds to clicks on the header of the specified table and uses them to sort the specified sortedList by delegating to the given strategy If at any time the table should no longer sort, the behaviour can be removed calling dispose() on the object returned by this method.

        This method makes no assumptions about the TableModel implementation that backs the JTable. As such, it requires the TableFormat as an explicit parameter and expects the TableFormat to be constant (i.e. never changes) for the life of the TableComparatorChooser.

        Parameters:
        table - the table with headers that can be clicked on
        tableFormat - the TableFormat providing the columns for the table
        sortedList - the sorted list to update
        strategy - an implementations of SortingStrategy, typically one of
        Returns:
        TableComparatorChooser object that is responsible for translating mouse clicks on the table header into sorting actions on the sortedList.

      • addSortActionListener

        public void addSortActionListener​(java.awt.event.ActionListener sortActionListener)
        Registers the specified ActionListener to receive notification whenever the JTable is sorted by this TableComparatorChooser.

      • removeSortActionListener

        public void removeSortActionListener​(java.awt.event.ActionListener sortActionListener)
        Deregisters the specified ActionListener to no longer receive action events.

      • createSortArrowHeaderRenderer

        public javax.swing.table.TableCellRenderer createSortArrowHeaderRenderer​(javax.swing.table.TableCellRenderer delegateRenderer)
        Decorates and returns the given delegateRenderer with functionality that attempts to install a sorting icon into the Component returned by the delegateRenderer. In particular, the delegateRenderer will be decorated with a sorting icon in one of two scenarios:
        • the delegateRenderer implements SortableRenderer - in this case setSortIcon is called on the delegateRenderer and it is expected to place the icon anywhere it desires on the Component it returns. This allows maximum flexibility when displaying the sort icon.
        • the Component returned by the delegateRenderer is a JLabel - in this case setIcon is called on the JLabel with the sort icon. This caters to the typical case when a DefaultTableCellRenderer is used as the delegateRenderer.
        If neither of these scenarios are true of the given delegateRenderer then no sort indicator arrows will be added to the renderer's component.
        Parameters:
        delegateRenderer - the TableCellRenderer acting as a table header renderer and to which a sort icon should be added
        Returns:
        a TableCellRenderer that attempts to decorate the given delegateRenderer with a sort icon

      • redetectComparator

        protected void redetectComparator​(java.util.Comparator<? super E> currentComparator)
        Examines the current Comparator of the SortedList and adds icons to the table header renderers in response.

        To do this, clicks are injected into each of the corresponding ColumnClickTrackers.

        Overrides:
        redetectComparator in class AbstractTableComparatorChooser<E>

      • isSortingMouseEvent

        protected boolean isSortingMouseEvent​(java.awt.event.MouseEvent e)
        Determines if the specified mouse event shall be handled by this TableComparatorChooser. The default implementation handles only clicks with the left mouse button. Extending classes can customize which mouse events the table comparator chooser responds to by overriding this method.

        As of 2005/12/20, this method is no longer called when the corresponding mouse press event was a popup trigger. In effect, if this is a right-click on Windows or a 'control-click' on the Mac.

        As of 2008/02/05, this method is no longer called when the Cursor over the JTableHeader indicates a column resize is expected to take place, rather than a change in sort.

      • setIconPath

        public static void setIconPath​(java.lang.String path)
        Set all TableComparatorChoosers to use the icons from the directory specified. The folder should contain the following eight icon files:
      • primary_sorted.png
      • secondary_sorted.png
      • primary_sorted_alternate.png
      • secondary_sorted_alternate.png
      • primary_sorted_alternate_reverse.png
      • secondary_sorted_alternate_reverse.png
      • primary_sorted_reverse.png
      • secondary_sorted_reverse.png

        Note that this path must be on the system classpath. It may be within a jar file.