Класс SelectionModel<T>

public abstract class SelectionModel<T>
extends Object

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

  Все методыМетоды экземпляраКонкретные методы

  Тип	Свойство и описание
  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)

    Удобный метод для информирования о том, выбран ли данный индекс в этом SelectionModel. Функционально эквивалентен вызову 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 не вызывается предварительно, этот метод выберет последний индекс, сохранив при этом выбор любых других текущих выбранных индексов.

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