Класс DefaultListSelectionModel

java.lang.Object

javax.swing.DefaultListSelectionModel

Все реализуемые интерфейсы:: Serializable, Cloneable, ListSelectionModel

public class DefaultListSelectionModel extends Object implements ListSelectionModel, Cloneable, Serializable

Модель данных по умолчанию для выбора элементов списка.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации предназначена для кратковременного хранения или RMI между приложениями, работающими с одной и той же версией Swing. Начиная с версии 1.4, в пакет java.beans добавлена поддержка долгосрочного хранения всех JavaBeans. См. XMLEncoder.

Начиная с:

1.2

См. также:

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

Модификатор и тип	Поле	Описание
`protected boolean`	`leadAnchorNotificationEnabled`	Включено ли уведомление о ведущем якоре.
`protected EventListenerList`	`listenerList`	Список слушателей.

Поля, объявленные в интерфейсе ListSelectionModel

MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Модификатор и тип	Поле	Описание
`static final int`	`MULTIPLE_INTERVAL_SELECTION`	Значение свойства selectionMode: за один раз выбирать один или несколько смежных диапазонов индексов.
`static final int`	`SINGLE_INTERVAL_SELECTION`	Значение свойства selectionMode: за один раз выбирать один смежный диапазон индексов.
`static final int`	`SINGLE_SELECTION`	Значение свойства selectionMode: за один раз выбирать один индекс списка.

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

Конструктор	Описание
`DefaultListSelectionModel()`	Создает `DefaultListSelectionModel`.

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

