Класс DefaultRowSorter<M,I>

java.lang.Object

javax.swing.RowSorter<M>

javax.swing.DefaultRowSorter<M,I>

Type Parameters:: M - тип модели; I - тип идентификатора, передаваемого в RowFilter

Direct Known Subclasses:: TableRowSorter

public abstract class DefaultRowSorter<M,I> extends RowSorter<M>

Реализация RowSorter, обеспечивающая сортировку и фильтрацию данных в рамках модели данных, основанной на сетке. Помимо создания и установки RowSorter, вам крайне редко потребуется взаимодействовать с ней напрямую. Обратитесь к TableRowSorter для конкретной реализации RowSorter для JTable.

Сортировка выполняется на основе текущих SortKey в порядке следования. Если два объекта равны (метод Comparator для столбца возвращает 0), используется следующий SortKey. Если SortKey больше не остаётся или порядок UNSORTED, используется порядок строк в модели.

Сортировка каждого столбца выполняется с помощью Comparator, которую вы можете указать с помощью метода setComparator. Если Comparator не указан, используется Comparator возвращаемый Collator.getInstance() в результате вызова toString для базовых объектов. Comparator никогда не передаётся null. Значение типа null рассматривается как предшествующее значению, не являющемуся null, а два значения типа null считаются равными.

Если вы укажете Comparator , которая преобразует свой аргумент в тип, отличный от того, который предоставляется моделью, при сортировке данных будет выброшено исключение ClassCastException .

Помимо сортировки, DefaultRowSorter предоставляет возможность фильтрации строк. Фильтрация выполняется с помощью RowFilter , которая указывается с помощью метода setRowFilter . Если фильтр не задан, включаются все строки.

По умолчанию строки находятся в неупорядоченном порядке (таком же, как в модели), и каждый столбец сортируемый. Значения по умолчанию Comparator описаны в подклассах (например, TableRowSorter).

Если структура базовой модели меняется (вызывается метод modelStructureChanged), следующие параметры сбрасываются до значений по умолчанию: Comparator по столбцам, текущий порядок сортировки и сортируемость каждого столбца. Чтобы узнать значения по умолчанию Comparator, см. конкретную реализацию (например, TableRowSorter). По умолчанию порядок сортировки - неупорядоченный (совпадает с порядком в модели), а столбцы сортируются по умолчанию.

DefaultRowSorter - абстрактный класс. Конкретные подклассы должны предоставлять доступ к базовым данным, вызывая метод setModelWrapper. Метод setModelWrapper обязательно должен быть вызван вскоре после вызова конструктора, желательно из конструктора подкласса. Использование DefaultRowSorter без указания ModelWrapper приведёт к неопределённому поведению.

DefaultRowSorter имеет два формальных параметра типа. Первый параметр типа соответствует классу модели, например, DefaultTableModel. Второй параметр типа соответствует классу идентификатора, передаваемого в RowFilter. Для получения дополнительной информации о параметрах типа см. TableRowSorter и RowFilter.

Since:

1.6

See Also:

END_OF_DOCUMENT_MARKER

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

Модификатор и тип	Класс	Описание
`protected static class`	`DefaultRowSorter.ModelWrapper<M,I>`	`DefaultRowSorter.ModelWrapper` отвечает за предоставление данных, которые сортируются по `DefaultRowSorter`.

Вложенные классы/интерфейсы, объявленные в классе javax.swing.RowSorter

RowSorter.SortKey

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

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

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

