3.6.1.1.3. Экран выбора

Это устаревший API. Новый API, доступный начиная с v.7.0, описан в разделе Контроллер экрана.

Экран выбора (lookup) предназначен для выбора и возврата экземпляров и списков сущностей. Стандартное действие LookupAction в таких визуальных компонентах, как PickerField и LookupPickerField, вызывает экраны выбора для поиска связанных сущностей.

При вызове экрана выбора методом openLookup() отображается панель с кнопками для выбора. Когда пользователь выбирает один или несколько экземпляров, экран вызывает переданный ему обработчик, тем самым возвращая вызывающему коду результаты выбора. При вызове методом openWindow() или, например, из главного меню, панель с кнопками выбора не отображается, что превращает экран выбора в простой экран.

Контроллер экрана выбора должен быть унаследован от класса AbstractLookup. В XML экрана в атрибуте lookupComponent должен быть указан компонент (например, Table), из которого будет взят экземпляр сущности при выборе.

Экран выбора для сущности можно создать в Studio с помощью шаблонов Entity browser или Entity combined screen.

По умолчанию, действие LookupAction использует экран, зарегистрированный в файле screens.xml с идентификатором вида {имя_сущности}.lookup или {имя_сущности}.browse, например, sales$Customer.lookup. Поэтому при использовании вышеупомянутых компонентов убедитесь, что такой экран создан. Studio регистрирует browse-экраны с идентификаторами вида {имя_сущности}.browse, поэтому они автоматически вызываются в качестве экранов выбора.

Настройка вида и поведения экрана выбора

  • Для того, чтобы заменить панель выбора (кнопки Select и Cancel) для всех экранов выбора в проекте, создайте фрейм и зарегистрируйте его с идентификатором lookupWindowActions. Стандартный фрейм расположен в файле /com/haulmont/cuba/gui/lookup-window.actions.xml. Новый фрейм должен содержать кнопку, связанную с действием lookupSelectAction (которое автоматически добавляется в экран, когда он открывается как экран выбора).

  • Чтобы заменить панель выбора в некотором экране, создайте в нем кнопку, связанную с действием lookupSelectAction. В этом случае стандартный фрейм не будет показан. Например:

    <layout expand="table">
    <hbox>
        <button id="selectBtn" caption="Select item"
                action="lookupSelectAction"/>
    </hbox>
    <!-- ... -->
</layout>

  • Чтобы заменить стандартное действие выбора своим, просто добавьте его в контроллере:

    @Override
public void init(Map<String, Object> params) {
    addAction(new SelectAction(this) {
        @Override
        protected Collection getSelectedItems(LookupComponent lookupComponent) {
            Set<MyEntity> selected = new HashSet<>();
            // ...
            return selected;
        }
    });
}

    В качестве базового класса используйте com.haulmont.cuba.gui.components.SelectAction, переопределив требуемые методы.