Класс TableSelectionModel<T>

java.lang.Object

javafx.scene.control.SelectionModel<T>

javafx.scene.control.MultipleSelectionModel<T>

javafx.scene.control.TableSelectionModel<T>

Параметры типа:: T - Тип базовой модели данных для пользовательского интерфейса.

Прямые известные подклассы:: TableView.TableViewSelectionModel, TreeTableView.TreeTableViewSelectionModel

public abstract class TableSelectionModel<T>
extends MultipleSelectionModel<T>

Абстрактный базовый класс для реализации MultipleSelectionModel, используемых в таблицах (в первую очередь в TableView и TreeTableView).

С:: JavaFX 8.0

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

Свойства
Тип	Свойство	Описание
`BooleanProperty`	`cellSelectionEnabled`	Логическое свойство, определяющее, находится ли таблица в режиме выбора строк или ячеек.

Свойства, объявленные в классе javafx.scene.control.MultipleSelectionModel

selectionMode

Свойства, объявленные в классе javafx.scene.control.SelectionModel

selectedIndex, selectedItem

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

Конструкторы
Конструктор	Описание
`TableSelectionModel()`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`BooleanProperty`	`cellSelectionEnabledProperty()`	Логическое свойство, определяющее, находится ли таблица в режиме выбора строк или ячеек.
`void`	`clearAndSelect(int row)`	Метод, очищающий любой выбор перед установкой выбора на заданный индекс.
`abstract void`	`clearAndSelect(int row, TableColumnBase<T,?> column)`	Очищает весь выбор и затем выбирает ячейку на пересечении заданной строки/столбца.
`void`	`clearSelection()`	Очищает модель выбора всех выбранных индексов.
`void`	`clearSelection(int index)`	Этот метод очистит выбор элемента в заданном индексе.
`abstract void`	`clearSelection(int row, TableColumnBase<T,?> column)`	Удаляет выбор из указанной позиции строки/столбца (в индексах представления).
`protected abstract void`	`focus(int index)`
`protected abstract int`	`getFocusedIndex()`
`protected abstract int`	`getItemCount()`	Возвращает количество элементов в модели данных, на которой основано управление.
`protected abstract T`	`getModelItem(int index)`	Возвращает элемент в данном индексе.
`ObservableList<Integer>`	`getSelectedIndices()`	Возвращает только для чтения ObservableList всех выбранных индексов.
`ObservableList<T>`	`getSelectedItems()`	Возвращает только для чтения ObservableList всех выбранных элементов.
`boolean`	`isCellSelectionEnabled()`	Получает значение свойства cellSelectionEnabled.
`boolean`	`isEmpty()`	Этот метод доступен для проверки наличия выбранных индексов/элементов.
`boolean`	`isSelected(int index)`	Удобный метод для проверки, выбран ли данный индекс в текущей модели выбора.
`abstract boolean`	`isSelected(int row, TableColumnBase<T,?> column)`	Удобная функция, которая проверяет, выбрана ли данная строка и столбец в текущем экземпляре таблицы.
`void`	`select(int row)`	Это выберет данный индекс в модели выбора, предполагая, что индекс находится в допустимом диапазоне (т.е.
`abstract void`	`select(int row, TableColumnBase<T,?> column)`	Выбирает ячейку на пересечении заданной строки/столбца.
`void`	`select(T obj)`	Этот метод попытается выбрать индекс, содержащий данный объект.
`abstract void`	`selectAboveCell()`	Выбирает ячейку, расположенную непосредственно над текущей выделенной ячейкой.
`void`	`selectAll()`	Удобный метод для выбора всех доступных индексов.
`abstract void`	`selectBelowCell()`	Выбирает ячейку, расположенную непосредственно под текущей выделенной ячейкой.
`void`	`selectFirst()`	Этот метод попытается выбрать первый индекс в элементе управления.
`void`	`selectIndices(int row, int... rows)`	Этот метод позволяет устанавливать один или несколько выборов одновременно.
`void`	`selectLast()`	Этот метод попытается выбрать последний индекс в элементе управления.
`abstract void`	`selectLeftCell()`	Выбирает ячейку слева от текущей выделенной ячейки.
`void`	`selectNext()`	Этот метод попытается выбрать индекс непосредственно после текущего индекса фокуса.
`void`	`selectPrevious()`	Этот метод попытается выбрать индекс непосредственно перед текущим индексом фокуса.
`abstract void`	`selectRange(int minRow, TableColumnBase<T,?> minColumn, int maxRow, TableColumnBase<T,?> maxColumn)`	Выбирает ячейки в диапазоне (minRow, minColumn) по (maxRow, maxColumn), включительно.
`abstract void`	`selectRightCell()`	Выбирает ячейку справа от текущей выделенной ячейки.
`void`	`setCellSelectionEnabled(boolean value)`	Устанавливает значение свойства cellSelectionEnabled.

Методы, объявленные в классе javafx.scene.control.MultipleSelectionModel

getSelectionMode, selectionModeProperty, selectRange, setSelectionMode

Методы, объявленные в классе javafx.scene.control.SelectionModel

getSelectedIndex, getSelectedItem, selectedIndexProperty, selectedItemProperty, setSelectedIndex, setSelectedItem

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

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

Подробности свойства

cellSelectionEnabled

public final BooleanProperty cellSelectionEnabledProperty

Логическое свойство, используемое для представления того, находятся ли в таблице режимы выбора строки или ячейки. По умолчанию таблица находится в режиме выбора строки, что означает, что отдельные ячейки не могут быть выбраны. Установка cellSelectionEnabled в значение true позволяет выбирать ячейки (но не строки).

См. также:: isCellSelectionEnabled(), setCellSelectionEnabled(boolean)

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

TableSelectionModel

public TableSelectionModel()

Конструктор для вызова подклассами.

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

isSelected

public abstract boolean isSelected(int row, TableColumnBase<T,?> column)

Вспомогательная функция, проверяющая, выбрана ли данная строка и столбец в текущем экземпляре таблицы. Если элемент управления таблицей находится в режиме 'выбора ячейки' (где можно выбирать отдельные ячейки, а не целые строки), и если аргумент столбца равен null, этот метод должен возвращать true только в том случае, если все ячейки в данной строке выбраны.

Параметры:: row - строка; column - столбец
Возвращает:: true, если данная строка и столбец выбраны в текущем экземпляре таблицы

select

public abstract void select(int row, TableColumnBase<T,?> column)

Выбирает ячейку на пересечении заданной строки/столбца. Если элемент управления таблицей находится в режиме 'выбора ячейки' (где можно выбирать отдельные ячейки, а не целые строки), и если аргумент столбца равен null, этот метод должен выбрать все ячейки в данной строке.

Параметры:: row - строка; column - столбец

clearAndSelect

public abstract void clearAndSelect(int row, TableColumnBase<T,?> column)

Очищает все выделения и затем выбирает ячейку на пересечении заданной строки/столбца. Если элемент управления таблицей находится в режиме 'выбора ячейки' (где можно выбирать отдельные ячейки, а не целые строки), и если аргумент столбца равен null, этот метод должен выбрать все ячейки в данной строке.

Параметры:: row - строка; column - столбец

clearSelection

public abstract void clearSelection(int row, TableColumnBase<T,?> column)

Удаляет выделение из указанной позиции строки/столбца (в индексах представления). Если эта конкретная ячейка (или строка, если значение столбца равно -1) не выбрана, ничего не происходит. Если элемент управления таблицей находится в режиме 'выбора ячейки' (где можно выбирать отдельные ячейки, а не целые строки), и если аргумент столбца равен null, этот метод должен снять выделение со всех ячеек в данной строке.

Параметры:: row - строка; column - столбец

selectLeftCell

public abstract void selectLeftCell()

Выбирает ячейку слева от текущей выбранной ячейки.

selectRightCell

public abstract void selectRightCell()

Выбирает ячейку справа от текущей выбранной ячейки.

selectAboveCell

public abstract void selectAboveCell()

Выбирает ячейку непосредственно над текущей выбранной ячейкой.

selectBelowCell

public abstract void selectBelowCell()

Выбирает ячейку непосредственно под текущей выбранной ячейкой.

selectRange

public abstract void selectRange(int minRow, TableColumnBase<T,?> minColumn, int maxRow, TableColumnBase<T,?> maxColumn)

Выбирает ячейки в диапазоне (minRow, minColumn) до (maxRow, maxColumn) включительно.

Параметры:: minRow - минимальная строка; minColumn - минимальный столбец; maxRow - максимальная строка; maxColumn - максимальный столбец

cellSelectionEnabledProperty

public final BooleanProperty cellSelectionEnabledProperty()

См. также:: isCellSelectionEnabled(), setCellSelectionEnabled(boolean)

setCellSelectionEnabled

public final void setCellSelectionEnabled(boolean value)

Устанавливает значение свойства cellSelectionEnabled.

Описание свойства:: Логическое свойство, используемое для представления того, находятся ли в таблице режимы выбора строки или ячейки. По умолчанию таблица находится в режиме выбора строки, что означает, что отдельные ячейки не могут быть выбраны. Установка cellSelectionEnabled в значение true позволяет выбирать ячейки (но не строки).

isCellSelectionEnabled

public final boolean isCellSelectionEnabled()

Получает значение свойства cellSelectionEnabled.

Описание свойства:: Логическое свойство, используемое для представления того, находятся ли в таблице режимы выбора строки или ячейки. По умолчанию таблица находится в режиме выбора строки, что означает, что отдельные ячейки не могут быть выбраны. Установка cellSelectionEnabled в значение true позволяет выбирать ячейки (но не строки).

getSelectedIndices

public ObservableList<Integer> getSelectedIndices()

Описание, скопированное из класса: MultipleSelectionModel

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

Указано в:: getSelectedIndices в классе MultipleSelectionModel<T>
Возвращает:: список выбранных индексов

getSelectedItems

public ObservableList<T> getSelectedItems()

Описание, скопированное из класса: MultipleSelectionModel

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

Указано в:: getSelectedItems в классе MultipleSelectionModel<T>
Возвращает:: список выбранных элементов

getItemCount

protected abstract int getItemCount()

Возвращает количество элементов в модели данных, которая лежит в основе элемента управления. Например, модель выбора ListView, вероятно, вернёт listView.getItems().size(). Допустимый диапазон выбираемых индексов находится между 0 и тем, что возвращается этим методом.

Возвращает:: количество элементов в модели данных, которая лежит в основе элемента управления

getModelItem

protected abstract T getModelItem(int index)

Возвращает элемент по заданному индексу. Пример с ListView будет listView.getItems().get(index).

Параметры:: index - Индекс элемента, запрашиваемого у основной модели данных.
Возвращает:: Возвращает null, если индекс находится вне границ, или элемент типа T, связанный с данным индексом.

focus

protected abstract void focus(int index)

getFocusedIndex

protected abstract int getFocusedIndex()

clearAndSelect

public void clearAndSelect(int row)

Описание, скопированное из класса: SelectionModel

Метод, очищающий любой выбор перед установкой выбора на данный индекс. Цель этого метода — избежать необходимости сначала вызова SelectionModel.clearSelection(), что означает, что наблюдатели, которые следят за свойством selected index, не увидят, как выбранный индекс временно устанавливается в -1.

Указано в:: clearAndSelect в классе SelectionModel<T>
Параметры:: row - Индекс, который должен быть единственным выбранным индексом в этой модели выбора.

select

public void select(int row)

Описание, скопированное из класса: SelectionModel

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

Если в этой модели уже выбран один или несколько индексов, вызов этого метода не очистит эти выделения — для этого необходимо сначала вызвать SelectionModel.clearSelection().

Если индекс уже выбран, он не будет выбран повторно или снят с выбора. Однако, если реализовано многократное выделение, вызов select для уже выбранного индекса повлияет на то, чтобы индекс стал новым выбранным индексом (как возвращается SelectionModel.getSelectedIndex().

Указано в:: select в классе SelectionModel<T>
Параметры:: row - Позиция элемента для выбора в модели выбора.

select

public void select(T obj)

Описание, скопированное из класса: SelectionModel

Этот метод попытается выбрать индекс, содержащий заданный объект. Он будет итерировать по основной модели данных, пока не найдёт элемент, значение которого равно заданному объекту. На этом этапе итерация будет остановлена — это означает, что этот метод не выберет несколько индексов.

Указано в:: select в классе SelectionModel<T>
Параметры:: obj - Объект, который нужно попытаться выбрать в основной модели данных.

selectIndices

public void selectIndices(int row, int... rows)

Описание, скопированное из класса: MultipleSelectionModel

Этот метод позволяет установить сразу один или несколько выборов. Он проигнорирует любое значение, которое не находится в допустимом диапазоне (т.е. больше или равно нулю и меньше общего количества элементов в основной модели данных). Любые дубли индексов будут проигнорированы.

Если в этой модели уже выбран один или несколько индексов, вызов этого метода не очистит эти выделения — для этого необходимо сначала вызвать clearSelection.

Последнее допустимое значение станет выбранным индексом/выбранным элементом.

Указано в:: selectIndices в классе MultipleSelectionModel<T>
Параметры:: row - первый индекс для выбора; rows - ноль или более дополнительных индексов для выбора

selectAll

public void selectAll()

Описание, скопированное из класса: MultipleSelectionModel

Удобный метод для выбора всех доступных индексов.

Указано в:: selectAll в классе MultipleSelectionModel<T>

selectFirst

public void selectFirst()

Описание, скопированное из класса: MultipleSelectionModel

Этот метод попытается выбрать первый индекс в элементе управления. Если clearSelection не вызван первым, этот метод приведет к выбору первого индекса, сохраняя при этом выбор любых других текущих выбранных индексов.

Если первый индекс уже выбран, вызов этого метода не даст результата и не произойдет событие выбора.

Указано в:: selectFirst в классе MultipleSelectionModel<T>

selectLast

public void selectLast()

Описание, скопированное из класса: MultipleSelectionModel

Этот метод попытается выбрать последний индекс в элементе управления. Если clearSelection не вызван первым, этот метод приведет к выбору последнего индекса, сохраняя при этом выбор любых других текущих выбранных индексов.

Если последний индекс уже выбран, вызов этого метода не даст результата и не произойдет событие выбора.

Указано в:: selectLast в классе MultipleSelectionModel<T>

clearSelection

public void clearSelection(int index)

Описание, скопированное из класса: SelectionModel

Этот метод очистит выбор элемента в указанном индексе. Если указанный индекс не выбран, ничего не произойдёт.

Указано в:: clearSelection в классе SelectionModel<T>
Параметры:: index - Выбранный элемент для снятия выбора.

clearSelection

public void clearSelection()

Описание, скопированное из класса: SelectionModel

Очищает модель выбора всех выбранных индексов.

Указано в:: clearSelection в классе SelectionModel<T>

isSelected

public boolean isSelected(int index)

Описание, скопированное из класса: SelectionModel

Удобный метод, информирующий, выбран ли данный индекс в текущей SelectionModel. Функционально эквивалентен вызову getSelectedIndices().contains(index).

Указано в:: isSelected в классе SelectionModel<T>
Параметры:: index - Индекс для проверки, выбран ли он в данный момент.
Возвращает:: True, если указанный индекс выбран, false в противном случае.

isEmpty

public boolean isEmpty()

Описание, скопированное из класса: SelectionModel

Этот метод предназначен для проверки наличия выбранных индексов/элементов. Он вернет true, если нет выбранных элементов, и false, если они есть.

Указано в:: isEmpty в классе SelectionModel<T>
Возвращает:: Вернёт true, если нет выбранных элементов, и false, если они есть.

selectPrevious

public void selectPrevious()

Описание, скопированное из класса: SelectionModel

Этот метод попытается выбрать индекс, непосредственно предшествующий текущему фокусированному индексу. Если clearSelection не вызван первым, этот метод выберет предыдущий индекс, сохраняя выбор любых других текущих выбранных индексов.

Вызов этого метода будет успешным только в следующих случаях:

В настоящее время существует ведущий/фокусированный индекс.
Ведущий/фокусированный индекс не является первым индексом в элементе управления.
Предыдущий индекс не выбран.

Если какое-либо из этих условий ложно, событие выбора не произойдёт.

Указано в:: selectPrevious в классе SelectionModel<T>

selectNext

public void selectNext()

Описание, скопированное из класса: SelectionModel

Этот метод попытается выбрать индекс, непосредственно следующий за текущим фокусированным индексом. Если clearSelection не вызван первым, этот метод выберет следующий индекс, сохраняя выбор любых других текущих выбранных индексов.

Вызов этого метода будет успешным только в следующих случаях:

В настоящее время существует ведущий/фокусированный индекс.
Ведущий/фокусированный индекс не является последним индексом в элементе управления.
Следующий индекс не выбран.

Если какое-либо из этих условий ложно, событие выбора не произойдёт.

Указано в:: selectNext в классе SelectionModel<T>

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.