Модификатор и тип	Метод	Описание
`void`	`allRowsChanged()`	Вызывается, когда содержимое базовой модели полностью изменилось.
`int`	`convertRowIndexToModel(int index)`	Возвращает расположение `index` относительно базовой модели.
`int`	`convertRowIndexToView(int index)`	Возвращает расположение `index` относительно представления.
`Comparator<?>`	`getComparator(int column)`	Возвращает `Comparator` для указанного столбца.
`int`	`getMaxSortKeys()`	Возвращает максимальное количество ключей сортировки.
`final M`	`getModel()`	Возвращает базовую модель.
`int`	`getModelRowCount()`	Возвращает количество строк в базовой модели.
`protected final DefaultRowSorter.ModelWrapper<M,I>`	`getModelWrapper()`	Возвращает обёртку модели, предоставляющую данные, которые сортируются и фильтруются.
`RowFilter<? super M,? super I>`	`getRowFilter()`	Возвращает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты от представления.
`List<? extends RowSorter.SortKey>`	`getSortKeys()`	Возвращает текущие ключи сортировки.
`boolean`	`getSortsOnUpdates()`	Возвращает true, если сортировка должна происходить при обновлении базовой модели; в противном случае возвращает false.
`int`	`getViewRowCount()`	Возвращает количество строк в представлении.
`boolean`	`isSortable(int column)`	Возвращает true, если указанный столбец сортируемый; в противном случае false.
`void`	`modelStructureChanged()`	Вызывается, когда структура базовой модели полностью изменилась.
`void`	`rowsDeleted(int firstRow, int endRow)`	Вызывается, когда строки были удалены из базовой модели в указанном диапазоне (включительно).
`void`	`rowsInserted(int firstRow, int endRow)`	Вызывается, когда строки были вставлены в базовую модель в указанном диапазоне (включительно).
`void`	`rowsUpdated(int firstRow, int endRow)`	Вызывается, когда строки были изменены в базовой модели в указанном диапазоне (включительно).
`void`	`rowsUpdated(int firstRow, int endRow, int column)`	Вызывается, когда столбцы в строках были обновлены в базовой модели в указанном диапазоне.
`void`	`setComparator(int column, Comparator<?> comparator)`	Устанавливает `Comparator` для использования при сортировке указанного столбца.
`void`	`setMaxSortKeys(int max)`	Устанавливает максимальное количество ключей сортировки.
`protected final void`	`setModelWrapper(DefaultRowSorter.ModelWrapper<M,I> modelWrapper)`	Устанавливает обёртку модели, предоставляющую данные, которые сортируются и фильтруются.
`void`	`setRowFilter(RowFilter<? super M,? super I> filter)`	Устанавливает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты от представления.
`void`	`setSortable(int column, boolean sortable)`	Устанавливает, сортируется ли указанный столбец.
`void`	`setSortKeys(List<? extends RowSorter.SortKey> sortKeys)`	Устанавливает ключи сортировки.
`void`	`setSortsOnUpdates(boolean sortsOnUpdates)`	Если true, указывает, что сортировка должна произойти при обновлении базовой модели (вызывается `rowsUpdated`).
`void`	`sort()`	Сортирует и фильтрует строки в представлении на основе ключей сортировки столбцов, которые в данный момент сортируются, и фильтра, если таковой имеется, связанного с этим сортировщиком.
`void`	`toggleSortOrder(int column)`	Инвертирует порядок сортировки с возрастающего на убывающий (или с убывающего на возрастающий), если указанный столбец уже является основным столбцом сортировки; в противном случае делает указанный столбец основным столбцом сортировки с возрастающим порядком сортировки.
`protected boolean`	`useToString(int column)`	Возвращает, преобразуется ли значение в строку перед выполнением сравнений при сортировке.

Методы, объявленные в классе javax.swing.RowSorter

addRowSorterListener, fireRowSorterChanged, fireSortOrderChanged, removeRowSorterListener

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

DefaultRowSorter

public DefaultRowSorter()

Создаёт пустой DefaultRowSorter.

Подробное описание методов

setModelWrapper

protected final void setModelWrapper(DefaultRowSorter.ModelWrapper<M,I> modelWrapper)

Устанавливает обёртку модели, предоставляющую данные, которые сортируются и фильтруются.

Параметры:: modelWrapper - обёртка модели, ответственная за предоставление данных, которые сортируются и фильтруются
Исключения:: IllegalArgumentException - если modelWrapper является null

getModelWrapper

protected final DefaultRowSorter.ModelWrapper<M,I> getModelWrapper()

Возвращает обёртку модели, предоставляющую данные, которые сортируются и фильтруются.

Возвращает:: обёртка модели, ответственная за предоставление данных, которые сортируются и фильтруются

getModel

