EntityOpenAction

EntityOpenAction – это действие поля выбора сущности, предназначенное для открытия экрана редактирования для выбранного в EntityPicker в данный момент экземпляра сущности.

Действие реализовано классом io.jmix.ui.action.entitypicker.EntityOpenAction и объявляется в XML с помощью атрибута type="entity_open". Общие свойства действий можно конфигурировать с помощью атрибутов элемента action, подробнее см. раздел Декларативные действия. Ниже рассматриваются параметры, специфичные для класса EntityOpenAction.

Параметры

The following parameters can be set both in XML and in Java:

openMode - режим открытия экрана редактирования, задаваемый значением перечисления OpenMode: NEW_TAB, DIALOG, и т.д. По умолчанию экран открывается в режиме THIS_TAB.
screenId - строковый идентификатор экрана выбора. По умолчанию используется экран, аннотированный @PrimaryEditorScreen, или имеющий идентификатор вида <entity_name>.edit, например demo_Customer.edit.
screenClass - класс Java экрана редактирования. Данный параметр имеет более высокий приоритет, screenId.

Например, если необходимо открыть определенный экран редактирования в режиме диалога, действие можно сконфигурировать в XML следующим образом:

<action id="open" type="entity_open">
    <properties>
        <property name="openMode" value="DIALOG"/>
        <property name="screenClass" value="ui.ex1.screen.entity.customer.CustomerEdit"/>
    </properties>
</action>

В качестве альтернативы, действие можно инжектировать в контроллер экрана и сконфигурировать, используя сеттеры:

@Named("cEntityField.open")
private EntityOpenAction<Customer> openAction;

@Subscribe
public void onInit(InitEvent event) {
    openAction.setOpenMode(OpenMode.DIALOG);
    openAction.setScreenClass(CustomerEdit.class);
}

Обработчики

Далее рассматриваются параметры, которые можно сконфигурировать только программно в Java. Для генерации корректно аннотированных методов для этих параметров используйте Studio.

screenOptionsSupplier

Это обработчик, возвращающий объект ScreenOptions для передачи в открываемый экран редактирования. Например:

@Install(to = "cEntityField.open", subject = "screenOptionsSupplier")
private ScreenOptions cEntityFieldOpenScreenOptionsSupplier() {
    return new MapScreenOptions(ParamsMap.of("someParameter", 10));
}

Возвращаемый объект ScreenOptions будет доступен в InitEvent открываемого экрана.

screenConfigurer

Это обработчик, принимающий экран редактирования для его конфигурации перед открытием. Например:

@Install(to = "cEntityField.open", subject = "screenConfigurer")
private void cEntityFieldOpenScreenConfigurer(Screen screen) {
    ((CustomerEdit) screen).setSomeParameter(10);
}

afterCloseHandler

Это обработчик, вызываемый после закрытия экрана редактирования. Принимает AfterCloseEvent. Например:

@Install(to = "cEntityField.open", subject = "afterCloseHandler")
private void cEntityFieldOpenAfterCloseHandler(AfterCloseEvent afterCloseEvent) {
    System.out.println("Closed with " + afterCloseEvent.getCloseAction());
}

Использование ActionPerformedEvent

Для того чтобы произвести какие-либо проверки, или взаимодействовать с пользователем перед выполнением действия, необходимо подписаться на событие ActionPerformedEvent действия и в нужный момент вызвать метод execute(). Действие будет вызвано со всеми параметрами, которые были для него заданы. В примере ниже перед выполнением действия отображается диалог подтверждения:

@Subscribe("cEntityField.open")
public void onCEntityFieldOpen(Action.ActionPerformedEvent event) {
    dialogs.createOptionDialog()
            .withCaption("Please confirm")
            .withMessage("Do you really want to open the customer?")
            .withActions(
                    new DialogAction(DialogAction.Type.YES)
                            .withHandler(e -> openAction.execute()), (1)
                    new DialogAction(DialogAction.Type.NO)
            )
            .show();
}

1	Выполнение действия

Можно также подписаться на ActionPerformedEvent, и вместо вызова метода execute() действия, использовать для открытия экрана редактирования ScreenBuilders API напрямую. По сути, в этом случае все специфичные параметры действия игнорируются, и действуют только общие параметры: caption, icon, и т.д. Например:

@Autowired
private EntityPicker<Customer> cEntityField;

@Autowired
private ScreenBuilders screenBuilders;

@Subscribe("cEntityField.openAction")
public void onCEntityFieldOpenAction(Action.ActionPerformedEvent event) {
    screenBuilders.editor(cEntityField)
            .withOpenMode(OpenMode.DIALOG)
            .withScreenClass(CustomerEdit.class)
            .build()
            .show();
}