Spec-Zone.ru › OpenJavaFX 17

Класс SelectionModel<T>

java.lang.Object
fx.scene.control.SelectionModel<T>
Параметры типа:
T - Тип элемента, содержащегося в управляющем элементе, который может быть выбран.
Прямые известные подклассы:
MultipleSelectionModel, SingleSelectionModel
public abstract class SelectionModel<T>
extends Object
SelectionModel — это абстрактный класс, используемый UI-контролами для предоставления согласованного API для управления выбором.
С:
JavaFX 2.0

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

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

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

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

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

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

selectedItem

public final ReadOnlyObjectProperty<T> selectedItemProperty

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

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

См. также:
getSelectedItem(), setSelectedItem(T)

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

SelectionModel

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

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

selectedIndexProperty

public final ReadOnlyIntegerProperty selectedIndexProperty()

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

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

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

См. также:
getSelectedIndex(), setSelectedIndex(int)

setSelectedIndex

protected final void setSelectedIndex(int value)
Устанавливает значение свойства selectedIndex.
Описание свойства:

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

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

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

getSelectedIndex

public final int getSelectedIndex()

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

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


 SelectionModel sm = ...;
 InvalidationListener listener = ...;
 sm.selectedIndexProperty().addListener(listener);
 
Возвращает:
выбранный индекс

selectedItemProperty

public final ReadOnlyObjectProperty<T> selectedItemProperty()

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

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

См. также:
getSelectedItem(), setSelectedItem(T)

setSelectedItem

protected final void setSelectedItem(T value)
Устанавливает значение свойства selectedItem.
Описание свойства:

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

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

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)

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

Параметры:
index - Выбранный элемент, который нужно снять с выбора.

clearSelection

public abstract void clearSelection()

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

isSelected

public abstract boolean isSelected(int index)

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

Параметры:
index - Индекс, который необходимо проверить на предмет того, выбран ли он в данный момент.
Возвращает:
True, если заданный индекс выбран, false в противном случае.

isEmpty

public abstract boolean isEmpty()
Этот метод предназначен для проверки наличия выбранных индексов/элементов. Он вернёт true, если выбранных элементов нет, и false, если они есть.
Возвращает:
Вернёт 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API