public final M getModel()

Возвращает базовую модель.

Определено в:: getModel в классе RowSorter<M>
Возвращает:: базовая модель

setSortable

public void setSortable(int column, boolean sortable)

Устанавливает, сортируема ли указанная колонка. Указанное значение проверяется только при вызове toggleSortOrder. По-прежнему возможно сортировать по колонке, помеченной как несортируемая, непосредственно задавая ключи сортировки. По умолчанию значение true.

Параметры:

column - колонка для включения или отключения сортировки, в терминах базовой модели

sortable - сортируема ли указанная колонка

Исключения:

IndexOutOfBoundsException - если column выходит за пределы диапазона модели

См. также:

toggleSortOrder(int)
setSortKeys(java.util.List<? extends javax.swing.RowSorter.SortKey>)

isSortable

public boolean isSortable(int column)

Возвращает true, если указанная колонка сортируема; иначе, false.

Параметры:: column - колонка для проверки сортировки, в терминах базовой модели
Возвращает:: true, если колонка сортируема
Исключения:: IndexOutOfBoundsException - если колонка выходит за пределы диапазона базовой модели

setSortKeys

public void setSortKeys(List<? extends RowSorter.SortKey> sortKeys)

Устанавливает ключи сортировки. Создаёт копию переданного List; последующие изменения переданного List не влияют на эту DefaultRowSorter. Если ключи сортировки изменились, это запускает сортировку.

Определено в:: setSortKeys в классе RowSorter<M>
Параметры:: sortKeys - новые SortKeys; null — сокращение для задания пустого списка, указывающего, что представление должно быть неотсортированным
Исключения:: IllegalArgumentException - если какое-либо из значений в sortKeys равно null или имеет индекс колонки, выходящий за пределы диапазона модели

getSortKeys

public List<? extends RowSorter.SortKey> getSortKeys()

Возвращает текущие ключи сортировки. Возвращает неизменяемый non-null List. Если необходимо изменить ключи сортировки, сделайте копию возвращённого List, измените копию и вызовите setSortKeys с новым списком.

Определено в:: getSortKeys в классе RowSorter<M>
Возвращает:: текущий порядок сортировки

setMaxSortKeys

public void setMaxSortKeys(int max)

Устанавливает максимальное количество ключей сортировки. Количество ключей сортировки определяет, как разрешаются равные значения при сортировке. Например, предположим, что создан сортировщик строк таблицы и вызывается setMaxSortKeys(2). Пользователь нажимает заголовок колонки 1, что приводит к сортировке строк таблицы на основе элементов в колонке 1. Затем пользователь нажимает заголовок колонки 2, что приводит к сортировке таблицы на основе элементов в колонке 2; если какие-либо элементы в колонке 2 равны, то эти строки упорядочиваются на основе элементов в колонке 1. В этом случае мы говорим, что строки сортируются в первую очередь по колонке 2, а во вторую — по колонке 1. Если пользователь затем нажимает заголовок колонки 3, то элементы сортируются в первую очередь по колонке 3, а во вторую — по колонке 2. Так как максимальное количество ключей сортировки установлено в 2 с помощью setMaxSortKeys, колонка 1 больше не оказывает влияния на порядок.

Максимальное количество ключей сортировки контролируется toggleSortOrder. Вы можете указать больше ключей сортировки, непосредственно вызвав setSortKeys, и они все будут учтены. Однако, если затем будет вызван toggleSortOrder, максимальное количество ключей сортировки будет применено. По умолчанию значение равно 3.

Параметры:: max - максимальное количество ключей сортировки
Исключения:: IllegalArgumentException - если max < 1

getMaxSortKeys

public int getMaxSortKeys()

Возвращает максимальное количество ключей сортировки.

Возвращает:: максимальное количество ключей сортировки

setSortsOnUpdates

public void setSortsOnUpdates(boolean sortsOnUpdates)

Если true, указывает, что сортировка должна произойти при обновлении базовой модели (вызывается rowsUpdated). Например, если это true, и пользователь редактирует запись, положение этой записи в представлении может измениться. По умолчанию значение false.

