Breadcrumb

Интерактивная цепочка навигации («хлебные крошки»), отображающая иерархические элементы с настраиваемыми разделителями и обработкой выбора.

Обзор

Интерактивная цепочка навигации («хлебные крошки»), отображающая иерархические элементы с настраиваемыми разделителями и обработкой выбора. Предоставляет широкие возможности настройки компоновки и взаимодействия.

Базовое использование

Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.addItem("Home").addItem("Settings");

Связанные ссылки

• BreadcrumbItem: Дескриптор навигационного элемента, представляющий шаг или крошку в цепочке навигации.

API

Breadcrumb()

Создает пустую навигационную цепочку Breadcrumb.

Breadcrumb::addItem(BreadcrumbItem)

Добавляет элемент BreadcrumbItem в навигационную цепочку.

Параметр	Тип	Описание
item	BreadcrumbItem	Целевой элемент.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::addItem(RichText)

Создает и добавляет элемент навигационной цепочки с форматированной меткой RichText.

Параметр	Тип	Описание
text	RichText	Текстовая метка.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::addItem(String)

Создает и добавляет элемент навигационной цепочки с текстовой меткой.

Параметр	Тип	Описание
text	String	Текстовая метка.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::breadcrumbItems(List)

Возвращает неизменяемый список объектов BreadcrumbItem цепочки.

Параметр	Тип	Описание
items	List	Коллекция элементов.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::clearItems()

Очищает все элементы навигационной цепочки.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::host()

Возвращает контейнер LinearBox, размещающий кнопки элементов цепочки.

Возвращает WrapPanel: Контейнер, содержащий элементы..

Breadcrumb::itemButton(int)

Возвращает виджет кнопки для элемента цепочки по указанному индексу.

Параметр	Тип	Описание
index	int	Позиция индекса.

Возвращает Button: Связанный компонент кнопки..

Breadcrumb::itemCount()

Возвращает общее количество элементов в навигационной цепочке.

Возвращает int: Общее количество элементов..

Breadcrumb::items()

Возвращает список текстовых меток элементов цепочки.

Возвращает List: Неизменяемый список элементов-узлов..

Breadcrumb::items(List)

Задает элементы цепочки из массива текстовых строк.

Параметр	Тип	Описание
items	List	Коллекция элементов.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::lineSpacing(float)

Устанавливает вертикальный интервал строк при переносе цепочки.

Параметр	Тип	Описание
lineSpacing	float	Межстрочный интервал в пикселях.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::onSelectionChanged(EventListener)

Регистрирует слушателя события смены выбранного элемента цепочки.

Параметр	Тип	Описание
listener	EventListener	Колбэк слушателя события.

Возвращает EventSubscription: Дескриптор подписки на событие..

Breadcrumb::removeItem(int)

Удаляет указанный элемент из навигационной цепочки.

Параметр	Тип	Описание
index	int	Позиция индекса.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::richItems(List)

Задает элементы цепочки из массива форматированных строк RichText.

Параметр	Тип	Описание
items	List	Коллекция элементов.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::selectedIndex()

Возвращает индекс текущего выбранного элемента цепочки.

Возвращает int: Результирующее значение..

Breadcrumb::selectedIndex(int)

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

Параметр	Тип	Описание
index	int	Позиция индекса.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::selectedItem()

Возвращает выбранный элемент навигационной цепочки, или null.

Возвращает BreadcrumbItem: Экземпляр элемента-узла или null, если не найден..

Breadcrumb::selectedPath()

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

Возвращает List: Неизменяемый список элементов-узлов..

Breadcrumb::separator()

Возвращает текстовую строку разделителя элементов цепочки.

Возвращает String: Экземпляр виджета-разделителя..

Breadcrumb::separator(String)

Устанавливает текстовый разделитель между элементами навигационной цепочки.

Параметр	Тип	Описание
separator	String	Кастомный виджет-разделитель.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::silentSelectedIndex(int)

Выбирает элемент цепочки по индексу без вызова событий смены выбора.

Параметр	Тип	Описание
index	int	Позиция индекса.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..

Breadcrumb::spacing(float)

Устанавливает горизонтальный интервал между элементами в пикселях.

Параметр	Тип	Описание
spacing	float	Расстояние между элементами в пикселях.

Возвращает Breadcrumb: Текущий экземпляр для цепочки вызовов..