AbstractTableSorter (Commons Library 1.04 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

hoplugins.commons.ui.sorter
Class AbstractTableSorter

java.lang.Object
  javax.swing.table.AbstractTableModel
      hoplugins.commons.ui.sorter.AbstractTableSorter

All Implemented Interfaces:: java.io.Serializable, javax.swing.table.TableModel

Direct Known Subclasses:: DefaultTableSorter

public abstract class AbstractTableSorter
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
`static int`	`ASCENDING` TODO Missing Parameter Documentation
`static java.util.Comparator`	`COMPARABLE_COMAPRATOR` TODO Missing Parameter Documentation
`static int`	`DESCENDING` TODO Missing Parameter Documentation
`static java.util.Comparator`	`LEXICAL_COMPARATOR` TODO Missing Parameter Documentation
`static int`	`NOT_SORTED` TODO Missing Parameter Documentation
`protected javax.swing.table.TableModel`	`tableModel` TODO Missing Parameter Documentation

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary
`AbstractTableSorter()` Creates a new TableSorter object.
`AbstractTableSorter(javax.swing.table.TableModel tableModel)` Creates a new TableSorter object.
`AbstractTableSorter(javax.swing.table.TableModel tableModel, javax.swing.table.JTableHeader tableHeader)` Creates a new TableSorter object.

Method Summary
`protected void`	`cancelSorting()`
`java.lang.Class`	`getColumnClass(int column)` DOCUMENT ME!
`int`	`getColumnCount()` DOCUMENT ME!
`java.lang.String`	`getColumnName(int column)` DOCUMENT ME!
`protected java.util.Comparator`	`getComparator(int column)` DOCUMENT ME!
`abstract java.util.Comparator`	`getCustomComparator(int column)` DOCUMENT ME!
`protected javax.swing.Icon`	`getHeaderRendererIcon(int column, int size)` DOCUMENT ME!
`int`	`getRowCount()`
`java.util.List`	`getSortingColumns()` DOCUMENT ME!
`int`	`getSortingStatus(int column)` DOCUMENT ME!
`javax.swing.table.JTableHeader`	`getTableHeader()` DOCUMENT ME!
`javax.swing.table.TableModel`	`getTableModel()` DOCUMENT ME!
`java.lang.Object`	`getValueAt(int row, int column)` DOCUMENT ME!
`abstract boolean`	`hasHeaderLine()` DOCUMENT ME!
`boolean`	`isCellEditable(int row, int column)` DOCUMENT ME!
`boolean`	`isSorting()` DOCUMENT ME!
`abstract int`	`minSortableColumn()` DOCUMENT ME!
`int`	`modelIndex(int viewIndex)` DOCUMENT ME!
`void`	`setColumnComparator(java.lang.Class type, java.util.Comparator comparator)` DOCUMENT ME!
`void`	`setSortingStatus(int column, int status)` DOCUMENT ME!
`void`	`setTableHeader(javax.swing.table.JTableHeader tableHeader)` DOCUMENT ME!
`void`	`setTableModel(javax.swing.table.TableModel tableModel)` DOCUMENT ME!
`void`	`setValueAt(java.lang.Object aValue, int row, int column)` DOCUMENT ME!

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