RowSorter JDK 1.6)

Description

publicabstract abstract class RowSorter

RowSorter provides the basis for sorting and filtering.

RowSorter provides the basis for sorting and filtering. Beyond creating and installing a RowSorter, you very rarely need to interact with one directly. Refer to TableRowSorter for a concrete implementation of RowSorter for JTable.

RowSorter's primary role is to provide a mapping between two coordinate systems: that of the view (for example a JTable) and that of the underlying data source, typically a model.

The view invokes the following methods on the RowSorter:

toggleSortOrder — The view invokes this when the appropriate user gesture has occurred to trigger a sort. For example, the user clicked a column header in a table.
One of the model change methods — The view invokes a model change method when the underlying model has changed. There may be order dependencies in how the events are delivered, so a RowSorter should not update its mapping until one of these methods is invoked.

Because the view makes extensive use of the convertRowIndexToModel, convertRowIndexToView and getViewRowCount methods, these methods need to be fast.

RowSorter provides notification of changes by way of RowSorterListener. Two types of notification are sent:

RowSorterEvent.Type.SORT_ORDER_CHANGED — notifies listeners that the sort order has changed. This is typically followed by a notification that the sort has changed.
RowSorterEvent.Type.SORTED — notifies listeners that the mapping maintained by the RowSorter has changed in some way.

RowSorter implementations typically don't have a one-to-one mapping with the underlying model, but they can. For example, if a database does the sorting, toggleSortOrder might call through to the database (on a background thread), and override the mapping methods to return the argument that is passed in.

Concrete implementations of RowSorter need to reference a model such as TableModel or ListModel. The view classes, such as JTable and JList, will also have a reference to the model. To avoid ordering dependencies, RowSorter implementations should not install a listener on the model. Instead the view class will call into the RowSorter when the model changes. For example, if a row is updated in a TableModel JTable invokes rowsUpdated. When the model changes, the view may call into any of the following methods: modelStructureChanged, allRowsChanged, rowsInserted, rowsDeleted and rowsUpdated.

See also: TableRowSorter

Methods

Hide/Show inherited methods

public void addRowSorterListener (RowSorterListener l)

Adds a RowSorterListener to receive notification about this RowSorter.

Adds a RowSorterListener to receive notification
about this RowSorter. If the same
listener is added more than once it will receive multiple
notifications. If l is null nothing
is done.
Parameters:
- l - the RowSorterListener

publicabstract void allRowsChanged ()

Invoked when the contents of the underlying model have completely changed.

publicabstract int convertRowIndexToModel (int index)

Returns the location of index in terms of the underlying model.

Returns the location of index in terms of the
underlying model. That is, for the row index in
the coordinates of the view this returns the row index in terms
of the underlying model.
Returns: row index in terms of the view
Parameters:
- index - the row index in terms of the underlying view
Throws:
- IndexOutOfBoundsException - if index is outside the range of the view

publicabstract int convertRowIndexToView (int index)

Returns the location of index in terms of the view.

Returns the location of index in terms of the
view. That is, for the row index in the
coordinates of the underlying model this returns the row index
in terms of the view.
Returns: row index in terms of the view, or -1 if index has been filtered out of the view
Parameters:
- index - the row index in terms of the underlying model
Throws:
- IndexOutOfBoundsException - if index is outside the range of the model

protected void fireRowSorterChanged (int[] lastRowIndexToModel)

Notifies listener that the mapping has changed.

Notifies listener that the mapping has changed.
Parameters:
- lastRowIndexToModel - the mapping from model indices to view indices prior to the sort, may be null

pack-private void fireRowSorterChanged (RowSorterEvent event)

protected void fireSortOrderChanged ()

Notifies listener that the sort order has changed.

publicabstract M getModel ()

Returns the underlying model.

publicabstract int getModelRowCount ()

Returns the number of rows in the underlying model.

publicabstract List<SortKey> getSortKeys ()

Returns the current sort keys.

Returns the current sort keys. This must return a non-null List and may return an unmodifiable List. If
you need to change the sort keys, make a copy of the returned
List, mutate the copy and invoke setSortKeys
with the new list.
Returns: the current sort order

publicabstract int getViewRowCount ()

Returns the number of rows in the view.

publicabstract void modelStructureChanged ()

Invoked when the underlying model structure has completely changed.

Invoked when the underlying model structure has completely changed. For example, if the number of columns in a TableModel changed, this method would be invoked.

You normally do not call this method. This method is public to allow view classes to call it.

public void removeRowSorterListener (RowSorterListener l)

Removes a RowSorterListener.

Removes a RowSorterListener. If
l is null nothing is done.
Parameters:
- l - the RowSorterListener

publicabstract void rowsDeleted (int firstRow, int endRow)

Invoked when rows have been deleted from the underlying model in the specified range (inclusive).

publicabstract void rowsInserted (int firstRow, int endRow)

Invoked when rows have been inserted into the underlying model in the specified range (inclusive).

publicabstract void rowsUpdated (int firstRow, int endRow)

Invoked when rows have been changed in the underlying model between the specified range (inclusive).

publicabstract void rowsUpdated (int firstRow, int endRow, int column)

Invoked when the column in the rows have been updated in the underlying model between the specified range.

publicabstract void setSortKeys (List<SortKey> keys)

Sets the current sort keys.

Sets the current sort keys.
Parameters:
- keys - the new SortKeys; null is a shorthand for specifying an empty list, indicating that the view should be unsorted

publicabstract void toggleSortOrder (int column)

Reverses the sort order of the specified column.