TreeView
Иерархический древовидный контейнер со сворачиваемыми узлами, кастомными иконками, инлайн-редактированием и выбором.
Обзор
Иерархический древовидный контейнер со сворачиваемыми узлами, кастомными иконками, инлайн-редактированием и выбором. Предоставляет широкие возможности настройки компоновки и взаимодействия.
Базовое использование
TreeView tree = new TreeView();
TreeViewNode root = tree.addRoot("Project");
root.addChild("src");
root.addChild("build.gradle");
Связанные ссылки
- TreeList: Специализированный древовидный список TreeView для иерархической навигации по путям и файловой структуре.
API
TreeView()
Создает пустой древовидный контейнер TreeView.
TreeView::addRoot(RichText)
Создает и добавляет корневой узел с форматированной меткой RichText.
| Параметр | Тип | Описание |
|---|---|---|
text |
RichText |
Форматированный текст метки. |
Возвращает TreeViewNode: Экземпляр узла дерева..
TreeView::addRoot(String)
Создает и добавляет корневой узел с текстовой меткой.
| Параметр | Тип | Описание |
|---|---|---|
text |
String |
Текстовая метка. |
Возвращает TreeViewNode: Экземпляр узла дерева..
TreeView::addRoot(TreeViewNode)
Добавляет существующий узел в качестве корневого.
| Параметр | Тип | Описание |
|---|---|---|
node |
TreeViewNode |
Экземпляр узла дерева. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::beginBatch()
Начинает сессию пакетного обновления, откладывая перерасчет компоновки.
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::cancelEditing()
Отменяет активную сессию инлайн-редактирования без сохранения изменений.
TreeView::clearRoots()
Удаляет все корневые узлы из дерева.
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::clearSelection()
Снимает выбор со всех узлов дерева.
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::editingNode()
Возвращает редактируемый в данный момент узел, или null.
Возвращает TreeViewNode: Редактируемый в данный момент узел или null..
TreeView::endBatch()
Завершает сессию пакетного обновления, перестраивая строки дерева при наличии изменений.
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::hoverScrollSpeed()
Возвращает скорость прокрутки текста при наведении.
Возвращает float: Скорость прокрутки при наведении в пикселях в секунду..
TreeView::hoverScrollSpeed(float)
Устанавливает скорость прокрутки текста при наведении.
| Параметр | Тип | Описание |
|---|---|---|
pixelsPerSecond |
float |
Скорость прокрутки в пикселях в секунду. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::iconMode()
Возвращает текущий режим отображения иконок дерева.
Возвращает TreeIconMode: Режим отображения иконок дерева..
TreeView::iconMode(TreeIconMode)
Устанавливает режим отображения иконок дерева.
| Параметр | Тип | Описание |
|---|---|---|
iconMode |
TreeIconMode |
Режим отображения иконок дерева. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::insertRoot(int, TreeViewNode)
Вставляет корневой узел по указанному индексу.
| Параметр | Тип | Описание |
|---|---|---|
index |
int |
Позиция индекса. |
node |
TreeViewNode |
Экземпляр узла дерева. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::isBatching()
Возвращает true, если активен режим пакетного обновления.
Возвращает boolean: true, если активен пакетный режим обновления..
TreeView::isEditing()
Возвращает true, если в данный момент активно инлайн-редактирование метки узла.
Возвращает boolean: true, если активно инлайн-редактирование..
TreeView::onRowCreated()
Возвращает слушателя создания строк дерева.
Возвращает Consumer: Результирующее значение..
TreeView::onRowCreated(Consumer)
Регистрирует слушателя создания и перепривязки кнопок строк дерева.
| Параметр | Тип | Описание |
|---|---|---|
listener |
Consumer |
Колбэк слушателя события. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::onSelectionChanged(EventListener)
Регистрирует слушателя события изменения выбранного узла.
| Параметр | Тип | Описание |
|---|---|---|
listener |
EventListener |
Колбэк слушателя события. |
Возвращает EventSubscription: Дескриптор подписки на событие..
TreeView::removeRoot(TreeViewNode)
Удаляет указанный корневой узел из дерева.
| Параметр | Тип | Описание |
|---|---|---|
node |
TreeViewNode |
Экземпляр узла дерева. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::root(int)
Возвращает корневой узел по указанному индексу.
| Параметр | Тип | Описание |
|---|---|---|
index |
int |
Позиция индекса. |
Возвращает TreeViewNode: Корневой узел по указанному индексу..
TreeView::rootCount()
Возвращает общее количество корневых узлов дерева.
Возвращает int: Количество корневых узлов..
TreeView::roots()
Возвращает неизменяемый список корневых узлов верхнего уровня.
Возвращает List: Неизменяемый список корневых узлов..
TreeView::rowTextHoverScrollSpeed()
Возвращает скорость прокрутки текста при наведении в пикселях в секунду.
Возвращает float: Скорость прокрутки при наведении в пикселях в секунду..
TreeView::rowTextHoverScrollSpeed(float)
Устанавливает скорость прокрутки текста при наведении в пикселях в секунду.
| Параметр | Тип | Описание |
|---|---|---|
pixelsPerSecond |
float |
Скорость прокрутки в пикселях в секунду. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::rowsHost()
Возвращает вертикальный контейнер строк кнопок узлов дерева.
Возвращает VBox: Контейнер строк кнопок дерева..
TreeView::select(TreeViewNode)
Выбирает указанный узел и вызывает событие смены выбора.
| Параметр | Тип | Описание |
|---|---|---|
node |
TreeViewNode |
Экземпляр узла дерева. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::selectedIndex()
Возвращает видимый индекс выбранного узла дерева.
Возвращает int: Индекс выбранного элемента или -1, если выбор отсутствует..
TreeView::selectedNode()
Возвращает выбранный в данный момент узел дерева, или null.
Возвращает TreeViewNode: Выбранный в данный момент узел или null..
TreeView::selectedPath()
Возвращает иерархический индексный путь выбранного узла.
Возвращает List: Индексный путь выбранного узла..
TreeView::silentSelect(TreeViewNode)
Выбирает указанный узел без генерации события смены выбора.
| Параметр | Тип | Описание |
|---|---|---|
node |
TreeViewNode |
Экземпляр узла дерева. |
Возвращает TreeView: Текущий экземпляр для цепочки вызовов..
TreeView::startEditing(TreeViewNode, Consumer)
Запускает инлайн-редактирование текста узла с настройками по умолчанию.
| Параметр | Тип | Описание |
|---|---|---|
node |
TreeViewNode |
Экземпляр узла дерева. |
onCommit |
Consumer |
Колбэк подтверждения завершения редактирования. |
TreeView::startEditing(TreeViewNode, Consumer, Consumer)
Запускает инлайн-редактирование текста узла с кастомной настройкой поля ввода.
| Параметр | Тип | Описание |
|---|---|---|
node |
TreeViewNode |
Экземпляр узла дерева. |
config |
Consumer |
Колбэк конфигурации текстового поля ввода. |
onCommit |
Consumer |
Колбэк подтверждения завершения редактирования. |
TreeView::stopEditing()
Подтверждает и закрывает активную сессию инлайн-редактирования.
TreeView::visibleNodes()
Возвращает неизменяемый список всех видимых развернутых узлов дерева.
Возвращает List: Неизменяемый список видимых узлов дерева..