NewTableSorter (CUF2 Parent Project 2.0.8 API)

java.lang.Object
- javax.swing.table.AbstractTableModel
- - net.sf.cuf.model.ui.NewTableSorter

All Implemented Interfaces:

Serializable, TableModel, IndexConverter
```
public class NewTableSorter
extends AbstractTableModel
implements IndexConverter
```
NewTableSorter is a decorator for TableModels; adding sorting functionality to a supplied TableModel. NewTableSorter 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 NewTableSorter appears to hold another copy of the table with the rows in a different order.
NewTableSorter 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 NewTableSorter's rows, a note of this is made and the sorter will resort the rows the next time a value is requested.
The NewTableSorter implements an IndexConverter IndexConverter, so the ListTableMapperBase ListTableMapperBase has access to the modelIndex of the sorted table for using them in the ListSelectionModel callback methods.
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 NewTableSorter. The default renderer of the tableHeader is decorated with a renderer that indicates the sorting status of a column. In addition, a mouse listener is installed with the following behavior:
- Mouse-click: Advances the sorting status of that column through three values: {NOT_SORTED, ASCENDING, DESCENDING} (then back to NOT_SORTED again). The column last clicked has the highest sorting priority, but the previous sortings are stable.
- SHIFT-mouse-click: 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 cancel the statuses of columns that are already sorting, so the table is sorted by only one column.
Any sorting will clear the selection in the table because the table reacts that way to the change event. If the sorting is initiated by the user (see the private inner class MouseHandler), we attempt to restore the selection for the new order afterwards. If that behaviour causes problem, it can be switched off by setRestoreSelectionAfterSort(false).
Version:

2.0 02/27/04
Taken originally from "The Java Tutorial" by Sun Microsystems. Modified by Andreas Schober, 10.05.2004, sd&m AG. Modified by Michael Brade, 08.05.2009, capgemini sd&m. Modified by Marco Berroth, 22.11.2011, msg-systems.

Author:

Philip Milne, Brendon McLean, Dan van Enckevort, Parwinder Sekhon

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ASCENDING`
`static Comparator`	`COMPARABLE_COMAPRATOR` static Comparable-Comparator
`static int`	`DESCENDING` sorting-status of a column
`static Comparator`	`LEXICAL_COMPARATOR` Static Lexical-Comparator with a special handling of String[]'s.
`protected TableModel`	`mTableModel` original TableModel
`static int`	`NOT_SORTED`

Fields inherited from class javax.swing.table.AbstractTableModel
listenerList

Constructor Summary

Constructors
Constructor and Description

NewTableSorter(TableModel pTableModel)

NewTableSorter(TableModel pTableModel, JTableHeader pTableHeader)

Constructors
Constructor and Description
`NewTableSorter(TableModel pTableModel)`
`NewTableSorter(TableModel pTableModel, JTableHeader pTableHeader)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearSortingState()`
`int`	`convert2ModelIndex(int pViewIndex)` This method converts the given view index of a table row to the corresponding model index of this row.
`int`	`convert2ViewIndex(int pModelIndex)` This method converts the given model index of a table row to the corresponding view index of this row.
`void`	`forceInitialSorting(int pColumn)` Provides programmatic acces to our sorting.
`Class`	`getColumnClass(int pColumn)`
`int`	`getColumnCount()`
`String`	`getColumnName(int pColumn)`
`protected Comparator`	`getComparator(int pColumn)`
`protected Icon`	`getHeaderRendererIcon(int pColumn, int pSize)`
`int`	`getRowCount()`
`int`	`getSortingStatus(int pColumn)`
`JTableHeader`	`getTableHeader()`
`TableModel`	`getTableModel()`
`Object`	`getValueAt(int pRow, int pColumn)`
`boolean`	`isAttemptRestoreSelectionAfterSort()`
`boolean`	`isCellEditable(int pRow, int pColumn)`
`boolean`	`isSorting()`
`int`	`modelIndex(int pViewIndex)`
`void`	`setAttemptRestoreSelectionAfterSort(boolean pAttemptRestoreSelectionAfterSort)`
`void`	`setColumnComparator(Class pType, Comparator pComparator)`
`void`	`setSortingStatus(int pColumn, int pStatus)`
`void`	`setTableHeader(JTableHeader pTableHeader)`
`void`	`setTableModel(TableModel pTableModel)`
`void`	`setValueAt(Object pValue, int pRow, int pColumn)`
`int`	`viewIndex(int pModelIndex)`

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
  - mTableModel
```
protected TableModel mTableModel
```
    original TableModel
  - DESCENDING
```
public static final int DESCENDING
```
    sorting-status of a column
    
    See Also:
    Constant Field Values
  - NOT_SORTED
```
public static final int NOT_SORTED
```
    See Also:
    Constant Field Values
  - ASCENDING
```
public static final int ASCENDING
```
    See Also:
    Constant Field Values
  - COMPARABLE_COMAPRATOR
```
public static final Comparator COMPARABLE_COMAPRATOR
```
    static Comparable-Comparator
  - LEXICAL_COMPARATOR
```
public static final Comparator LEXICAL_COMPARATOR
```
    Static Lexical-Comparator with a special handling of String[]'s.
- Constructor Detail
  - NewTableSorter
```
public NewTableSorter(TableModel pTableModel)
```
  - NewTableSorter
```
public NewTableSorter(TableModel pTableModel,
              JTableHeader pTableHeader)
