EditAction

EditAction – это действие с коллекцией, предназначенное для редактирования экземпляров сущности. Оно открывает экран редактирования с экземпляром сущности, выбранным в UI-компоненте. После того, как экземпляр сохранен в базу данных экраном редактирования, действие обновляет его в контейнере данных UI-компонента.

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

Параметры

Следующие параметры можно установить и в XML, и в Java:

  • openMode - режим открытия экрана редактирования, задаваемый значением перечисления OpenMode: NEW_TAB, DIALOG, и т.д. По умолчанию экран открывается в режиме THIS_TAB.

  • screenId - строковый идентификатор экрана редактирования. По умолчанию используется экран, аннотированный @PrimaryEditorScreen, или имеющий идентификатор вида <entity_name>.edit, например demo_Order.edit.

  • screenClass - класс Java экрана редактирования. Данный параметр имеет более высокий приоритет, чем screenId.

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

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

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

@Named("customersGroupTable.edit")
private EditAction<Customer> editAction;

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

Обработчики

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

screenOptionsSupplier

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

@Install(to = "custTable.edit", subject = "screenOptionsSupplier")
private ScreenOptions custTableEditScreenOptionsSupplier() {
    return new MapScreenOptions(ParamsMap.of("someParameter", 10));
}

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

screenConfigurer

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

@Install(to = "custTable.edit", subject = "screenConfigurer")
private void custTableEditScreenConfigurer(Screen screen) {
    ((CustomerEdit) screen).setSomeParameter(10);
}

Обратите внимание, что конфигуратор экрана вступает в действие, когда экран уже инициализирован, но еще не показан, то есть после InitEvent и AfterInitEvent, и до BeforeShowEvent.

transformation

Это обработчик, вызываемый после того, как сущность выбрана и прошла валидацию в экране редактирования. Он принимает выбранную сущность и может быть использован для того, чтобы преобразовать закоммиченную сущность перед ее установкой в целевой контейнер данных. Например:

@Install(to = "custTable.edit", subject = "transformation")
private Customer custTableEditTransformation(Customer customer) {
    return reloadCustomer(customer);
}

afterCommitHandler

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

@Install(to = "custTable.edit", subject = "afterCommitHandler")
private void custTableEditAfterCommitHandler(Customer customer) {
    System.out.println("Updated " + customer);
}

afterCloseHandler

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

@Install(to = "custTable.edit", subject = "afterCloseHandler")
private void custTableEditAfterCloseHandler(AfterCloseEvent afterCloseEvent) {
    if (afterCloseEvent.closedWith(StandardOutcome.COMMIT)) {
        System.out.println("Committed");
    }
}

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

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

@Named("custTable.edit")
private EditAction<Customer> custTableEdit;

@Subscribe("custTable.edit")
public void onCustTableEdit(Action.ActionPerformedEvent event) {
    dialogs.createOptionDialog()
            .withCaption("Please confirm")
            .withMessage("Do you really want to edit the customer?")
            .withActions(
                    new DialogAction(DialogAction.Type.YES)
                            .withHandler(e -> custTableEdit.execute()), // execute action
                    new DialogAction(DialogAction.Type.NO)
            )
            .show();
}

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

@Autowired
private ScreenBuilders screenBuilders;

@Subscribe("customersTable.edit")
public void onCustomersTableEdit(Action.ActionPerformedEvent event) {
    screenBuilders.editor(customersTable)
            .withOpenMode(OpenMode.DIALOG)
            .withScreenClass(CustomerEdit.class)
            .withAfterCloseListener(afterScreenCloseEvent -> {
                if (afterScreenCloseEvent.closedWith(StandardOutcome.COMMIT)) {
                    Customer committedCustomer = (afterScreenCloseEvent.getSource()).getEditedEntity();
                    System.out.println("Updated " + committedCustomer);
                }
            })
            .build()
            .show();
}