Spec-Zone.ru › OpenJDK 17

Класс DefaultTreeSelectionModel

java.lang.Object
javax.swing.tree.DefaultTreeSelectionModel
Все реализуемые интерфейсы:
Serializable, Cloneable, TreeSelectionModel
Прямые известные подклассы:
JTree.EmptySelectionModel
public class DefaultTreeSelectionModel extends Object implements Cloneable, Serializable, TreeSelectionModel
Базовая реализация TreeSelectionModel. Слушатели уведомляются всякий раз, когда изменяются пути в выделении, а не строки. Для отслеживания изменений строк вы можете стать слушателем событий расширения дерева и проверить изменения оттуда.

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

См. также:
  • JTree

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

Модификатор и тип Поле Описание
protected SwingPropertyChangeSupport changeSupport
Используется для отправки сообщений зарегистрированным слушателям.
protected int leadIndex
Индекс ведущего пути в выборе.
protected TreePath leadPath
Последний добавленный путь.
protected int leadRow
Строка-лидер.
protected EventListenerList listenerList
Список слушателей событий.
protected DefaultListSelectionModel listSelectionModel
Обрабатывает поддержание модели выбора списка.
protected RowMapper rowMapper
Предоставляет строку для заданного пути.
protected TreePath[] selection
Пути, которые в настоящее время выбраны.
static final String SELECTION_MODE_PROPERTY
Имя свойства для selectionMode.
protected int selectionMode
Режим выбора, будет либо SINGLE_TREE_SELECTION, либо CONTIGUOUS_TREE_SELECTION, либо DISCONTIGUOUS_TREE_SELECTION.

Поля, объявленные в интерфейсе javax.swing.tree.TreeSelectionModel

CONTIGUOUS_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION, SINGLE_TREE_SELECTION

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

Конструктор Описание
DefaultTreeSelectionModel()
Создаёт новый экземпляр DefaultTreeSelectionModel, который пуст, с режимом выбора DISCONTIGUOUS_TREE_SELECTION.

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

Модификатор и тип Метод Описание
void addPropertyChangeListener(PropertyChangeListener listener)
Добавляет PropertyChangeListener в список слушателей.
void addSelectionPath(TreePath path)
Добавляет путь к текущему выбору.
void addSelectionPaths(TreePath[] paths)
Добавляет пути к текущему выбору.
void addTreeSelectionListener(TreeSelectionListener x)
Добавляет x в список слушателей, которые уведомляются каждый раз, когда изменяется набор выбранных TreePath.
protected boolean arePathsContiguous(TreePath[] paths)
Возвращает true, если пути являются смежными, или у этого объекта нет RowMapper.
protected boolean canPathsBeAdded(TreePath[] paths)
Используется для проверки, можно ли добавить определённый набор TreePath.
protected boolean canPathsBeRemoved(TreePath[] paths)
Возвращает true, если пути можно удалить без нарушения непрерывности модели.
void clearSelection()
Очищает текущий выбор.
Object clone()
Возвращает клон этого объекта с тем же выбором.
protected void fireValueChanged(TreeSelectionEvent e)
Уведомляет всех зарегистрированных слушателей об изменениях в выбранных элементах дерева.
TreePath getLeadSelectionPath()
Возвращает последний добавленный путь.
int getLeadSelectionRow()
Возвращает индекс ведущего элемента выбора.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Возвращает массив всех объектов, которые в настоящее время зарегистрированы как FooListener в этой модели.
int getMaxSelectionRow()
Возвращает наибольшее значение, полученное от RowMapper для текущего набора выбранных TreePath.
int getMinSelectionRow()
Возвращает наименьшее значение, полученное от RowMapper для текущего набора выбранных TreePath.
PropertyChangeListener[] getPropertyChangeListeners()
Возвращает массив всех слушателей изменений свойств, зарегистрированных на этом DefaultTreeSelectionModel.
RowMapper getRowMapper()
Возвращает экземпляр RowMapper, который может сопоставлять TreePath со строкой.
int getSelectionCount()
Возвращает количество выбранных путей.
int getSelectionMode()
Возвращает режим выбора, один из SINGLE_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION или CONTIGUOUS_TREE_SELECTION.
TreePath getSelectionPath()
Возвращает первый путь в выборе.
TreePath[] getSelectionPaths()
Возвращает выбор.
int[] getSelectionRows()
Возвращает выбор в терминах строк.
TreeSelectionListener[] getTreeSelectionListeners()
Возвращает массив всех слушателей выбора дерева, зарегистрированных в этой модели.
protected void insureRowContinuity()
Убеждается, что в настоящее время выбранные TreePath допустимы для текущего режима выбора.
protected void insureUniqueness()
Этот метод устарел и его реализация сейчас является noop.
boolean isPathSelected(TreePath path)
Возвращает true, если путь, path, находится в текущем выборе.
boolean isRowSelected(int row)
Возвращает true, если строка, идентифицированная по row, выбрана.
boolean isSelectionEmpty()
Возвращает true, если выбор в настоящее время пуст.
protected void notifyPathChange(Vector<?> changedPaths, TreePath oldLeadSelection)
Устарело.
С версии JDK 1.7
void removePropertyChangeListener(PropertyChangeListener listener)
Удаляет PropertyChangeListener из списка слушателей.
void removeSelectionPath(TreePath path)
Удаляет путь из выбора.
void removeSelectionPaths(TreePath[] paths)
Удаляет пути из выбора.
void removeTreeSelectionListener(TreeSelectionListener x)
Удаляет x из списка слушателей, которые уведомляются каждый раз, когда изменяется набор выбранных TreePaths.
void resetRowSelection()
Обновляет сопоставление объекта между TreePath и строками.
void setRowMapper(RowMapper newMapper)
Устанавливает экземпляр RowMapper.
void setSelectionMode(int mode)
Устанавливает модель выбора, которая должна быть одной из SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION или DISCONTIGUOUS_TREE_SELECTION.
void setSelectionPath(TreePath path)
Устанавливает выбор на путь.
void setSelectionPaths(TreePath[] pPaths)
Устанавливает выбор.
String toString()
Возвращает строку, отображающую и идентифицирующую свойства этого объекта.
protected void updateLeadIndex()
Обновляет переменную leadIndex.

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

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

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

