Spec-Zone.ru › OpenJavaFX 24

Класс SelectionModel<T>

java.lang.Object
fx.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()

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

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

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

Возвращает:
свойство выбранного индекса
См. также:
  • getSelectedIndex()
  • setSelectedIndex(int)

setSelectedIndex

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

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

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

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

Параметры:
value - значение свойства selectedIndex
См. также:
  • getSelectedIndex()
  • selectedIndexProperty()

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, чтобы указать, что нет выделения, либо объект, полученный из базовой модели данных управления, с которым связана модель выбора.

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

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

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

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

clearSelection

public abstract void clearSelection()

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

isSelected

public abstract boolean isSelected(int index)
Этот метод проверяет, выбран ли данный индекс в данной SelectionModel.
Параметры:
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 не вызывается предварительно, этот метод выберет последний индекс, сохраняя при этом выбор любых других текущих выбранных индексов.

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

Отправить сообщение об ошибке или предложить улучшение
Copyright © 2008, 2025, Oracle и/или его аффилированные лица. Все права защищены.

© 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