Класс SelectionModel<T>

java.lang.Object

javafx.scene.control.SelectionModel<T>

Параметры типа:: T - Тип элемента, содержащегося в элементе управления, который можно выбрать.

Прямые известные подклассы:: MultipleSelectionModel, SingleSelectionModel

public abstract class SelectionModel<T> extends Object

SelectionModel — это абстрактный класс, используемый элементами пользовательского интерфейса для предоставления согласованного API для управления выбором.

С:: JavaFX 2.0

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

Тип	Свойство	Описание
`final ReadOnlyIntegerProperty`	`selectedIndex`	Относится к свойству выбранного индекса, которое используется для указания текущего значения выбранного индекса в модели выбора.
`final ReadOnlyObjectProperty<T>`	`selectedItem`	Относится к свойству выбранного элемента, которое используется для указания текущего выбранного элемента в модели выбора.

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

Конструктор	Описание
`SelectionModel()`	Создает экземпляр SelectionModel по умолчанию.

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

Модификатор и тип	Метод	Описание
`abstract void`	`clearAndSelect(int index)`	Метод, очищающий любой выбор перед установкой выбора на заданный индекс.
`abstract void`	`clearSelection()`	Очищает модель выбора всех выбранных индексов.
`abstract void`	`clearSelection(int index)`	Этот метод очистит выбор элемента в заданном индексе.
`final int`	`getSelectedIndex()`	Возвращает целочисленное значение, указывающее текущий выбранный индекс в этой модели.
`final T`	`getSelectedItem()`	Возвращает текущий выбранный объект (который находится в позиции выбранного индекса).
`abstract boolean`	`isEmpty()`	Этот метод доступен для проверки наличия выбранных индексов/элементов.
`abstract boolean`	`isSelected(int index)`	Этот метод проверяет, выбран ли данный индекс в текущей SelectionModel.
`abstract void`	`select(int index)`	Это выберет указанный индекс в модели выбора, предполагая, что индекс находится в допустимом диапазоне (т.е.
`abstract void`	`select(T obj)`	Этот метод попытается выбрать индекс, содержащий заданный объект.
`final ReadOnlyIntegerProperty`	`selectedIndexProperty()`	Относится к свойству выбранного индекса, которое используется для указания текущего значения выбранного индекса в модели выбора.
`final ReadOnlyObjectProperty<T>`	`selectedItemProperty()`	Относится к свойству выбранного элемента, которое используется для указания текущего выбранного элемента в модели выбора.
`abstract void`	`selectFirst()`	Этот метод попытается выбрать первый индекс в элементе управления.
`abstract void`	`selectLast()`	Этот метод попытается выбрать последний индекс в элементе управления.
`abstract void`	`selectNext()`	Этот метод попытается выбрать индекс, непосредственно следующий за текущим фокусируемым индексом.
`abstract void`	`selectPrevious()`	Этот метод попытается выбрать индекс, непосредственно предшествующий текущему фокусируемому индексу.
`protected final void`	`setSelectedIndex(int value)`	Устанавливает значение свойства `selectedIndex`.
`protected final void`	`setSelectedItem(T value)`	Устанавливает значение свойства `selectedItem`.

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

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

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

selectedIndex

public final ReadOnlyIntegerProperty selectedIndexProperty

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

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

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

См. также:

getSelectedIndex()
setSelectedIndex(int)
selectedIndexProperty()

selectedItem

public final ReadOnlyObjectProperty<T> selectedItemProperty

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

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

См. также:

getSelectedItem()
setSelectedItem(T)
selectedItemProperty()

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

SelectionModel

public SelectionModel()

Создает экземпляр SelectionModel по умолчанию.

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

selectedIndexProperty

public final ReadOnlyIntegerProperty selectedIndexProperty()

Возвращает:

свойство выбранного индекса

См. также:

getSelectedIndex()
setSelectedIndex(int)

setSelectedIndex

protected final void setSelectedIndex(int value)

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

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

Параметры:

value - значение для свойства selectedIndex

См. также:

getSelectedIndex()
selectedIndexProperty()

getSelectedIndex

public final int getSelectedIndex()

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

Обратите внимание, что возвращаемое значение является моментальным снимком во времени — если вы хотите наблюдать за моделью выбора для изменений выбранного индекса, вы можете добавить слушатель изменений следующим образом:


 SelectionModel sm = ...;
 InvalidationListener listener = ...;
 sm.selectedIndexProperty().addListener(listener);

Возвращает:: выбранный индекс

selectedItemProperty

public final ReadOnlyObjectProperty<T> selectedItemProperty()

Возвращает:

свойство выбранного элемента

См. также:

getSelectedItem()
setSelectedItem(T)

setSelectedItem

protected final void setSelectedItem(T value)

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

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

Параметры:

value - значение для свойства selectedItem

См. также:

getSelectedItem()
selectedItemProperty()

getSelectedItem

public final T getSelectedItem()

Возвращает текущий выбранный объект (расположенный в позиции выбранного индекса). Если выбрано несколько элементов, возвращается объект, содержащийся в индексе, возвращенном getSelectedIndex() (который всегда является индексом к последнему выбранному элементу).

Обратите внимание, что возвращаемое значение является моментальным снимком во времени — если вы хотите наблюдать за моделью выбора для изменений выбранного элемента, вы можете добавить слушатель изменений следующим образом:


 SelectionModel sm = ...;
 InvalidationListener listener = ...;
 sm.selectedItemProperty().addListener(listener);

Возвращает:: выбранный элемент

clearAndSelect

public abstract void clearAndSelect(int index)

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

Параметры:: index - Индекс, который должен быть единственным выбранным индексом в этой модели выбора.

select

public abstract void select(int index)

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

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

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

Параметры:: index - Позиция элемента для выбора в модели выбора.

select

public abstract void select(T obj)

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

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

clearSelection

public abstract void clearSelection(int index)

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

Parameters:: index - Выбранный элемент для отмены выбора.

clearSelection

public abstract void clearSelection()

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

isSelected

public abstract boolean isSelected(int index)

Этот метод проверяет, выбран ли данный индекс в данной модели выбора.

Parameters:: index - Индекс, который нужно проверить на выбор.
Returns:: True, если заданный индекс выбран, иначе false.

isEmpty

public abstract boolean isEmpty()

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

Returns:: Вернёт true, если выбранных элементов нет, и false, если они есть.

selectPrevious

public abstract void selectPrevious()

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

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

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

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

selectNext

public abstract void selectNext()

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

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

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

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

selectFirst

public abstract void selectFirst()

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

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

selectLast

public abstract void selectLast()

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

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

© 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.