SearchableGridPickerWidget

Abstract searchable dialog picker displaying items in a virtualized grid with preview, filter, and tooltip.

Overview

SearchableGridPickerWidget<T> provides a complete modal picker architecture. Clicking the preview button opens a dialog window hosting a SearchField, a virtualized VirtualListView grid of items, and tooltips.

Custom Item Picker

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()

Clear Query

Clears search filter query.

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::clearSelection()

Clear Selection

Deselects currently selected item.

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::close()

Close Dialog

Closes search and selection dialog window.

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::dialog()

Dialog Window

Returns modal dialog WindowWidget.

Returns WindowWidget.

SearchableGridPickerWidget::entries()

Get Entries

Returns unmodifiable list of all registered entries.

Returns List.

SearchableGridPickerWidget::entries(Collection)

Set Entries

Populates selectable items collection.

Parameter	Type	Description
entries	Collection	—

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::entryCount()

Entry Count

Returns total count of registered entries.

Returns int.

SearchableGridPickerWidget::filteredEntries()

Filtered Entries

Returns list of entries matching current search query.

Returns List.

SearchableGridPickerWidget::onSelectionChanged(EventListener)

On Selection Changed

Registers callback triggered when selected item changes.

Parameter	Type	Description
listener	EventListener	—

Returns EventSubscription.

SearchableGridPickerWidget::open()

Open Dialog

Opens search and selection dialog window.

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::openButton()

Open Button

Returns trigger button opening the dialog.

Returns Button.

SearchableGridPickerWidget::opened()

Is Dialog Opened

Returns whether dialog window is currently visible.

Returns boolean.

SearchableGridPickerWidget::query()

Get Query

Returns active search filter query string.

Returns String.

SearchableGridPickerWidget::query(String)

Set Query

Sets search filter query and refreshes grid.

Parameter	Type	Description
query	String	—

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::resultGrid()

Result Grid

Returns virtualized list view hosting grid items.

Returns VirtualListView.

SearchableGridPickerWidget::searchField()

Search Field

Returns internal SearchField widget in the dialog.

Returns SearchField.

SearchableGridPickerWidget::selectIndex(int)

Select By Index

Selects entry at index in master list.

Parameter	Type	Description
index	int	—

Returns SearchableGridPickerWidget.

SearchableGridPickerWidget::selectedEntry()

Selected Entry

Returns optional containing selected item.

Returns Optional.

SearchableGridPickerWidget::selectedPreview()

Selected Preview

Returns widget displaying preview of current selection.

Returns WidgetBase.