Параметры:: sortsOnUpdates - сортировать ли при событиях обновления

getSortsOnUpdates

public boolean getSortsOnUpdates()

Возвращает true, если сортировка должна происходить при обновлении базовой модели; в противном случае возвращает false.

Возвращает:: сортировать ли при обновлении модели

setRowFilter

public void setRowFilter(RowFilter<? super M,? super I> filter)

Устанавливает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты из представления. Фильтр применяется до сортировки. Значение null указывает, что все значения из модели должны быть включены.

Метод RowFilter's include получает Entry, который оборачивает базовую модель. Количество столбцов в Entry соответствует количеству столбцов в ModelWrapper. Идентификатор также получен из ModelWrapper.

Этот метод запускает сортировку.

Параметры:: filter - фильтр, используемый для определения, какие записи должны быть включены

getRowFilter

public RowFilter<? super M,? super I> getRowFilter()

Возвращает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты из представления.

Возвращает:: фильтр

toggleSortOrder

public void toggleSortOrder(int column)

Инвертирует порядок сортировки с возрастающего на убывающий (или с убывающего на возрастающий), если указанная колонка уже является основной колонкой сортировки; в противном случае делает указанную колонку основной колонкой сортировки с возрастающим порядком. Если указанная колонка не сортируема, этот метод не оказывает никакого влияния.

Определено в:

toggleSortOrder в классе RowSorter<M>

Параметры:

column - индекс колонки, чтобы сделать её основной колонкой сортировки, в терминах базовой модели

Исключения:

IndexOutOfBoundsException - если колонка выходит за пределы диапазона базовой модели

См. также:

setSortable(int,boolean)
setMaxSortKeys(int)

convertRowIndexToView

public int convertRowIndexToView(int index)

Возвращает положение index с точки зрения представления. То есть, для строки index в координатах базовой модели возвращает индекс строки с точки зрения представления.

Определено в:: convertRowIndexToView в классе RowSorter<M>
Параметры:: index - индекс строки в терминах базовой модели
Возвращает:: индекс строки в терминах представления или -1, если индекс был отфильтрован из представления
Исключения:: IndexOutOfBoundsException - если index выходит за пределы диапазона модели

convertRowIndexToModel

public int convertRowIndexToModel(int index)

Возвращает положение index с точки зрения базовой модели. То есть, для строки index в координатах представления возвращает индекс строки в терминах базовой модели.

Определено в:: convertRowIndexToModel в классе RowSorter<M>
Параметры:: index - индекс строки в терминах представления
Возвращает:: индекс строки в терминах представления
Исключения:: IndexOutOfBoundsException - если index выходит за пределы диапазона представления

sort

public void sort()

Сортирует и фильтрует строки в представлении на основе ключей сортировки столбцов, которые в данный момент сортируются, и фильтра, если таковой имеется, связанного с этим сортировщиком. Пустой sortKeys список указывает, что представление должно быть неотсортированным, таким же, как и модель.

См. также:

setRowFilter(javax.swing.RowFilter<? super M, ? super I>)
setSortKeys(java.util.List<? extends javax.swing.RowSorter.SortKey>)

useToString

protected boolean useToString(int column)

Возвращает, следует ли преобразовывать значение в строку перед сравнением при сортировке. Если true, ModelWrapper.getStringValueAt будет использоваться, в противном случае ModelWrapper.getValueAt будет использоваться. Подклассы, такие как TableRowSorter, должны учитывать это значение в своей реализации ModelWrapper.

Параметры:: column - индекс столбца для проверки, с точки зрения базовой модели
Возвращает:: true, если значения должны быть преобразованы в строки перед сравнением при сортировке
Исключения:: IndexOutOfBoundsException - если column не является допустимым

setComparator

public void setComparator(int column, Comparator<?> comparator)

Устанавливает Comparator для сортировки указанного столбца. Это не приводит к сортировке. Если вы хотите отсортировать после установки компаратора, необходимо явно вызвать sort.

Параметры:: column - индекс столбца, для которого будет использоваться Comparator с точки зрения базовой модели; comparator - Comparator для использования
Исключения:: IndexOutOfBoundsException - если column выходит за пределы диапазона базовой модели

