2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
\r
3 * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
\r
5 * This file is part of Jalview.
\r
7 * Jalview is free software: you can redistribute it and/or
\r
8 * modify it under the terms of the GNU General Public License
\r
9 * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
\r
11 * Jalview is distributed in the hope that it will be useful, but
\r
12 * WITHOUT ANY WARRANTY; without even the implied warranty
\r
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
\r
14 * PURPOSE. See the GNU General Public License for more details.
\r
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
\r
18 package jalview.util;
\r
21 import java.util.List;
\r
24 import java.awt.event.*;
\r
25 import javax.swing.*;
\r
26 import javax.swing.event.*;
\r
27 import javax.swing.table.*;
\r
30 * TableSorter is a decorator for TableModels; adding sorting functionality to a
\r
31 * supplied TableModel. TableSorter does not store or copy the data in its
\r
32 * TableModel; instead it maintains a map from the row indexes of the view to
\r
33 * the row indexes of the model. As requests are made of the sorter (like
\r
34 * getValueAt(row, col)) they are passed to the underlying model after the row
\r
35 * numbers have been translated via the internal mapping array. This way, the
\r
36 * TableSorter appears to hold another copy of the table with the rows in a
\r
39 * TableSorter registers itself as a listener to the underlying model, just as
\r
40 * the JTable itself would. Events recieved from the model are examined,
\r
41 * sometimes manipulated (typically widened), and then passed on to the
\r
42 * TableSorter's listeners (typically the JTable). If a change to the model has
\r
43 * invalidated the order of TableSorter's rows, a note of this is made and the
\r
44 * sorter will resort the rows the next time a value is requested.
\r
46 * When the tableHeader property is set, either by using the setTableHeader()
\r
47 * method or the two argument constructor, the table header may be used as a
\r
48 * complete UI for TableSorter. The default renderer of the tableHeader is
\r
49 * decorated with a renderer that indicates the sorting status of each column.
\r
50 * In addition, a mouse listener is installed with the following behavior:
\r
52 * <li>Mouse-click: Clears the sorting status of all other columns and advances
\r
53 * the sorting status of that column through three values: {NOT_SORTED,
\r
54 * ASCENDING, DESCENDING} (then back to NOT_SORTED again).
\r
55 * <li>SHIFT-mouse-click: Clears the sorting status of all other columns and
\r
56 * cycles the sorting status of the column through the same three values, in the
\r
57 * opposite order: {NOT_SORTED, DESCENDING, ASCENDING}.
\r
58 * <li>CONTROL-mouse-click and CONTROL-SHIFT-mouse-click: as above except that
\r
59 * the changes to the column do not cancel the statuses of columns that are
\r
60 * already sorting - giving a way to initiate a compound sort.
\r
63 * This is a long overdue rewrite of a class of the same name that first
\r
64 * appeared in the swing table demos in 1997.
\r
66 * @author Philip Milne
\r
67 * @author Brendon McLean
\r
68 * @author Dan van Enckevort
\r
69 * @author Parwinder Sekhon
\r
70 * @version 2.0 02/27/04
\r
73 public class TableSorter extends AbstractTableModel
\r
75 protected TableModel tableModel;
\r
77 public static final int DESCENDING = -1;
\r
79 public static final int NOT_SORTED = 0;
\r
81 public static final int ASCENDING = 1;
\r
83 private static Directive EMPTY_DIRECTIVE = new Directive(-1, NOT_SORTED);
\r
85 public static final Comparator COMPARABLE_COMAPRATOR = new Comparator()
\r
87 public int compare(Object o1, Object o2)
\r
89 return ((Comparable) o1).compareTo(o2);
\r
93 public static final Comparator LEXICAL_COMPARATOR = new Comparator()
\r
95 public int compare(Object o1, Object o2)
\r
97 return o1.toString().compareTo(o2.toString());
\r
101 private Row[] viewToModel;
\r
103 private int[] modelToView;
\r
105 private JTableHeader tableHeader;
\r
107 private MouseListener mouseListener;
\r
109 private TableModelListener tableModelListener;
\r
111 private Map columnComparators = new HashMap();
\r
113 private List sortingColumns = new ArrayList();
\r
115 public TableSorter()
\r
117 this.mouseListener = new MouseHandler();
\r
118 this.tableModelListener = new TableModelHandler();
\r
121 public TableSorter(TableModel tableModel)
\r
124 setTableModel(tableModel);
\r
127 public TableSorter(TableModel tableModel, JTableHeader tableHeader)
\r
130 setTableHeader(tableHeader);
\r
131 setTableModel(tableModel);
\r
134 private void clearSortingState()
\r
136 viewToModel = null;
\r
137 modelToView = null;
\r
140 public TableModel getTableModel()
\r
145 public void setTableModel(TableModel tableModel)
\r
147 if (this.tableModel != null)
\r
149 this.tableModel.removeTableModelListener(tableModelListener);
\r
152 this.tableModel = tableModel;
\r
153 if (this.tableModel != null)
\r
155 this.tableModel.addTableModelListener(tableModelListener);
\r
158 clearSortingState();
\r
159 fireTableStructureChanged();
\r
162 public JTableHeader getTableHeader()
\r
164 return tableHeader;
\r
167 public void setTableHeader(JTableHeader tableHeader)
\r
169 if (this.tableHeader != null)
\r
171 this.tableHeader.removeMouseListener(mouseListener);
\r
172 TableCellRenderer defaultRenderer = this.tableHeader
\r
173 .getDefaultRenderer();
\r
174 if (defaultRenderer instanceof SortableHeaderRenderer)
\r
177 .setDefaultRenderer(((SortableHeaderRenderer) defaultRenderer).tableCellRenderer);
\r
180 this.tableHeader = tableHeader;
\r
181 if (this.tableHeader != null)
\r
183 this.tableHeader.addMouseListener(mouseListener);
\r
184 this.tableHeader.setDefaultRenderer(new SortableHeaderRenderer(
\r
185 this.tableHeader.getDefaultRenderer()));
\r
189 public boolean isSorting()
\r
191 return sortingColumns.size() != 0;
\r
194 private Directive getDirective(int column)
\r
196 for (int i = 0; i < sortingColumns.size(); i++)
\r
198 Directive directive = (Directive) sortingColumns.get(i);
\r
199 if (directive.column == column)
\r
204 return EMPTY_DIRECTIVE;
\r
207 public int getSortingStatus(int column)
\r
209 return getDirective(column).direction;
\r
212 private void sortingStatusChanged()
\r
214 clearSortingState();
\r
215 fireTableDataChanged();
\r
216 if (tableHeader != null)
\r
218 tableHeader.repaint();
\r
222 public void setSortingStatus(int column, int status)
\r
224 Directive directive = getDirective(column);
\r
225 if (directive != EMPTY_DIRECTIVE)
\r
227 sortingColumns.remove(directive);
\r
229 if (status != NOT_SORTED)
\r
231 sortingColumns.add(new Directive(column, status));
\r
233 sortingStatusChanged();
\r
236 protected Icon getHeaderRendererIcon(int column, int size)
\r
238 Directive directive = getDirective(column);
\r
239 if (directive == EMPTY_DIRECTIVE)
\r
243 return new Arrow(directive.direction == DESCENDING, size,
\r
244 sortingColumns.indexOf(directive));
\r
247 private void cancelSorting()
\r
249 sortingColumns.clear();
\r
250 sortingStatusChanged();
\r
253 public void setColumnComparator(Class type, Comparator comparator)
\r
255 if (comparator == null)
\r
257 columnComparators.remove(type);
\r
261 columnComparators.put(type, comparator);
\r
265 protected Comparator getComparator(int column)
\r
267 Class columnType = tableModel.getColumnClass(column);
\r
268 Comparator comparator = (Comparator) columnComparators.get(columnType);
\r
269 if (comparator != null)
\r
273 if (Comparable.class.isAssignableFrom(columnType))
\r
275 return COMPARABLE_COMAPRATOR;
\r
277 return LEXICAL_COMPARATOR;
\r
280 private Row[] getViewToModel()
\r
282 if (viewToModel == null)
\r
284 int tableModelRowCount = tableModel.getRowCount();
\r
285 viewToModel = new Row[tableModelRowCount];
\r
286 for (int row = 0; row < tableModelRowCount; row++)
\r
288 viewToModel[row] = new Row(row);
\r
293 Arrays.sort(viewToModel);
\r
296 return viewToModel;
\r
299 public int modelIndex(int viewIndex)
\r
301 return getViewToModel()[viewIndex].modelIndex;
\r
304 private int[] getModelToView()
\r
306 if (modelToView == null)
\r
308 int n = getViewToModel().length;
\r
309 modelToView = new int[n];
\r
310 for (int i = 0; i < n; i++)
\r
312 modelToView[modelIndex(i)] = i;
\r
315 return modelToView;
\r
318 // TableModel interface methods
\r
320 public int getRowCount()
\r
322 return (tableModel == null) ? 0 : tableModel.getRowCount();
\r
325 public int getColumnCount()
\r
327 return (tableModel == null) ? 0 : tableModel.getColumnCount();
\r
330 public String getColumnName(int column)
\r
332 return tableModel.getColumnName(column);
\r
335 public Class getColumnClass(int column)
\r
337 return tableModel.getColumnClass(column);
\r
340 public boolean isCellEditable(int row, int column)
\r
342 return tableModel.isCellEditable(modelIndex(row), column);
\r
345 public Object getValueAt(int row, int column)
\r
347 return tableModel.getValueAt(modelIndex(row), column);
\r
350 public void setValueAt(Object aValue, int row, int column)
\r
352 tableModel.setValueAt(aValue, modelIndex(row), column);
\r
357 private class Row implements Comparable
\r
359 private int modelIndex;
\r
361 public Row(int index)
\r
363 this.modelIndex = index;
\r
366 public int compareTo(Object o)
\r
368 int row1 = modelIndex;
\r
369 int row2 = ((Row) o).modelIndex;
\r
371 for (Iterator it = sortingColumns.iterator(); it.hasNext();)
\r
373 Directive directive = (Directive) it.next();
\r
374 int column = directive.column;
\r
375 Object o1 = tableModel.getValueAt(row1, column);
\r
376 Object o2 = tableModel.getValueAt(row2, column);
\r
378 int comparison = 0;
\r
379 // Define null less than everything, except null.
\r
380 if (o1 == null && o2 == null)
\r
384 else if (o1 == null)
\r
388 else if (o2 == null)
\r
394 comparison = getComparator(column).compare(o1, o2);
\r
396 if (comparison != 0)
\r
398 return directive.direction == DESCENDING ? -comparison
\r
406 private class TableModelHandler implements TableModelListener
\r
408 public void tableChanged(TableModelEvent e)
\r
410 // If we're not sorting by anything, just pass the event along.
\r
413 clearSortingState();
\r
414 fireTableChanged(e);
\r
418 // If the table structure has changed, cancel the sorting; the
\r
419 // sorting columns may have been either moved or deleted from
\r
421 if (e.getFirstRow() == TableModelEvent.HEADER_ROW)
\r
424 fireTableChanged(e);
\r
428 // We can map a cell event through to the view without widening
\r
429 // when the following conditions apply:
\r
431 // a) all the changes are on one row (e.getFirstRow() == e.getLastRow())
\r
433 // b) all the changes are in one column (column !=
\r
434 // TableModelEvent.ALL_COLUMNS) and,
\r
435 // c) we are not sorting on that column (getSortingStatus(column) ==
\r
436 // NOT_SORTED) and,
\r
437 // d) a reverse lookup will not trigger a sort (modelToView != null)
\r
439 // Note: INSERT and DELETE events fail this test as they have column ==
\r
442 // The last check, for (modelToView != null) is to see if modelToView
\r
443 // is already allocated. If we don't do this check; sorting can become
\r
444 // a performance bottleneck for applications where cells
\r
445 // change rapidly in different parts of the table. If cells
\r
446 // change alternately in the sorting column and then outside of
\r
447 // it this class can end up re-sorting on alternate cell updates -
\r
448 // which can be a performance problem for large tables. The last
\r
449 // clause avoids this problem.
\r
450 int column = e.getColumn();
\r
451 if (e.getFirstRow() == e.getLastRow()
\r
452 && column != TableModelEvent.ALL_COLUMNS
\r
453 && getSortingStatus(column) == NOT_SORTED
\r
454 && modelToView != null)
\r
456 int viewIndex = getModelToView()[e.getFirstRow()];
\r
457 fireTableChanged(new TableModelEvent(TableSorter.this, viewIndex,
\r
458 viewIndex, column, e.getType()));
\r
462 // Something has happened to the data that may have invalidated the row
\r
464 clearSortingState();
\r
465 fireTableDataChanged();
\r
470 private class MouseHandler extends MouseAdapter
\r
472 public void mouseClicked(MouseEvent e)
\r
474 JTableHeader h = (JTableHeader) e.getSource();
\r
475 TableColumnModel columnModel = h.getColumnModel();
\r
476 int viewColumn = columnModel.getColumnIndexAtX(e.getX());
\r
477 int column = columnModel.getColumn(viewColumn).getModelIndex();
\r
480 int status = getSortingStatus(column);
\r
481 if (!e.isControlDown())
\r
485 // Cycle the sorting states through {NOT_SORTED, ASCENDING, DESCENDING}
\r
487 // {NOT_SORTED, DESCENDING, ASCENDING} depending on whether shift is
\r
489 status = status + (e.isShiftDown() ? -1 : 1);
\r
490 status = (status + 4) % 3 - 1; // signed mod, returning {-1, 0, 1}
\r
491 setSortingStatus(column, status);
\r
496 private static class Arrow implements Icon
\r
498 private boolean descending;
\r
502 private int priority;
\r
504 public Arrow(boolean descending, int size, int priority)
\r
506 this.descending = descending;
\r
508 this.priority = priority;
\r
511 public void paintIcon(Component c, Graphics g, int x, int y)
\r
513 Color color = c == null ? Color.GRAY : c.getBackground();
\r
514 // In a compound sort, make each succesive triangle 20%
\r
515 // smaller than the previous one.
\r
516 int dx = (int) (size / 2 * Math.pow(0.8, priority));
\r
517 int dy = descending ? dx : -dx;
\r
518 // Align icon (roughly) with font baseline.
\r
519 y = y + 5 * size / 6 + (descending ? -dy : 0);
\r
520 int shift = descending ? 1 : -1;
\r
524 g.setColor(color.darker());
\r
525 g.drawLine(dx / 2, dy, 0, 0);
\r
526 g.drawLine(dx / 2, dy + shift, 0, shift);
\r
529 g.setColor(color.brighter());
\r
530 g.drawLine(dx / 2, dy, dx, 0);
\r
531 g.drawLine(dx / 2, dy + shift, dx, shift);
\r
533 // Horizontal line.
\r
536 g.setColor(color.darker().darker());
\r
540 g.setColor(color.brighter().brighter());
\r
542 g.drawLine(dx, 0, 0, 0);
\r
545 g.translate(-x, -y);
\r
548 public int getIconWidth()
\r
553 public int getIconHeight()
\r
559 private class SortableHeaderRenderer implements TableCellRenderer
\r
561 private TableCellRenderer tableCellRenderer;
\r
563 public SortableHeaderRenderer(TableCellRenderer tableCellRenderer)
\r
565 this.tableCellRenderer = tableCellRenderer;
\r
568 public Component getTableCellRendererComponent(JTable table,
\r
569 Object value, boolean isSelected, boolean hasFocus, int row,
\r
572 Component c = tableCellRenderer.getTableCellRendererComponent(table,
\r
573 value, isSelected, hasFocus, row, column);
\r
574 if (c instanceof JLabel)
\r
576 JLabel l = (JLabel) c;
\r
577 l.setHorizontalTextPosition(JLabel.LEFT);
\r
578 int modelColumn = table.convertColumnIndexToModel(column);
\r
579 l.setIcon(getHeaderRendererIcon(modelColumn, l.getFont().getSize()));
\r
585 private static class Directive
\r
587 private int column;
\r
589 private int direction;
\r
591 public Directive(int column, int direction)
\r
593 this.column = column;
\r
594 this.direction = direction;
\r