SELECTION_MODE_PROPERTY

public static final String SELECTION_MODE_PROPERTY
Имя свойства для selectionMode.
См. также:
  • Значения константных полей

changeSupport

protected SwingPropertyChangeSupport changeSupport
Используется для отправки сообщений зарегистрированным слушателям.

selection

protected TreePath[] selection
Пути, которые в настоящее время выбраны. Будет равно null, если ничего не выбрано.

listenerList

protected EventListenerList listenerList
Список слушателей событий.

rowMapper

protected transient RowMapper rowMapper
Предоставляет строку для заданного пути.

listSelectionModel

protected DefaultListSelectionModel listSelectionModel
Обрабатывает поддержание модели выбора списка. RowMapper используется для сопоставления TreePath со строкой, а значение затем помещается сюда.

selectionMode

protected int selectionMode
Режим выбора, будет либо SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION, или DISCONTIGUOUS_TREE_SELECTION.

leadPath

protected TreePath leadPath
Последний добавленный путь.

leadIndex

protected int leadIndex
Индекс ведущего пути в выборе.

leadRow

protected int leadRow
Ведущий ряд.

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

DefaultTreeSelectionModel

public DefaultTreeSelectionModel()
Создаёт новый экземпляр DefaultTreeSelectionModel, пустой, с режимом выбора DISCONTIGUOUS_TREE_SELECTION.

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

setRowMapper

public void setRowMapper(RowMapper newMapper)
Устанавливает экземпляр RowMapper. Этот экземпляр используется для определения строки для конкретного TreePath.
Указано в:
setRowMapper в интерфейсе TreeSelectionModel
Параметры:
newMapper - RowMapper для установки

getRowMapper

public RowMapper getRowMapper()
Возвращает экземпляр RowMapper, способный сопоставлять TreePath со строкой.
Указано в:
getRowMapper в интерфейсе TreeSelectionModel
Возвращает:
экземпляр RowMapper, способный сопоставлять TreePath со строкой

setSelectionMode

public void setSelectionMode(int mode)
Устанавливает модель выбора, которая должна быть одной из SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION или DISCONTIGUOUS_TREE_SELECTION. Если режим не соответствует одному из определенных значений, предполагается DISCONTIGUOUS_TREE_SELECTION.

Это может изменить выбор, если текущий выбор не действителен для нового режима. Например, если три TreePath выбраны, когда режим изменяется на SINGLE_TREE_SELECTION, останется только один TreePath. Реализация должна решить, какой TreePath останется выбранным.

Установка режима на значение, отличное от определенных типов, приведет к тому, что режим станет DISCONTIGUOUS_TREE_SELECTION.

Указано в:
setSelectionMode в интерфейсе TreeSelectionModel
Параметры:
mode - устанавливаемый режим выбора

getSelectionMode

