Класс TableSelectionModel<T>

java.lang.Object

javafx.scene.control.SelectionModel<T>

javafx.scene.control.MultipleSelectionModel<T>

javafx.scene.control.TableSelectionModel<T>

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

Direct Known Subclasses:: TableView.TableViewSelectionModel, TreeTableView.TreeTableViewSelectionModel

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

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

Since:: JavaFX 8.0

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

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

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

selectionMode

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

selectedIndex, selectedItem

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

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

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

Модификатор и тип	Метод	Описание
`final 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 всех выбранных элементов.
`final boolean`	`isCellSelectionEnabled()`	Получает значение свойства `cellSelectionEnabled`.
`boolean`	`isEmpty()`	Этот метод доступен для проверки наличия выбранных индексов/элементов.
`boolean`	`isSelected(int index)`	Этот метод проверяет, выбран ли данный индекс в данной SelectionModel.
`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()`	Выбирает ячейку справа от текущей выбранной ячейки.
`final 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 позволяет выбирать ячейки (но не строки).

См. также:

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

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 - minRow; minColumn - minColumn; maxRow - maxRow; maxColumn - maxColumn

cellSelectionEnabledProperty

public final BooleanProperty cellSelectionEnabledProperty()

Возвращает:

свойство cellSelectionEnabled

См. также:

setCellSelectionEnabled

public final void setCellSelectionEnabled(boolean value)

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

Описание свойства:

Параметры:

value - значение свойства cellSelectionEnabled

См. также:

isCellSelectionEnabled

public final boolean isCellSelectionEnabled()

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

Описание свойства:

Возвращает:

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

См. также:

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 selection model, вероятно, вернёт 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)

Фокусирует элемент по заданному индексу.

Параметры:: 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.

Указано в:: 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.