Модификатор и тип	Метод	Описание
`void`	`addListSelectionListener(ListSelectionListener l)`	Добавляет в список слушатель, который получает уведомление при каждом изменении выбора.
`void`	`addSelectionInterval(int index0, int index1)`	Изменяет выбор, устанавливая объединение текущего выбора и индексов от `index0` до `index1` включительно.
`void`	`clearSelection()`	Сбрасывает выбор, оставляя пустое множество.
`Object`	`clone()`	Возвращает клон этой модели выбора с тем же выбором.
`protected void`	`fireValueChanged(boolean isAdjusting)`	Уведомляет слушателей о завершении серии изменений.
`protected void`	`fireValueChanged(int firstIndex, int lastIndex)`	Уведомляет `ListSelectionListeners` об изменении значения выбора в замкнутом интервале `firstIndex`, `lastIndex`.
`protected void`	`fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)`	Уведомляет `ListSelectionListeners` об изменении значения выбора в замкнутом интервале `firstIndex`, `lastIndex`, а также о том, является ли это изменение последним в серии.
`int`	`getAnchorSelectionIndex()`	Возвращает первый аргумент-индекс из последнего вызова setSelectionInterval(), addSelectionInterval() или removeSelectionInterval().
`int`	`getLeadSelectionIndex()`	Возвращает второй аргумент-индекс из последнего вызова setSelectionInterval(), addSelectionInterval() или removeSelectionInterval().
`<T extends EventListener> T[]`	`getListeners(Class<T> listenerType)`	Возвращает массив всех объектов, зарегистрированных в этой модели как `FooListener`.
`ListSelectionListener[]`	`getListSelectionListeners()`	Возвращает массив всех слушателей выбора из списка, зарегистрированных в этой `DefaultListSelectionModel`.
`int`	`getMaxSelectionIndex()`	Возвращает индекс последнего выбранного элемента или -1, если выбор пуст.
`int`	`getMinSelectionIndex()`	Возвращает индекс первого выбранного элемента или -1, если выбор пуст.
`int`	`getSelectionMode()`	Возвращает текущий режим выбора.
`boolean`	`getValueIsAdjusting()`	Возвращает `true`, если выбор подвергается серии изменений.
`void`	`insertIndexInterval(int index, int length, boolean before)`	Вставляет length индексов перед индексом или после него.
`boolean`	`isLeadAnchorNotificationEnabled()`	Возвращает значение флага `leadAnchorNotificationEnabled`.
`boolean`	`isSelectedIndex(int index)`	Возвращает true, если указанный индекс выбран.
`boolean`	`isSelectionEmpty()`	Возвращает true, если не выбрано ни одного индекса.
`void`	`moveLeadSelectionIndex(int leadIndex)`	Задает индекс ведущего элемента выбора, не изменяя значения выбора.
`void`	`removeIndexInterval(int index0, int index1)`	Удаляет из модели выбора индексы в интервале index0,index1 (включительно).
`void`	`removeListSelectionListener(ListSelectionListener l)`	Удаляет из списка слушатель, который получает уведомление при каждом изменении выбора.
`void`	`removeSelectionInterval(int index0, int index1)`	Изменяет выбор, устанавливая разность текущего выбора и индексов от `index0` до `index1` включительно.
`void`	`setAnchorSelectionIndex(int anchorIndex)`	Задает индекс якорного элемента выбора, не изменяя значения выбора.
`void`	`setLeadAnchorNotificationEnabled(boolean flag)`	Задает значение флага leadAnchorNotificationEnabled.
`void`	`setLeadSelectionIndex(int leadIndex)`	Задает индекс ведущего элемента выбора, обеспечивая, чтобы все значения между якорем и новым ведущим элементом были либо выбраны, либо не выбраны.
`void`	`setSelectionInterval(int index0, int index1)`	Изменяет выбор, выбирая индексы от `index0` до `index1` включительно.
`void`	`setSelectionMode(int selectionMode)`	Задает режим выбора.
`void`	`setValueIsAdjusting(boolean isAdjusting)`	Задает свойство `valueIsAdjusting`, которое указывает, следует ли считать предстоящие изменения выбора частью одного изменения.
`String`	`toString()`	Возвращает строку, отображающую свойства этого объекта и описывающую его.

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

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

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object obj)`	Указывает, равен ли некоторый другой объект этому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация устарела и подлежит удалению в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или прерывания, либо до истечения заданного периода реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или прерывания, либо до истечения заданного периода реального времени.

Методы, объявленные в интерфейсе ListSelectionModel

getSelectedIndices, getSelectedItemsCount

Модификатор и тип	Метод	Описание
`default int[]`	`getSelectedIndices()`	Возвращает массив всех выбранных индексов модели выбора в порядке возрастания.
`default int`	`getSelectedItemsCount()`	Возвращает количество выбранных элементов.

Подробное описание полей

listenerList

protected EventListenerList listenerList

Список слушателей.

leadAnchorNotificationEnabled

protected boolean leadAnchorNotificationEnabled

Включено ли уведомление об изменении ведущего и опорного индексов.

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

DefaultListSelectionModel

public DefaultListSelectionModel()

Создает DefaultListSelectionModel.

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

getMinSelectionIndex

public int getMinSelectionIndex()

Возвращает первый выбранный индекс или -1, если выборка пуста.

Указано в:: getMinSelectionIndex в интерфейсе ListSelectionModel
Возвращает:: первый выбранный индекс или -1, если выборка пуста.

getMaxSelectionIndex

public int getMaxSelectionIndex()

Возвращает последний выбранный индекс или -1, если выборка пуста.

Указано в:: getMaxSelectionIndex в интерфейсе ListSelectionModel
Возвращает:: последний выбранный индекс или -1, если выборка пуста.

getValueIsAdjusting

public boolean getValueIsAdjusting()

Возвращает true, если выборка изменяется в ходе серии изменений.

Указано в:

getValueIsAdjusting в интерфейсе ListSelectionModel

Возвращает:

true, если выборка изменяется в ходе серии изменений

См. также:

getSelectionMode

public int getSelectionMode()

Возвращает текущий режим выбора.

Указано в:

getSelectionMode в интерфейсе ListSelectionModel

Возвращает:

текущий режим выбора

См. также:

setSelectionMode

public void setSelectionMode(int selectionMode)

Задает режим выбора. В следующем списке описаны допустимые режимы выбора:

ListSelectionModel.SINGLE_SELECTION — одновременно можно выбрать только один индекс списка. В этом режиме setSelectionInterval и addSelectionInterval эквивалентны: оба заменяют текущую выборку индексом, заданным вторым аргументом («ведущим»).
ListSelectionModel.SINGLE_INTERVAL_SELECTION — одновременно можно выбрать только один непрерывный интервал. В этом режиме addSelectionInterval ведет себя так же, как setSelectionInterval (заменяет текущую выборку), если только заданный интервал не примыкает непосредственно к существующей выборке и не перекрывает ее, так что его можно использовать для расширения выборки.
ListSelectionModel.MULTIPLE_INTERVAL_SELECTION — в этом режиме нет ограничений на выборку.

Указано в:

setSelectionMode в интерфейсе ListSelectionModel

Параметры:

selectionMode — режим выбора

Исключения:

IllegalArgumentException — если режим выбора не входит в число допустимых

См. также:

isSelectedIndex

public boolean isSelectedIndex(int index)

Возвращает true, если указанный индекс выбран.

Указано в:: isSelectedIndex в интерфейсе ListSelectionModel
Параметры:: index — индекс
Возвращает:: true, если указанный индекс выбран

isSelectionEmpty

public boolean isSelectionEmpty()

Возвращает true, если не выбрано ни одного индекса.

Указано в:: isSelectionEmpty в интерфейсе ListSelectionModel
Возвращает:: true, если не выбрано ни одного индекса.

addListSelectionListener

public void addListSelectionListener(ListSelectionListener l)

Добавляет слушателя в список; он получает уведомление при каждом изменении выборки.

Указано в:

addListSelectionListener в интерфейсе ListSelectionModel

Параметры:

l — ListSelectionListener

См. также:

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener l)

Удаляет слушателя из списка; он получал уведомления при каждом изменении выборки.

Указано в:

removeListSelectionListener в интерфейсе ListSelectionModel

Параметры:

l — ListSelectionListener

См. также:

getListSelectionListeners

public ListSelectionListener[] getListSelectionListeners()

Возвращает массив всех слушателей выбора списка, зарегистрированных в этой модели DefaultListSelectionModel.

Возвращает:

всех ListSelectionListener этой модели или пустой массив, если в настоящий момент слушатели выбора списка не зарегистрированы

С момента:

1.4

См. также:

fireValueChanged

protected void fireValueChanged(boolean isAdjusting)

Уведомляет слушателей о завершении серии изменений.

Параметры:: isAdjusting — true, если это последнее изменение в серии

fireValueChanged

protected void fireValueChanged(int firstIndex, int lastIndex)

Уведомляет ListSelectionListeners об изменении значения выборки в замкнутом интервале firstIndex, lastIndex.

Параметры:: firstIndex — первый индекс интервала; lastIndex — последний индекс интервала

fireValueChanged

protected void fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)

Уведомляет ListSelectionListeners об изменении значения выборки в замкнутом интервале firstIndex, lastIndex, а также о том, является ли это изменение последним в серии.

Параметры:

firstIndex — первый индекс интервала

lastIndex — последний индекс интервала

isAdjusting — true, если это последнее изменение в серии

См. также:

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

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

В качестве аргумента listenerType можно указать литерал класса, например FooListener.class. Например, можно запросить у экземпляра DefaultListSelectionModel m список слушателей выбора списка с помощью следующего кода:

ListSelectionListener[] lsls = (ListSelectionListener[])(m.getListeners(ListSelectionListener.class));

Если таких слушателей нет, этот метод возвращает пустой массив.

Параметры типа:

T — тип запрашиваемого класса EventListener

Параметры:

listenerType — тип запрашиваемых слушателей; этот параметр должен задавать интерфейс, являющийся наследником java.util.EventListener

Возвращает:

массив всех объектов, зарегистрированных в этой модели как слушатели FooListener, или пустой массив, если такие слушатели не добавлены

Исключения:

ClassCastException — если listenerType не задает класс или интерфейс, реализующий java.util.EventListener

С момента:

1.3

См. также:

setLeadAnchorNotificationEnabled

public void setLeadAnchorNotificationEnabled(boolean flag)

Задает значение флага leadAnchorNotificationEnabled.

Параметры:

flag — логическое значение для leadAnchorNotificationEnabled

См. также:

isLeadAnchorNotificationEnabled

public boolean isLeadAnchorNotificationEnabled()

Возвращает значение флага leadAnchorNotificationEnabled. Если leadAnchorNotificationEnabled имеет значение true, модель генерирует события уведомления с границами, охватывающими все изменения выборки, а также изменения ведущего и опорного индексов. Если задать флагу значение false, границы события сужаются и включают только элементы, выбранные или отмененные после последнего изменения. В любом случае модель продолжает поддерживать переменные ведущего и опорного индексов внутри себя. Значение по умолчанию — true.

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

Возвращает:

значение флага leadAnchorNotificationEnabled

См. также:

clearSelection

public void clearSelection()

Очищает выборку. Если это изменяет текущую выборку, каждый ListSelectionListener получает уведомление.

Указано в:

clearSelection в интерфейсе ListSelectionModel

См. также:

setSelectionInterval

public void setSelectionInterval(int index0, int index1)

Изменяет выборку так, чтобы она включала индексы от index0 до index1 включительно. index0 не обязательно должен быть меньше или равен index1.

В режиме выбора SINGLE_SELECTION используется только второй индекс.

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

Если один из индексов равен -1, метод ничего не делает и завершается без исключения. В противном случае, если один из индексов меньше -1, генерируется исключение IndexOutOfBoundsException.

Указано в:

setSelectionInterval в интерфейсе ListSelectionModel

Параметры:

index0 — один конец интервала.

index1 — другой конец интервала

Исключения:

IndexOutOfBoundsException — если один из индексов меньше -1 (и ни один из индексов не равен -1)

См. также:

addSelectionInterval

public void addSelectionInterval(int index0, int index1)

Изменяет выборку, добавляя к текущей выборке индексы от index0 до index1 включительно.

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

Если это изменяет текущую выборку, каждый ListSelectionListener получает уведомление об изменении. Обратите внимание, что index0 не обязательно должен быть меньше или равен index1.

Указано в:

addSelectionInterval в интерфейсе ListSelectionModel

Параметры:

index0 — один конец интервала.

index1 — другой конец интервала

Исключения:

IndexOutOfBoundsException — если один из индексов меньше -1 (и ни один из индексов не равен -1)

См. также:

removeSelectionInterval

public void removeSelectionInterval(int index0, int index1)

Изменяет выборку, удаляя из нее индексы от index0 до index1 включительно. index0 не обязательно должен быть меньше или равен index1.

В режиме выбора SINGLE_INTERVAL_SELECTION, если в результате удаления возникнут две несмежные выборки, удаление распространяется до большего конца выборки. Например, если выбраны индексы 0-10, а в качестве аргументов переданы индексы 5,6 (в любом порядке), результирующая выборка будет 0-4.

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

Указано в:

removeSelectionInterval в интерфейсе ListSelectionModel

Параметры:

index0 — один конец интервала

index1 — другой конец интервала

Исключения:

IndexOutOfBoundsException — если один из индексов меньше -1 (и ни один из индексов не равен -1)

См. также:

insertIndexInterval

public void insertIndexInterval(int index, int length, boolean before)

Вставляет length индексов до или после индекса index. Если значение по индексу выбрано и режим выбора не равен SINGLE_SELECTION, выбирает все новые элементы. В противном случае оставляет их невыбранными. Этот метод обычно вызывается для синхронизации модели выбора с соответствующим изменением модели данных.

Указано в:: insertIndexInterval в интерфейсе ListSelectionModel
Параметры:: index — начало интервала; length — длина интервала; before — если true, интервал вставляется перед index, в противном случае интервал вставляется после index
Исключения:: IndexOutOfBoundsException — если index или length отрицателен

removeIndexInterval

public void removeIndexInterval(int index0, int index1)

Удаляет из модели выбора индексы интервала index0,index1 (включительно). Этот метод обычно вызывается для синхронизации модели выбора с соответствующим изменением модели данных. Обратите внимание, что (как и всегда) index0 не обязательно должен быть <= index1.

Указано в:: removeIndexInterval в интерфейсе ListSelectionModel
Параметры:: index0 — начало интервала; index1 — конец интервала
Исключения:: IndexOutOfBoundsException — если один из индексов отрицателен

setValueIsAdjusting

public void setValueIsAdjusting(boolean isAdjusting)

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

Например, если выборка обновляется в ответ на перетаскивание пользователем, это свойство можно установить в true при начале перетаскивания и в false при его завершении. Во время перетаскивания слушатели получают события со свойством valueIsAdjusting, равным true. В конце перетаскивания, когда изменение завершено, слушатели получают событие со значением false. Слушатели могут использовать этот шаблон, если им требуется обновление только после завершения изменения.

Установка этого свойства в true начинает серию изменений, которую следует считать одним изменением. Когда свойство снова устанавливается в false, отправляется событие, описывающее все изменение выборки (если оно произошло); свойству valueIsAdjusting этого события присваивается значение false.

Указано в:

setValueIsAdjusting в интерфейсе ListSelectionModel

Параметры:

isAdjusting — новое значение свойства

См. также:

toString

public String toString()

Возвращает строку, отображающую свойства этого объекта и позволяющую его идентифицировать.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление этого объекта String

clone

public Object clone() throws CloneNotSupportedException

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

Переопределяет:

clone в классе Object

Возвращает:

копию этого экземпляра.

Исключения:

CloneNotSupportedException — если модель выбора не (а) реализует интерфейс Cloneable и (б) не определяет метод clone.

См. также:

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

Возвращает первый индекс из последнего вызова setSelectionInterval(), addSelectionInterval() или removeSelectionInterval(). Последний index0 считается «опорным», а последний index1 — «ведущим». Некоторые интерфейсы отображают эти индексы особым образом: например, в Windows95 ведущий индекс выделяется желтой пунктирной рамкой.

Указано в:

getAnchorSelectionIndex в интерфейсе ListSelectionModel

Возвращает:

опорный индекс выборки

См. также:

getLeadSelectionIndex

public int getLeadSelectionIndex()

Возвращает второй индекс из последнего вызова setSelectionInterval(), addSelectionInterval() или removeSelectionInterval().

Указано в:

getLeadSelectionIndex в интерфейсе ListSelectionModel

Возвращает:

ведущий индекс выборки.

См. также:

setAnchorSelectionIndex

public void setAnchorSelectionIndex(int anchorIndex)

Задает опорный индекс выборки, не изменяя значения выборки. Если leadAnchorNotificationEnabled имеет значение true, отправляет уведомление, охватывающее старую и новую ячейки опорного индекса.

Указано в:

setAnchorSelectionIndex в интерфейсе ListSelectionModel

Параметры:

anchorIndex — опорный индекс выборки

См. также:

moveLeadSelectionIndex

public void moveLeadSelectionIndex(int leadIndex)

Задает ведущий индекс выборки, не изменяя значения выборки. Если leadAnchorNotificationEnabled имеет значение true, отправляет уведомление, охватывающее старую и новую ячейки ведущего индекса.

Параметры:

leadIndex — новый ведущий индекс выборки

С момента:

1.5

См. также:

setLeadSelectionIndex

public void setLeadSelectionIndex(int leadIndex)

Задает ведущий индекс выборки, обеспечивая выбор или отмену выбора всех значений между опорным и новым ведущим индексами. Если значение по опорному индексу выбрано, сначала отменяется выбор всех значений в диапазоне [anchor, oldLeadIndex], затем выбираются все значения в диапазоне [anchor, newLeadIndex], где oldLeadIndex — старый ведущий индекс, а newLeadIndex — новый.

Если значение по опорному индексу не выбрано, выполняется обратное действие: выбираются значения в старом диапазоне и отменяется выбор значений в новом.

Для этого изменения создается одно событие, которое отправляется всем слушателям. Чтобы задать минимальные границы события, операция выполняется за один проход; таким образом, первый и последний индексы внутри рассылаемого ListSelectionEvent будут соответствовать ячейкам, значения которых действительно изменились в результате вызова этого метода. Если выполнить операцию в два этапа, состояние выборки останется тем же, но будут созданы два события, а границы измененных значений окажутся шире и включат ячейки, выбор которых сначала был отменен и лишь затем установлен.

Этот метод можно использовать в методе mouseDragged класса пользовательского интерфейса для расширения выборки.

Указано в:

setLeadSelectionIndex в интерфейсе ListSelectionModel

Параметры:

leadIndex — ведущий индекс выборки

См. также:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.