AddAction - CUBA 框架开发者手册

3.5.5.2.1. AddAction

AddAction 是列表操作，设计用来通过在查找界面选择实体实例的方法将已有的实体实例添加到数据容器。比如，可以用来填写多对多的集合。

该操作通过 com.haulmont.cuba.gui.actions.list.AddAction 类实现，在 XML 中需要使用操作属性 type="add" 定义。可以用 action 元素的 XML 属性定义通用的操作参数，参阅声明式操作了解细节。下面我们介绍 AddAction 类特有的参数。

下列参数可以通过 XML 或 Java 的方式设置：

openMode - 查找界面的打开模式，要求是 OpenMode 枚举类型的一个值：NEW_TAB、DIALOG 等。默认情况下，AddAction 用 THIS_TAB 模式打开查找界面。
screenId - 查找界面的字符串 id。AddAction 默认会使用带有 @PrimaryLookupScreen 注解的界面，或 <entity_name>.lookup、<entity_name>.browse 格式的界面标识符，比如， demo_Customer.browse。
screenClass - 查找界面控制器的 Java 类。比 screenId 有更高的优先级。

示例，需要以对话框方式打开一个特定的查找界面，可以在 XML 中这样配置操作：

<action id="add" type="add">
    <properties>
        <property name="openMode" value="DIALOG"/>
        <property name="screenClass" value="com.company.sales.web.customer.CustomerBrowse"/>
    </properties>
</action>

或者，可以在界面控制器注入该操作，然后用 setter 配置：

@Named("customersTable.add")
private AddAction customersTableAdd;

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

现在我们看看那些只能用 Java 代码配置的参数。如果要为这些参数生成带正确注解的方法桩代码，可以用 Studio 中 Component Inspector 工具窗口的 Handlers 标签页功能。

screenOptionsSupplier - 返回 ScreenOptions 对象的处理器，返回值可以传递给打开的查找界面。示例：

@Install(to = "customersTable.add", subject = "screenOptionsSupplier")
private ScreenOptions customersTableAddScreenOptionsSupplier() {
    return new MapScreenOptions(ParamsMap.of("someParameter", 10));
}

返回的 ScreenOptions 对象可以通过打开界面的 InitEvent 访问。

screenConfigurer - 接收查找界面作为参数并能在打开之间初始化界面的处理器。示例：
```
@Install(to = "customersTable.add", subject = "screenConfigurer")
private void customersTableAddScreenConfigurer(Screen screen) {
    ((CustomerBrowse) screen).setSomeParameter(10);
}
```
注意，界面 configurer 会在界面已经初始化但是还未显示时生效，即在界面的 InitEvent 和 AfterInitEvent 事件之后，但是在 BeforeShowEvent 之前。

selectValidator - 当用户在查找界面点击 Select 时调用的一个处理器。接收包含选中条目的对象作为参数。可以用这个处理器检查选中的条目是否满足某些条件。处理器必须返回 true 才能继续关闭查找界面。示例：

@Install(to = "customersTable.add", subject = "selectValidator")
private boolean customersTableAddSelectValidator(LookupScreen.ValidationContext<Customer> validationContext) {
    boolean valid = checkCustomers(validationContext.getSelectedItems());
    if (!valid) {
        notifications.create().withCaption("Selection is not valid").show();
    }
    return valid;
}

transformation - 在查找界面选择实体并验证之后调用的处理器。接收选中的实体集合作为参数。可以用这个处理器对选中的实体做一些处理，然后再传递给接收的数据容器。示例：
```
@Install(to = "customersTable.add", subject = "transformation")
private Collection<Customer> customersTableAddTransformation(Collection<Customer> collection) {
    return reloadCustomers(collection);
}
```

afterCloseHandler - 在查找界面关闭后调用的处理器。AfterCloseEvent 事件会传递给该处理器。示例：

@Install(to = "customersTable.add", subject = "afterCloseHandler")
private void customersTableAddAfterCloseHandler(AfterCloseEvent event) {
    if (event.closedWith(StandardOutcome.SELECT)) {
        System.out.println("Selected");
    }
}

如果需要在该操作执行前做一些检查或者与用户做一些交互，可以订阅操作的 ActionPerformedEvent 事件并按需调用操作的 execute() 方法。操作会使用你为它定义的所有参数进行调用。下面的例子中，我们在执行操作前展示了一个确认对话框：

@Named("customersTable.add")
private AddAction customersTableAdd;

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

另外，还可以先订阅 ActionPerformedEvent，但是不调用操作的 execute() 方法，而是使用 ScreenBuilders API 直接打开查找界面。此时，会忽略所有的操作参数和行为，只能用其通用参数，比如 caption, icon 等。示例：

@Inject
private ScreenBuilders screenBuilders;
@Inject
private Table<Customer> customersTable;

@Subscribe("customersTable.add")
public void onCustomersTableAdd(Action.ActionPerformedEvent event) {
    screenBuilders.lookup(customersTable)
            .withOpenMode(OpenMode.DIALOG)
            .withScreenClass(CustomerBrowse.class)
            .withSelectValidator(customerValidationContext -> {
                boolean valid = checkCustomers(customerValidationContext.getSelectedItems());
                if (!valid) {
                    notifications.create().withCaption("Selection is not valid").show();
                }
                return valid;

            })
            .build()
            .show();
}