- java.lang.Object
-
- javax.swing.RowSorter<M>
-
- Type Parameters:
M
- the type of the underlying model
- Direct Known Subclasses:
- DefaultRowSorter
public abstract class RowSorter<M> extends Object
RowSorter
provides the basis for sorting and filtering. Beyond creating and installing aRowSorter
, you very rarely need to interact with one directly. Refer toTableRowSorter
for a concrete implementation ofRowSorter
forJTable
.RowSorter
's primary role is to provide a mapping between two coordinate systems: that of the view (for example aJTable
) 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.
convertRowIndexToModel
,convertRowIndexToView
andgetViewRowCount
methods, these methods need to be fast.RowSorter
provides notification of changes by way ofRowSorterListener
. 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 theRowSorter
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 asTableModel
orListModel
. The view classes, such asJTable
andJList
, 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 theRowSorter
when the model changes. For example, if a row is updated in aTableModel
JTable
invokesrowsUpdated
. When the model changes, the view may call into any of the following methods:modelStructureChanged
,allRowsChanged
,rowsInserted
,rowsDeleted
androwsUpdated
.- Since:
- 1.6
- See Also:
TableRowSorter
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
RowSorter.SortKey
SortKey describes the sort order for a particular column.
-
Constructor Summary
Constructors Constructor and Description RowSorter()
Creates aRowSorter
.
-
Method Summary
Methods Modifier and Type Method and Description void
addRowSorterListener(RowSorterListener l)
Adds aRowSorterListener
to receive notification about thisRowSorter
.abstract void
allRowsChanged()
Invoked when the contents of the underlying model have completely changed.abstract int
convertRowIndexToModel(int index)
Returns the location ofindex
in terms of the underlying model.abstract int
convertRowIndexToView(int index)
Returns the location ofindex
in terms of the view.protected void
fireRowSorterChanged(int[] lastRowIndexToModel)
Notifies listener that the mapping has changed.protected void
fireSortOrderChanged()
Notifies listener that the sort order has changed.abstract M
getModel()
Returns the underlying model.abstract int
getModelRowCount()
Returns the number of rows in the underlying model.abstract List<? extends RowSorter.SortKey>
getSortKeys()
Returns the current sort keys.abstract int
getViewRowCount()
Returns the number of rows in the view.abstract void
modelStructureChanged()
Invoked when the underlying model structure has completely changed.void
removeRowSorterListener(RowSorterListener l)
Removes aRowSorterListener
.abstract void
rowsDeleted(int firstRow, int endRow)
Invoked when rows have been deleted from the underlying model in the specified range (inclusive).abstract void
rowsInserted(int firstRow, int endRow)
Invoked when rows have been inserted into the underlying model in the specified range (inclusive).abstract void
rowsUpdated(int firstRow, int endRow)
Invoked when rows have been changed in the underlying model between the specified range (inclusive).abstract 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.abstract void
setSortKeys(List<? extends RowSorter.SortKey> keys)
Sets the current sort keys.abstract void
toggleSortOrder(int column)
Reverses the sort order of the specified column.
-
-
-
Method Detail
-
getModel
public abstract M getModel()
Returns the underlying model.- Returns:
- the underlying model
-
toggleSortOrder
public abstract 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.- Parameters:
column
- the column to toggle the sort ordering of, in terms of the underlying model- Throws:
IndexOutOfBoundsException
- if column is outside the range of the underlying model
-
convertRowIndexToModel
public abstract int convertRowIndexToModel(int index)
Returns the location ofindex
in terms of the underlying model. That is, for the rowindex
in the coordinates of the view this returns the row index in terms of the underlying model.- Parameters:
index
- the row index in terms of the underlying view- Returns:
- row index in terms of the view
- Throws:
IndexOutOfBoundsException
- ifindex
is outside the range of the view
-
convertRowIndexToView
public abstract int convertRowIndexToView(int index)
Returns the location ofindex
in terms of the view. That is, for the rowindex
in the coordinates of the underlying model this returns the row index in terms of the view.- Parameters:
index
- the row index in terms of the underlying model- Returns:
- row index in terms of the view, or -1 if index has been filtered out of the view
- Throws:
IndexOutOfBoundsException
- ifindex
is outside the range of the model
-
setSortKeys
public abstract void setSortKeys(List<? extends RowSorter.SortKey> keys)
Sets the current sort keys.- Parameters:
keys
- the newSortKeys
;null
is a shorthand for specifying an empty list, indicating that the view should be unsorted
-
getSortKeys
public abstract List<? extends RowSorter.SortKey> getSortKeys()
Returns the current sort keys. This must return anon-null List
and may return an unmodifiableList
. If you need to change the sort keys, make a copy of the returnedList
, mutate the copy and invokesetSortKeys
with the new list.- Returns:
- the current sort order
-
getViewRowCount
public abstract 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.- Returns:
- number of rows in the view
- See Also:
getModelRowCount()
-
getModelRowCount
public abstract int getModelRowCount()
Returns the number of rows in the underlying model.- Returns:
- number of rows in the underlying model
- See Also:
getViewRowCount()
-
modelStructureChanged
public abstract void modelStructureChanged()
Invoked when the underlying model structure has completely changed. For example, if the number of columns in aTableModel
changed, this method would be invoked.You normally do not call this method. This method is public to allow view classes to call it.
-
allRowsChanged
public abstract 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.
-
rowsInserted
public abstract 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.
- Parameters:
firstRow
- the first rowendRow
- the last row- Throws:
IndexOutOfBoundsException
- if either argument is invalid, orfirstRow
>endRow
-
rowsDeleted
public abstract 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.
- Parameters:
firstRow
- the first rowendRow
- the last row- Throws:
IndexOutOfBoundsException
- if either argument is outside the range of the model before the change, orfirstRow
>endRow
-
rowsUpdated
public abstract 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.
- Parameters:
firstRow
- the first row, in terms of the underlying modelendRow
- the last row, in terms of the underlying model- Throws:
IndexOutOfBoundsException
- if either argument is outside the range of the underlying model, orfirstRow
>endRow
-
rowsUpdated
public abstract 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.
- Parameters:
firstRow
- the first row, in terms of the underlying modelendRow
- the last row, in terms of the underlying modelcolumn
- the column that has changed, in terms of the underlying model- Throws:
IndexOutOfBoundsException
- if either argument is outside the range of the underlying model after the change,firstRow
>endRow
, orcolumn
is outside the range of the underlying model
-
addRowSorterListener
public void addRowSorterListener(RowSorterListener l)
Adds aRowSorterListener
to receive notification about thisRowSorter
. If the same listener is added more than once it will receive multiple notifications. Ifl
isnull
nothing is done.- Parameters:
l
- theRowSorterListener
-
removeRowSorterListener
public void removeRowSorterListener(RowSorterListener l)
Removes aRowSorterListener
. Ifl
isnull
nothing is done.- Parameters:
l
- theRowSorterListener
-
fireSortOrderChanged
protected void fireSortOrderChanged()
Notifies listener that the sort order has changed.
-
fireRowSorterChanged
protected void fireRowSorterChanged(int[] lastRowIndexToModel)
Notifies listener that the mapping has changed.- Parameters:
lastRowIndexToModel
- the mapping from model indices to view indices prior to the sort, may benull
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/11/2024 04:39:07 Cette version de la page est en cache (à la date du 22/11/2024 04:39:07) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/RowSorter.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.