3.5.2.1.29. OptionsList
LIVE DEMO
API DOCS

OptionsList is a variation of the OptionsGroup component which represents the list of options as a vertical scrollable list. If multi-select is enabled, multiple items can be selected by holding the Ctrl key while clicking, or as a range by holding the Shift key.

gui optionsList

XML name of the component: optionsList.

The OptionsList component is implemented for Web Client.

By default the OptionsList component displays the first null element in suggestion popup, this can be disabled with the help of nullOptionVisible attribute set to false.

The addDoubleClickListener() method allows you to listen to DoubleClickEvent which is sent when a user double-clicks on the component options.

optionsList.addDoubleClickListener(doubleClickEvent ->
        notifications.create()
        .withCaption("Double clicked")
        .show());

For the same purpose, you can subscribe to the event in the screen controller, for example:

@Subscribe("optionsList")
private void onOptionsListDoubleClick(OptionsList.DoubleClickEvent event) {
    notifications.create()
            .withCaption("Double clicked")
            .show();
}

The only difference in API between OptionsList and OptionsGroup is that OptionsList has no orientation attribute.

Attributes of optionsList

align - caption - captionAsHtml - captionProperty - contextHelpText - contextHelpTextHtmlEnabled - css - dataContainer - description - descriptionAsHtml - editable - enable - box.expandRatio - height - htmlSanitizerEnabled - icon - id - multiselect - nullOptionVisible - optionsContainer - optionsEnum - property - required - requiredMessage - stylename - tabIndex - visible - width

Elements of optionsList

validator

API

addDoubleClickListener - addValueChangeListener - setContextHelpIconClickHandler - setOptionCaptionProvider