Класс RowSorter<M>

java.lang.Object

javax.swing.RowSorter<M>

Параметры типа:: M - тип базовой модели

Прямые известные подклассы:: 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.

С:

1.6

См. также:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static class`	`RowSorter.SortKey`	SortKey описывает порядок сортировки для определённого столбца.

Краткое описание конструкторов

Конструктор	Описание
`RowSorter()`	Создаёт `RowSorter`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addRowSorterListener(RowSorterListener l)`	Добавляет `RowSorterListener` для получения уведомлений об этом `RowSorter`.
`abstract void`	`allRowsChanged()`	Вызывается при полном изменении содержимого базовой модели.
`abstract int`	`convertRowIndexToModel(int index)`	Возвращает расположение `index` в терминах базовой модели.
`abstract int`	`convertRowIndexToView(int index)`	Возвращает расположение `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)`	Удаляет `RowSorterListener`.
`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

public abstract int getModelRowCount()

Возвращает количество строк в базовой модели.

Возвращает:

количество строк в базовой модели

См. также:

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, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/RowSorter.html