public int getSelectionMode()
Возвращает режим выбора, один из SINGLE_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION или CONTIGUOUS_TREE_SELECTION.
Указано в:
getSelectionMode в интерфейсе TreeSelectionModel
Возвращает:
текущий режим выбора

setSelectionPath

public void setSelectionPath(TreePath path)
Устанавливает выбор на путь. Если это изменение, то TreeSelectionListeners уведомляются. Если path равно null, это эквивалентно вызову clearSelection.
Указано в:
setSelectionPath в интерфейсе TreeSelectionModel
Параметры:
path - новый путь для выбора

setSelectionPaths

public void setSelectionPaths(TreePath[] pPaths)
Устанавливает выбор. В зависимости от режима выбора, предоставленные пути принимаются в качестве нового выбора. Если предоставленный массив null, или пустой, выбор очищается. Если режим выбора SINGLE_TREE_SELECTION, используется только первый путь в pPaths. Если режим выбора CONTIGUOUS_TREE_SELECTION и предоставленные пути не являются смежными, используется только первый путь в pPaths. Если режим выбора DISCONTIGUOUS_TREE_SELECTION, используются все пути.

Все null пути в pPaths игнорируются.

Если это изменение, все зарегистрированные TreeSelectionListener уведомляются.

Ведущий путь устанавливается на последний уникальный путь.

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

Указано в:
setSelectionPaths в интерфейсе TreeSelectionModel
Параметры:
pPaths - новый выбор

addSelectionPath

public void addSelectionPath(TreePath path)
Добавляет путь к текущему выбору. Если путь не в текущем выборе, TreeSelectionListeners уведомляются. Если path равно null, это не оказывает влияния.
Указано в:
addSelectionPath в интерфейсе TreeSelectionModel
Параметры:
path - новый путь для добавления к текущему выбору

addSelectionPaths

public void addSelectionPaths(TreePath[] paths)
Добавляет пути к текущему выбору. Если какой-либо из путей в paths не в текущем выборе, TreeSelectionListeners уведомляются. Если paths равно null, это не оказывает влияния.

Ведущий путь устанавливается на последний элемент в paths.

Если режим выбора CONTIGUOUS_TREE_SELECTION, и добавление новых путей сделает выбор несмежным. Тогда могут произойти два события: если TreePaths в paths смежные, то выбор становится этими TreePaths, в противном случае TreePaths не смежные и выбор становится первым TreePath в paths.

Указано в:
addSelectionPaths в интерфейсе TreeSelectionModel
Параметры:
paths - новый путь для добавления к текущему выбору

removeSelectionPath

public void removeSelectionPath(TreePath path)
Удаляет путь из выбора. Если путь был в выборе, TreeSelectionListeners уведомляются. Если path равно null, это не оказывает влияния.
Указано в:
removeSelectionPath в интерфейсе TreeSelectionModel
Параметры:
path - путь для удаления из выбора

removeSelectionPaths

public void removeSelectionPaths(TreePath[] paths)
Удаляет пути из выбора. Если какой-либо из путей в paths был в выборе, TreeSelectionListeners уведомляются. Если paths равно null, это не оказывает влияния.
Указано в:
removeSelectionPaths в интерфейсе TreeSelectionModel
Параметры:
paths - пути для удаления из выбора

getSelectionPath

public TreePath getSelectionPath()
Возвращает первый путь в выборе. Это полезно, если выбран только один элемент.
Указано в:
getSelectionPath в интерфейсе TreeSelectionModel
Возвращает:
первый путь в выборе

getSelectionPaths

public TreePath[] getSelectionPaths()
Возвращает выбор.
Указано в:
getSelectionPaths в интерфейсе TreeSelectionModel
Возвращает:
выбор

getSelectionCount

public int getSelectionCount()
Возвращает количество выбранных путей.
Указано в:
getSelectionCount в интерфейсе TreeSelectionModel
Возвращает:
количество выбранных путей

isPathSelected

public boolean isPathSelected(TreePath path)
Возвращает true, если путь, path, находится в текущем выборе.
Указано в:
isPathSelected в интерфейсе TreeSelectionModel
Параметры:
path - путь для проверки
Возвращает:
является ли path частью текущего выбора

isSelectionEmpty

public boolean isSelectionEmpty()
Возвращает true, если выбор пуст.
Указано в:
isSelectionEmpty в интерфейсе TreeSelectionModel
Возвращает:
является ли выбор пустым

clearSelection

public void clearSelection()
Очищает текущий выбор. Если это изменение текущего выбора, то уведомляются слушатели выбора.
Specified by:
clearSelection в интерфейсе TreeSelectionModel

