TableSorter (Groovy 5.1.0)
Description: declaration: package: groovy.swing.table, class: TableSorter

Package groovy.swing.table

# Class TableSorter

java.lang.Object
javax.swing.table.AbstractTableModel
groovy.swing.table.TableMap
groovy.swing.table.TableSorter

All Implemented Interfaces:
  `Serializable`, `EventListener`, `TableModelListener`, `TableModel`

public class TableSorter extends TableMap
A sorter for TableModels.

The sorter has a model (conforming to TableModel) and itself implements TableModel. TableSorter does not store or copy the data in the TableModel, instead it maintains an array of integers which it keeps the same size as the number of rows in its model. When the model changes it notifies the sorter that something has changed eg. "rowsAdded" so that its internal array of integers can be reallocated. As requests are made of the sorter (like getValueAt(row, col) it redirects them to its model via the mapping array. That way the TableSorter appears to hold another copy of the table with the rows in a different order. The sorting algorithm used is stable which means that it does not move around rows when its comparison function returns 0 to denote that they are equivalent.

See Also:
  - Serialized Form

- ## Field Summary

  ### Fields inherited from class groovy.swing.table.TableMap

  `model`

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

  `listenerList`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `TableSorter()`
  `TableSorter(TableModel model)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addMouseListenerToHeaderInTable(JTable table)`
  `void`
  `checkModel()`
  `int`
  `compare(int row1, int row2)`
  `int`
  `compareRowsByColumn(int row1, int row2, int column)`
  `Object`
  `getValueAt(int aRow, int aColumn)`
  `void`
  `n2sort()`
  `void`
  `reallocateIndexes()`
  `void`
  `setModel(TableModel model)`
  `void`
  `setValueAt(Object aValue, int aRow, int aColumn)`
  `void`
  `shuttlesort(int[] from, int[] to, int low, int high)`
  `void`
  `sort(Object sender)`
  `void`
  `sortByColumn(int column)`
  `void`
  `sortByColumn(int column, boolean ascending)`
  `void`
  `swap(int i, int j)`
  `void`
  `tableChanged(TableModelEvent e)`

  ### Methods inherited from class groovy.swing.table.TableMap

  `getColumnClass, getColumnCount, getColumnName, getModel, getRowCount, isCellEditable`

  ### 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`

- ## Constructor Details

  - ### TableSorter

    public TableSorter()

  - ### TableSorter

    public TableSorter(TableModel model)

- ## Method Details

  - ### setModel

    public void setModel(TableModel model)
    Overrides:
      `setModel` in class `TableMap`

  - ### compareRowsByColumn

    public int compareRowsByColumn(int row1, int row2, int column)

  - ### compare

    public int compare(int row1, int row2)

  - ### reallocateIndexes

    public void reallocateIndexes()

  - ### tableChanged

    public void tableChanged(TableModelEvent e)
    Specified by:
      `tableChanged` in interface `TableModelListener`
    Overrides:
      `tableChanged` in class `TableMap`

  - ### checkModel

    public void checkModel()

  - ### sort

    public void sort(Object sender)

  - ### n2sort

    public void n2sort()

  - ### shuttlesort

    public void shuttlesort(int[] from, int[] to, int low, int high)

  - ### swap

    public void swap(int i, int j)

  - ### getValueAt

    public Object getValueAt(int aRow, int aColumn)
    Specified by:
      `getValueAt` in interface `TableModel`
    Overrides:
      `getValueAt` in class `TableMap`

  - ### setValueAt

    public void setValueAt(Object aValue, int aRow, int aColumn)
    Specified by:
      `setValueAt` in interface `TableModel`
    Overrides:
      `setValueAt` in class `TableMap`

  - ### sortByColumn

    public void sortByColumn(int column)

  - ### sortByColumn

    public void sortByColumn(int column, boolean ascending)

  - ### addMouseListenerToHeaderInTable

    public void addMouseListenerToHeaderInTable(JTable table)