Перейти к содержанию

SearchableGridPickerWidget

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

Обзор

SearchableGridPickerWidget<T> реализует модальный выбор элементов. Нажатие на кнопку предпросмотра открывает диалоговое окно WindowWidget с поисковой строкой SearchField, виртуализированной сеткой элементов VirtualListView и всплывающими подсказками.

Реализация кастомного пикера

public class ItemPicker extends SearchableGridPickerWidget<ItemDefinition> {
    @Override
    protected String entryIdText(ItemDefinition entry) {
        return entry.id();
    }
    @Override
    protected String searchText(ItemDefinition entry) {
        return entry.name();
    }
}

API

SearchableGridPickerWidget::clearQuery()

Очистить поисковый запрос

Очищает строку поискового запроса.

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::clearSelection()

Сбросить выбор

Сбрасывает текущий выбранный элемент.

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::close()

Закрыть диалог

Закрывает диалоговое окно выбора.

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::dialog()

Диалоговое окно

Возвращает модальное диалоговое окно WindowWidget.

Возвращает WindowWidget.

SearchableGridPickerWidget::entries()

Получить список элементов

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

Возвращает List.

SearchableGridPickerWidget::entries(Collection)

Задать список элементов

Заполняет коллекцию элементов, доступных для выбора.

Параметр Тип Описание
entries Collection —

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::entryCount()

Количество элементов

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

Возвращает int.

SearchableGridPickerWidget::filteredEntries()

Отфильтрованные элементы

Возвращает список элементов, соответствующих текущему поисковому запросу.

Возвращает List.

SearchableGridPickerWidget::onSelectionChanged(EventListener)

Слушатель изменения выбора

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

Параметр Тип Описание
listener EventListener —

Возвращает EventSubscription.

SearchableGridPickerWidget::open()

Открыть диалог

Открывает диалоговое окно поиска и выбора.

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::openButton()

Кнопка открытия

Возвращает кнопку-триггер для открытия модального окна.

Возвращает Button.

SearchableGridPickerWidget::opened()

Состояние открытия диалога

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

Возвращает boolean.

SearchableGridPickerWidget::query()

Получить поисковый запрос

Возвращает текущую строку поискового запроса.

Возвращает String.

SearchableGridPickerWidget::query(String)

Задать поисковый запрос

Устанавливает поисковый запрос и обновляет сетку результатов.

Параметр Тип Описание
query String —

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::resultGrid()

Виртуализированная сетка

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

Возвращает VirtualListView.

SearchableGridPickerWidget::searchField()

Поле поиска

Возвращает виджет строки поиска внутри диалогового окна.

Возвращает SearchField.

SearchableGridPickerWidget::selectIndex(int)

Выбрать по индексу

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

Параметр Тип Описание
index int —

Возвращает SearchableGridPickerWidget.

SearchableGridPickerWidget::selectedEntry()

Выбранный элемент

Возвращает Optional с выбранным элементом.

Возвращает Optional.

SearchableGridPickerWidget::selectedPreview()

Виджет предпросмотра

Возвращает виджет отображения текущего выбранного элемента.

Возвращает WidgetBase.