```
- Method Detail
  - isAttemptRestoreSelectionAfterSort
```
public boolean isAttemptRestoreSelectionAfterSort()
```
  - setAttemptRestoreSelectionAfterSort
```
public void setAttemptRestoreSelectionAfterSort(boolean pAttemptRestoreSelectionAfterSort)
```
  - clearSortingState
```
public void clearSortingState()
```
  - getTableModel
```
public TableModel getTableModel()
```
  - setTableModel
```
public void setTableModel(TableModel pTableModel)
```
  - getTableHeader
```
public JTableHeader getTableHeader()
```
  - setTableHeader
```
public void setTableHeader(JTableHeader pTableHeader)
```
  - isSorting
```
public boolean isSorting()
```
  - getSortingStatus
```
public int getSortingStatus(int pColumn)
```
  - setSortingStatus
```
public void setSortingStatus(int pColumn,
                    int pStatus)
```
  - getHeaderRendererIcon
```
protected Icon getHeaderRendererIcon(int pColumn,
                         int pSize)
```
  - setColumnComparator
```
public void setColumnComparator(Class pType,
                       Comparator pComparator)
```
  - getComparator
```
protected Comparator getComparator(int pColumn)
```
  - modelIndex
```
public int modelIndex(int pViewIndex)
```
  - viewIndex
```
public int viewIndex(int pModelIndex)
```
  - forceInitialSorting
```
public void forceInitialSorting(int pColumn)
```
    Provides programmatic acces to our sorting.
    
    Parameters:
    pColumn - the column that should be sorted
  - convert2ModelIndex
```
public int convert2ModelIndex(int pViewIndex)
```
    Description copied from interface: IndexConverter
    
    This method converts the given view index of a table row to the corresponding model index of this row.
    
    Specified by:
    
    convert2ModelIndex in interface IndexConverter
    
    Parameters:
    pViewIndex - the view index
    
    Returns:
    the model index
  - convert2ViewIndex
```
public int convert2ViewIndex(int pModelIndex)
```
    Description copied from interface: IndexConverter
    
    This method converts the given model index of a table row to the corresponding view index of this row.
    
    Specified by:
    
    convert2ViewIndex in interface IndexConverter
    
    Parameters:
    pModelIndex - the model index
    
    Returns:
    the view index
  - getRowCount
```
public int getRowCount()
```
    Specified by:
    
    getRowCount in interface TableModel
  - getColumnCount
```
public int getColumnCount()
```
    Specified by:
    
    getColumnCount in interface TableModel
  - getColumnName
```
public String getColumnName(int pColumn)
```
    Specified by:
    
    getColumnName in interface TableModel
    
    Overrides:
    
    getColumnName in class AbstractTableModel
  - getColumnClass
```
public Class getColumnClass(int pColumn)
```
    Specified by:
    
    getColumnClass in interface TableModel
    
    Overrides:
    
    getColumnClass in class AbstractTableModel
  - isCellEditable
```
public boolean isCellEditable(int pRow,
                     int pColumn)
```
    Specified by:
    
    isCellEditable in interface TableModel
    
    Overrides:
    
    isCellEditable in class AbstractTableModel
  - getValueAt
```
public Object getValueAt(int pRow,
                int pColumn)
```
    Specified by:
    
    getValueAt in interface TableModel
  - setValueAt
```
public void setValueAt(Object pValue,
              int pRow,
              int pColumn)
```
    Specified by:
    
    setValueAt in interface TableModel
    
    Overrides:
    
    setValueAt in class AbstractTableModel

Class NewTableSorter

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

Constructor Summary

Method Summary

Methods inherited from class javax.swing.table.AbstractTableModel

Methods inherited from class java.lang.Object

Field Detail

mTableModel

DESCENDING

NOT_SORTED

ASCENDING

COMPARABLE_COMAPRATOR

LEXICAL_COMPARATOR

Constructor Detail

NewTableSorter

NewTableSorter

Method Detail

isAttemptRestoreSelectionAfterSort

setAttemptRestoreSelectionAfterSort

clearSortingState

getTableModel

setTableModel

getTableHeader

setTableHeader

isSorting

getSortingStatus

setSortingStatus

getHeaderRendererIcon

setColumnComparator

getComparator

modelIndex

viewIndex

forceInitialSorting

convert2ModelIndex

convert2ViewIndex

getRowCount

getColumnCount

getColumnName

getColumnClass

isCellEditable

getValueAt

setValueAt