Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
abstract public class: RowSorter [javadoc | source]
java.lang.Object
   javax.swing.RowSorter

Direct Known Subclasses:
    DefaultRowSorter, TableRowSorter

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:

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:

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.

Nested Class Summary:
public static class  RowSorter.SortKey  SortKey describes the sort order for a particular column. The column index is in terms of the underlying model, which may differ from that of the view. 
Constructor:
 public RowSorter() 
Method from javax.swing.RowSorter Summary:
addRowSorterListener,   allRowsChanged,   convertRowIndexToModel,   convertRowIndexToView,   fireRowSorterChanged,   fireRowSorterChanged,   fireSortOrderChanged,   getModel,   getModelRowCount,   getSortKeys,   getViewRowCount,   modelStructureChanged,   removeRowSorterListener,   rowsDeleted,   rowsInserted,   rowsUpdated,   rowsUpdated,   setSortKeys,   toggleSortOrder
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.RowSorter Detail:
 public  void addRowSorterListener(RowSorterListener l) 
    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.
 abstract public  void allRowsChanged()
    Invoked when the contents of the underlying model have completely changed. The structure of the table is the same, only the contents have changed. This is typically sent when it is too expensive to characterize the change in terms of the other methods.

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

 abstract public int convertRowIndexToModel(int index)
    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.
 abstract public int convertRowIndexToView(int index)
    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.
 protected  void fireRowSorterChanged(int[] lastRowIndexToModel) 
    Notifies listener that the mapping has changed.
  void fireRowSorterChanged(RowSorterEvent event) 
 protected  void fireSortOrderChanged() 
    Notifies listener that the sort order has changed.
 abstract public M getModel()
    Returns the underlying model.
 abstract public int getModelRowCount()
    Returns the number of rows in the underlying model.
 abstract public List<SortKey> getSortKeys()
    Returns the current sort keys. This must return a {@code non-null List} and may return an unmodifiable {@code List}. If you need to change the sort keys, make a copy of the returned {@code List}, mutate the copy and invoke {@code setSortKeys} with the new list.
 abstract public int getViewRowCount()
    Returns the number of rows in the view. If the contents have been filtered this might differ from the row count of the underlying model.
 abstract public  void modelStructureChanged()
    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. If l is null nothing is done.
 abstract public  void rowsDeleted(int firstRow,
    int endRow)
    Invoked when rows have been deleted from the underlying model in the specified range (inclusive).

    The arguments give the indices of the effected range and are in terms of the model before the change. For example, if you have a 5-row model and delete 3 items from the end of the model the indices are 2, 4.

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

 abstract public  void rowsInserted(int firstRow,
    int endRow)
    Invoked when rows have been inserted into the underlying model in the specified range (inclusive).

    The arguments give the indices of the effected range. The first argument is in terms of the model before the change, and must be less than or equal to the size of the model before the change. The second argument is in terms of the model after the change and must be less than the size of the model after the change. For example, if you have a 5-row model and add 3 items to the end of the model the indices are 5, 7.

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

 abstract public  void rowsUpdated(int firstRow,
    int endRow)
    Invoked when rows have been changed in the underlying model between the specified range (inclusive).

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

 abstract public  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.

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

 abstract public  void setSortKeys(List<SortKey> keys)
    Sets the current sort keys.
 abstract public  void toggleSortOrder(int column)
    Reverses the sort order of the specified column. It is up to subclasses to provide the exact behavior when invoked. Typically this will reverse the sort order from ascending to descending (or descending to ascending) if the specified column is already the primary sorted column; otherwise, makes the specified column the primary sorted column, with an ascending sort order. If the specified column is not sortable, this method has no effect.

    If this results in changing the sort order and sorting, the appropriate RowSorterListener notification will be sent.