getComparator

public Comparator<?> getComparator(int column)

Возвращает Comparator для указанного столбца. Возвращает null если для столбца не был указан Comparator.

Параметры:: column - столбец для получения Comparator, с точки зрения базовой модели
Возвращает:: Comparator для указанного столбца
Исключения:: IndexOutOfBoundsException - если столбец выходит за пределы диапазона базовой модели

getViewRowCount

public int getViewRowCount()

Возвращает количество строк в представлении. Если содержимое отфильтровано, это значение может отличаться от количества строк базовой модели.

Указано в:

getViewRowCount в классе RowSorter<M>

Возвращает:

количество строк в представлении

См. также:

RowSorter.getModelRowCount()

getModelRowCount

public int getModelRowCount()

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

Указано в:

getModelRowCount в классе RowSorter<M>

Возвращает:

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

См. также:

RowSorter.getViewRowCount()

modelStructureChanged

public void modelStructureChanged()

Вызывается, когда структура базовой модели полностью изменилась. Например, если количество столбцов в TableModel изменилось, этот метод будет вызван.

Обычно этот метод не вызывается вручную. Этот метод является общедоступным для вызова классами представления.

Указано в:: modelStructureChanged в классе RowSorter<M>

allRowsChanged

public void allRowsChanged()

Вызывается, когда содержимое базовой модели полностью изменилось. Структура таблицы остается прежней, изменилось только содержимое. Обычно используется, когда сложно определить изменение с помощью других методов.

Указано в:: allRowsChanged в классе RowSorter<M>

rowsInserted

public void rowsInserted(int firstRow, int endRow)

Вызывается, когда строки вставлены в базовую модель в указанном диапазоне (включительно).

Аргументы предоставляют индексы затронутого диапазона. Первый аргумент — в терминах модели до изменения и должен быть меньше или равен размеру модели до изменения. Второй аргумент — в терминах модели после изменения и должен быть меньше размера модели после изменения. Например, если у вас есть модель из 5 строк и вы добавляете 3 элемента в конец модели, индексы будут 5, 7.

Указано в:: rowsInserted в классе RowSorter<M>
Параметры:: firstRow - первая строка; endRow - последняя строка
Исключения:: IndexOutOfBoundsException - если любой из аргументов некорректен, или firstRow > endRow

rowsDeleted

public void rowsDeleted(int firstRow, int endRow)

Вызывается, когда строки удалены из базовой модели в указанном диапазоне (включительно).

Аргументы предоставляют индексы затронутого диапазона и указаны в терминах модели до изменения. Например, если у вас есть модель из 5 строк и вы удаляете 3 элемента из конца модели, индексы будут 2, 4.

Указано в:: rowsDeleted в классе RowSorter<M>
Параметры:: firstRow - первая строка; endRow - последняя строка
Исключения:: IndexOutOfBoundsException - если любой из аргументов выходит за пределы диапазона модели до изменения, или firstRow > endRow

rowsUpdated

public void rowsUpdated(int firstRow, int endRow)

Вызывается, когда строки изменены в базовой модели в указанном диапазоне (включительно).

Указано в:: rowsUpdated в классе RowSorter<M>
Параметры:: firstRow - первая строка, в терминах базовой модели; endRow - последняя строка, в терминах базовой модели
Исключения:: IndexOutOfBoundsException - если любой из аргументов выходит за пределы диапазона базовой модели, или firstRow > endRow

rowsUpdated

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

Вызывается, когда столбец в строках обновлён в базовой модели в указанном диапазоне.

Указано в:: rowsUpdated в классе RowSorter<M>
Параметры:: firstRow - первая строка, в терминах базовой модели; endRow - последняя строка, в терминах базовой модели; column - столбец, который изменился, в терминах базовой модели
Исключения:: IndexOutOfBoundsException - если любой из аргументов выходит за пределы диапазона базовой модели после изменения, firstRow > endRow, или column находится вне диапазона базовой модели

© 1993, 2021, 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/17/docs/api/java.desktop/javax/swing/DefaultRowSorter.html