addTreeSelectionListener

public void addTreeSelectionListener(TreeSelectionListener x)
Добавляет x в список слушателей, которые уведомляются каждый раз, когда изменяется набор выбранных TreePath.
Specified by:
addTreeSelectionListener в интерфейсе TreeSelectionModel
Parameters:
x - новый добавляемый слушатель

removeTreeSelectionListener

public void removeTreeSelectionListener(TreeSelectionListener x)
Удаляет x из списка слушателей, которые уведомляются каждый раз, когда изменяется набор выбранных TreePaths.
Specified by:
removeTreeSelectionListener в интерфейсе TreeSelectionModel
Parameters:
x - слушатель для удаления

getTreeSelectionListeners

public TreeSelectionListener[] getTreeSelectionListeners()
Возвращает массив всех зарегистрированных слушателей выбора узлов в этой модели.
Returns:
все слушатели этой модели или пустой массив, если слушатели выбора узлов не зарегистрированы
Since:
1.4
See Also:
  • addTreeSelectionListener(javax.swing.event.TreeSelectionListener)
  • removeTreeSelectionListener(javax.swing.event.TreeSelectionListener)

fireValueChanged

protected void fireValueChanged(TreeSelectionEvent e)
Уведомляет всех зарегистрированных слушателей событий выбора узлов об этом объекте.
Parameters:
e - событие, характеризующее изменение
See Also:
  • addTreeSelectionListener(javax.swing.event.TreeSelectionListener)
  • EventListenerList

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных как FooListener для данной модели. FooListener регистрируются с помощью метода addFooListener.

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

TreeSelectionListener[] tsls = (TreeSelectionListener[])(m.getListeners(TreeSelectionListener.class));
Если таких слушателей нет, этот метод возвращает пустой массив.
Type Parameters:
T - тип слушателя
Parameters:
listenerType - тип запрашиваемых слушателей
Returns:
массив всех объектов, зарегистрированных как FooListener для этого компонента, или пустой массив, если такие слушатели не добавлены
Throws:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
Since:
1.3
See Also:
  • getTreeSelectionListeners()
  • getPropertyChangeListeners()

getSelectionRows

public int[] getSelectionRows()
Возвращает выбор в терминах строк. Не обязательно существует взаимно однозначное соответствие между TreePath возвращаемыми getSelectionPaths и этим методом. В частности, если TreePath не отображается ( RowMapper возвращает -1 для строки, соответствующей TreePath), то соответствующая строка не включается в возвращаемый массив. Например, если выбор состоит из двух путей, A и B, с A в строке 10, и B не отображается в данный момент, то этот метод возвращает массив с единственным элементом 10.
Specified by:
getSelectionRows в интерфейсе TreeSelectionModel
Returns:
выбор в терминах строк

getMinSelectionRow

public int getMinSelectionRow()
Возвращает наименьшее значение, полученное из RowMapper для текущего набора выбранных TreePaths. Если ничего не выбрано или RowMapper отсутствует, возвращается -1.
Specified by:
getMinSelectionRow в интерфейсе TreeSelectionModel
Returns:
наименьшее значение, полученное из RowMapper для текущего набора выбранных TreePaths

getMaxSelectionRow

public int getMaxSelectionRow()
Возвращает наибольшее значение, полученное из RowMapper для текущего набора выбранных TreePaths. Если ничего не выбрано или RowMapper отсутствует, возвращается -1.
Specified by:
getMaxSelectionRow в интерфейсе TreeSelectionModel
Returns:
наибольшее значение, полученное из RowMapper для текущего набора выбранных TreePaths

isRowSelected

public boolean isRowSelected(int row)
Возвращает true, если строка, идентифицируемая row, выбрана.
Specified by:
isRowSelected в интерфейсе TreeSelectionModel
Parameters:
row - строка для проверки
Returns:
выбрана ли строка

resetRowSelection

public void resetRowSelection()
Обновляет отображение этого объекта из TreePath в строки. Этот метод следует вызывать, когда отображение TreePaths в целые числа изменилось (например, узел был раскрыт).

Обычно вызывать этот метод не нужно, JTree и его связанные слушатели вызывают его за вас. Если вы реализуете свой собственный класс View, то вам нужно будет вызвать этот метод.

Это вызовет insureRowContinuity для проверки, остаются ли текущие выбранные TreePaths действительными на основе режима выбора.

Specified by:
resetRowSelection в интерфейсе TreeSelectionModel

getLeadSelectionRow

