Класс RowSorter<M>
- java.lang.Object
-
- javax.swing.RowSorter<M>
- Type Parameters:
-
M- тип базовой модели
- Direct Known Subclasses:
- DefaultRowSorter
public abstract class RowSorter<M> extends Object
RowSorter предоставляет основу для сортировки и фильтрации. Помимо создания и установки RowSorter, вам очень редко нужно взаимодействовать с ним напрямую. Обратитесь к TableRowSorter для конкретной реализации RowSorter для JTable.
Основная роль RowSorter заключается в обеспечении сопоставления между двумя системами координат: представлением (например, JTable) и базовым источником данных, как правило, моделью.
Представление вызывает следующие методы у RowSorter:
-
toggleSortOrder Представление вызывает это, когда произошла соответствующая пользовательская жесту, чтобы запустить сортировку. Например, пользователь щелкнул заголовок столбца в таблице. - Один из методов изменения модели Представление вызывает метод изменения модели, когда базовая модель изменилась. Может быть зависимость порядка в том, как события доставляются, поэтому
RowSorterне должен обновлять свое сопоставление до вызова одного из этих методов.
convertRowIndexToModel, convertRowIndexToView и getViewRowCount, эти методы должны быть быстрыми. RowSorter предоставляет уведомления об изменениях с помощью RowSorterListener. Отправляются два типа уведомлений:
-
RowSorterEvent.Type.SORT_ORDER_CHANGED уведомляет слушателей о том, что порядок сортировки изменился. За этим обычно следует уведомление о том, что сортировка изменилась. -
RowSorterEvent.Type.SORTED уведомляет слушателей о том, что сопоставление, поддерживаемоеRowSorter, изменилось каким-либо образом.
RowSorter обычно не имеют однозначного соответствия с базовой моделью, но могут. Например, если база данных выполняет сортировку, toggleSortOrder может вызвать базу данных (в фоновом потоке) и переопределить методы сопоставления, чтобы вернуть переданный аргумент. Конкретные реализации RowSorter должны ссылаться на модель, такую как TableModel или ListModel. Классы представления, такие как JTable и JList, также будут иметь ссылку на модель. Чтобы избежать зависимости порядка, реализации RowSorter не должны устанавливать слушателя на модели. Вместо этого класс представления вызовет RowSorter при изменении модели. Например, если строка обновляется в TableModel JTable вызывает rowsUpdated. При изменении модели представление может вызвать любой из следующих методов: modelStructureChanged, allRowsChanged, rowsInserted, rowsDeleted и rowsUpdated.
- Since:
- 1.6
- See Also:
TableRowSorter
Вложенные классы
| Модификатор и тип | Класс и описание |
|---|---|
static class |
RowSorter.SortKey SortKey описывает порядок сортировки для конкретного столбца. |
Краткое описание конструкторов
| Конструктор и описание |
|---|
RowSorter() Создаёт |
Краткое описание методов
| Модификатор и тип | Метод и описание |
|---|---|
void |
addRowSorterListener(RowSorterListener l) Добавляет |
abstract void |
allRowsChanged() Вызывается, когда содержимое базовой модели полностью изменилось. |
abstract int |
convertRowIndexToModel(int index) Возвращает расположение |
abstract int |
convertRowIndexToView(int index) Возвращает расположение |
protected void |
fireRowSorterChanged(int[] lastRowIndexToModel) Уведомляет слушателя, что сопоставление изменилось. |
protected void |
fireSortOrderChanged() Уведомляет слушателя о том, что порядок сортировки изменился. |
abstract M |
getModel() Возвращает базовую модель. |
abstract int |
getModelRowCount() Возвращает количество строк в базовой модели. |
abstract List<? extends RowSorter.SortKey> |
getSortKeys() Возвращает текущие ключи сортировки. |
abstract int |
getViewRowCount() Возвращает количество строк в представлении. |
abstract void |
modelStructureChanged() Вызывается, когда структура базовой модели полностью изменилась. |
void |
removeRowSorterListener(RowSorterListener l) Удаляет |
abstract void |
rowsDeleted(int firstRow,
int endRow) Вызывается, когда строки были удалены из базовой модели в указанном диапазоне (включительно). |
abstract void |
rowsInserted(int firstRow,
int endRow) Вызывается, когда строки были вставлены в базовую модель в указанном диапазоне (включительно). |
abstract void |
rowsUpdated(int firstRow,
int endRow) Вызывается, когда строки были изменены в базовой модели между указанным диапазоном (включительно). |
abstract void |
rowsUpdated(int firstRow,
int endRow,
int column) Вызывается, когда столбцы в строках были обновлены в базовой модели между указанным диапазоном. |
abstract void |
setSortKeys(List<? extends RowSorter.SortKey> keys) Устанавливает текущие ключи сортировки. |
abstract void |
toggleSortOrder(int column) Инвертирует порядок сортировки указанного столбца. |
Методы, унаследованные от класса java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Конструкторы
RowSorter
public RowSorter()
Создаёт RowSorter.
Методы
getModel
public abstract M getModel()
Возвращает базовую модель.
- Возвращает:
- базовую модель
toggleSortOrder
public abstract void toggleSortOrder(int column)
Инвертирует порядок сортировки указанного столбца. Подклассы должны определять точное поведение при вызове. Обычно это означает инверсию порядка сортировки — от возрастающего к убывающему (или наоборот), если указанный столбец уже является основным сортируемым столбцом; в противном случае, делает указанный столбец основным сортируемым столбцом с возрастающим порядком сортировки. Если указанный столбец не поддерживает сортировку, этот метод не имеет эффекта.
Если это приводит к изменению порядка сортировки и сортировки, будет отправлено соответствующее уведомление RowSorterListener.
- Параметры:
-
column- столбец, для которого необходимо переключить порядок сортировки, в терминах базовой модели - Исключения:
-
IndexOutOfBoundsException- если столбец находится за пределами диапазона базовой модели
convertRowIndexToModel
public abstract int convertRowIndexToModel(int index)
Возвращает расположение index в терминах базовой модели. То есть, для строки index в координатах представления эта функция возвращает индекс строки в терминах базовой модели.
- Параметры:
-
index- индекс строки в терминах базового представления - Возвращает:
- индекс строки в терминах представления
- Исключения:
-
IndexOutOfBoundsException- еслиindexнаходится за пределами диапазона представления
convertRowIndexToView
public abstract int convertRowIndexToView(int index)
Возвращает расположение index в терминах представления. То есть, для строки index в координатах базовой модели эта функция возвращает индекс строки в терминах представления.
- Параметры:
-
index- индекс строки в терминах базовой модели - Возвращает:
- индекс строки в терминах представления, или -1, если индекс был отфильтрован из представления
- Исключения:
-
IndexOutOfBoundsException- еслиindexнаходится за пределами диапазона модели
setSortKeys
public abstract void setSortKeys(List<? extends RowSorter.SortKey> keys)
Устанавливает текущие ключи сортировки.
- Параметры:
-
keys- новыеSortKeys;null— сокращение для указания пустого списка, означающего, что представление должно быть несортированным
getSortKeys
public abstract List<? extends RowSorter.SortKey> getSortKeys()
Возвращает текущие ключи сортировки. Это должно вернуть non-null List и может вернуть неизменяемый List. Если вам необходимо изменить ключи сортировки, создайте копию возвращённого List, измените копию и вызовите setSortKeys с новым списком.
- Возвращает:
- текущий порядок сортировки
getViewRowCount
public abstract int getViewRowCount()
Возвращает количество строк в представлении. Если содержимое было отфильтровано, это может отличаться от количества строк базовой модели.
- Возвращает:
- количество строк в представлении
- См. также:
getModelRowCount()
getModelRowCount
public abstract int getModelRowCount()
Возвращает количество строк в базовой модели.
- Возвращает:
- количество строк в базовой модели
- См. также:
getViewRowCount()
modelStructureChanged
public abstract void modelStructureChanged()
Вызывается, когда структура базовой модели полностью изменилась. Например, если изменилось количество столбцов в TableModel , этот метод будет вызван.
Обычно вы не вызываете этот метод. Этот метод является публичным, чтобы позволить классам представления вызывать его.
allRowsChanged
public abstract void allRowsChanged()
Вызывается, когда содержимое базовой модели полностью изменилось. Структура таблицы остается такой же, изменилось только содержимое. Это обычно отправляется, когда слишком дорого характеризовать изменение в терминах других методов.
Обычно вы не вызываете этот метод. Этот метод является публичным, чтобы позволить классам представления вызывать его.
rowsInserted
public abstract void rowsInserted(int firstRow,
int endRow) Вызывается, когда в базовую модель были вставлены строки в указанном диапазоне (включительно).
Аргументы задают индексы затронутого диапазона. Первый аргумент — в терминах модели до изменения и должен быть меньше или равен размеру модели до изменения. Второй аргумент — в терминах модели после изменения и должен быть меньше размера модели после изменения. Например, если у вас есть модель из 5 строк и вы добавляете 3 элемента в конец модели, индексы будут 5, 7.
Обычно вы не вызываете этот метод. Этот метод является публичным, чтобы позволить классам представления вызывать его.
- Параметры:
-
firstRow- первая строка -
endRow- последняя строка - Исключения:
-
IndexOutOfBoundsException- если любой из аргументов недействителен илиfirstRow>endRow
rowsDeleted
public abstract void rowsDeleted(int firstRow,
int endRow) Вызывается, когда из базовой модели были удалены строки в указанном диапазоне (включительно).
Аргументы задают индексы затронутого диапазона и указаны в терминах модели до изменения. Например, если у вас есть модель из 5 строк и вы удаляете 3 элемента из конца модели, индексы будут 2, 4.
Обычно вы не вызываете этот метод. Этот метод является публичным, чтобы позволить классам представления вызывать его.
- Параметры:
-
firstRow- первая строка -
endRow- последняя строка - Исключения:
-
IndexOutOfBoundsException- если любой из аргументов находится вне диапазона модели до изменения илиfirstRow>endRow
rowsUpdated
public abstract void rowsUpdated(int firstRow,
int endRow) Вызывается, когда строки в базовой модели были изменены в указанном диапазоне (включительно).
Обычно вы не вызываете этот метод. Этот метод является публичным, чтобы позволить классам представления вызывать его.
- Параметры:
-
firstRow- первая строка, в терминах базовой модели -
endRow- последняя строка, в терминах базовой модели - Исключения:
-
IndexOutOfBoundsException- если любой из аргументов находится вне диапазона базовой модели илиfirstRow>endRow
rowsUpdated
public abstract void rowsUpdated(int firstRow,
int endRow,
int column) Вызывается, когда столбец в строках был обновлен в базовой модели между указанным диапазоном.
Обычно вы не вызываете этот метод. Этот метод является публичным, чтобы позволить классам представления вызывать его.
- Параметры:
-
firstRow- первая строка, в терминах базовой модели -
endRow- последняя строка, в терминах базовой модели -
column- столбец, который изменился, в терминах базовой модели - Исключения:
-
IndexOutOfBoundsException- если любой из аргументов находится за пределами диапазона базовой модели после изменения,firstRow>endRow, илиcolumnнаходится за пределами диапазона базовой модели
addRowSorterListener
public void addRowSorterListener(RowSorterListener l)
Добавляет RowSorterListener для получения уведомлений об этом RowSorter. Если один и тот же слушатель добавляется более одного раза, он получит несколько уведомлений. Если l является null, ничего не происходит.
- Параметры:
-
l-RowSorterListener
removeRowSorterListener
public void removeRowSorterListener(RowSorterListener l)
Удаляет RowSorterListener. Если l является null, ничего не происходит.
- Параметры:
-
l-RowSorterListener
fireSortOrderChanged
protected void fireSortOrderChanged()
Уведомляет слушателей о том, что порядок сортировки изменился.
fireRowSorterChanged
protected void fireRowSorterChanged(int[] lastRowIndexToModel)
Уведомляет слушателя о том, что отображение изменилось.
- Параметры:
-
lastRowIndexToModel- отображение от индексов модели к индексам представления до сортировки, может бытьnull
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.