public int getLeadSelectionRow()
Возвращает индекс ведущего выбора. Это последний добавленный индекс.
Specified by:
getLeadSelectionRow в интерфейсе TreeSelectionModel
Returns:
индекс ведущего выбора

getLeadSelectionPath

public TreePath getLeadSelectionPath()
Возвращает последний добавленный путь. Он может отличаться от свойства leadSelectionPath, поддерживаемого JTree.
Specified by:
getLeadSelectionPath в интерфейсе TreeSelectionModel
Returns:
последний добавленный путь

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Добавляет PropertyChangeListener в список слушателей. Слушатель регистрируется для всех свойств.

PropertyChangeEvent будет сгенерирован при изменении режима выбора.

Specified by:
addPropertyChangeListener в интерфейсе TreeSelectionModel
Parameters:
listener - добавляемый PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Удаляет PropertyChangeListener из списка слушателей. Удаляется PropertyChangeListener, зарегистрированный для всех свойств.
Specified by:
removePropertyChangeListener в интерфейсе TreeSelectionModel
Parameters:
listener - удаляемый PropertyChangeListener

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()
Возвращает массив всех зарегистрированных слушателей изменений свойств для этого DefaultTreeSelectionModel.
Returns:
все слушатели изменений свойств этой модели или пустой массив, если слушатели изменений свойств не зарегистрированы
Since:
1.4
See Also:
  • addPropertyChangeListener(java.beans.PropertyChangeListener)
  • removePropertyChangeListener(java.beans.PropertyChangeListener)

insureRowContinuity

protected void insureRowContinuity()
Обеспечивает, что текущие выбранные TreePaths действительны для текущего режима выбора. Если режим выбора CONTIGUOUS_TREE_SELECTION и RowMapper существует, это гарантирует, что все строки являются смежными, то есть при сортировке все строки упорядочены без пробелов. Если выбор не смежный, выбор сбрасывается, чтобы содержать первую сортированную группу смежных строк.

Если режим выбора SINGLE_TREE_SELECTION и выбрано более одного TreePath, выбор сбрасывается, чтобы содержать первый выбранный путь.

arePathsContiguous

protected boolean arePathsContiguous(TreePath[] paths)
Возвращает true, если пути смежные, или у этого объекта нет RowMapper.
Parameters:
paths - массив путей для проверки
Returns:
смежные ли пути, или у объекта нет RowMapper

canPathsBeAdded

protected boolean canPathsBeAdded(TreePath[] paths)
Используется для проверки, можно ли добавить определенный набор TreePath. Возвращает true, если paths равно null (или пусто), у этого объекта нет RowMapper, ничего не выбрано, режим выбора DISCONTIGUOUS_TREE_SELECTION, или добавление путей к текущему выбору всё ещё приводит к непрерывному набору TreePath.
Parameters:
paths - массив TreePaths для проверки
Returns:
можно ли добавить указанный набор TreePaths

canPathsBeRemoved

protected boolean canPathsBeRemoved(TreePath[] paths)
Возвращает true, если пути можно удалить без нарушения непрерывности модели. Это достаточно ресурсоёмко.
Parameters:
paths - массив TreePath для проверки
Returns:
можно ли удалить пути без нарушения непрерывности модели

notifyPathChange

@Deprecated protected void notifyPathChange(Vector<?> changedPaths, TreePath oldLeadSelection)
Устарело.
Начиная с версии JDK 1.7
Уведомляет слушателей об изменении пути. changePaths должен содержать экземпляры PathPlaceHolder.
Parameters:
changedPaths - вектор изменённых путей
oldLeadSelection - старый путь выделения

updateLeadIndex

protected void updateLeadIndex()
Обновляет переменную leadIndex.

insureUniqueness

protected void insureUniqueness()
Этот метод устарел и его реализация теперь является пустой операцией. Он всё ещё вызывается методами setSelectionPaths и addSelectionPaths, но только для обратной совместимости.

toString

public String toString()
Возвращает строку, отображающую и идентифицирующую свойства этого объекта.
Overrides:
toString в классе Object
Returns:
строковое представление этого объекта

clone

public Object clone() throws CloneNotSupportedException
Возвращает клон этого объекта с тем же выделением. Этот метод не дублирует слушателей выделения и слушателей свойств.
Overrides:
clone в классе Object
Returns:
клон этого экземпляра.
Throws:
CloneNotSupportedException - никогда не выбрасывается экземплярами этого класса
See Also:
  • Cloneable

© 1993, 2021, 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.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/tree/DefaultTreeSelectionModel.html

Spec-Zone.ru

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