Edit on
GitHub3.5.5.2.2. BulkEditAction
BulkEditAction 是 列表操作，设计用来为多个实体实例统一修改属性值。它会打开一个特殊的界面，用户可以输入需要的属性值。之后，该操作会在数据库更新选中的实体，同时也会在数据容器更新以反映到 UI 变化。
该操作通过 com.haulmont.cuba.gui.actions.list.BulkEditAction 类实现，在 XML 中需要使用操作属性 type="bulkEdit" 定义。可以用 action 元素的 XML 属性定义通用的操作参数，参阅 声明式操作 了解细节。下面我们介绍 BulkEditAction 类特有的参数。
-
openMode- 批量编辑界面的打开模式，要求是OpenMode枚举类型的一个值：NEW_TAB、DIALOG等。默认情况下，BulkEditAction 用DIALOG模式打开界面。 -
columnsMode- 批量编辑界面列的数量，要求是ColumnsMode枚举类型的一个值。默认是TWO_COLUMNS。 -
exclude- 一个正则表达式，排除某些实体属性，不显示在编辑器。 -
includeProperties- 编辑器需要展示实体属性列表。该列表比exclude表达式优先级高。 -
loadDynamicAttributes- 是否在编辑界面展示动态属性。默认为 true。 -
useConfirmDialog- 是否在保存改动之前显示确认对话框。默认为 true。
示例：
<action id="bulkEdit" type="bulkEdit">
<properties>
<property name="openMode" value="THIS_TAB"/>
<property name="includeProperties" value="name,email"/>
<property name="columnsMode" value="ONE_COLUMN"/>
</properties>
</action>或者，可以在界面控制器注入该操作，然后用 setter 配置：
@Named("customersTable.bulkEdit")
private BulkEditAction customersTableBulkEdit;
@Subscribe
public void onInit(InitEvent event) {
customersTableBulkEdit.setOpenMode(OpenMode.THIS_TAB);
customersTableBulkEdit.setIncludeProperties(Arrays.asList("name", "email"));
customersTableBulkEdit.setColumnsMode(ColumnsMode.ONE_COLUMN);
}下面这些参数只能用 Java 代码配置。如果要为这些参数生成带正确注解的方法桩代码，可以用 Studio 中 Component Inspector 工具窗口的 Handlers 标签页功能。
-
fieldSorter- 接收表示实体属性的MetaProperty对象列表，返回按照编辑界面需要顺序的这些对象。示例：@Install(to = "customersTable.bulkEdit", subject = "fieldSorter") private Map<MetaProperty, Integer> customersTableBulkEditFieldSorter(List<MetaProperty> properties) { Map<MetaProperty, Integer> result = new HashMap<>(); for (MetaProperty property : properties) { switch (property.getName()) { case "name": result.put(property, 0); break; case "email": result.put(property, 1); break; default: } } return result; }
如果需要在该操作执行前做一些检查或者与用户做一些交互，可以订阅操作的 ActionPerformedEvent 事件并按需调用操作的 execute() 方法。下面的例子中，我们在执行操作前展示了一个自定义确认对话框：
@Named("customersTable.bulkEdit")
private BulkEditAction customersTableBulkEdit;
@Subscribe("customersTable.bulkEdit")
public void onCustomersTableBulkEdit(Action.ActionPerformedEvent event) {
dialogs.createOptionDialog()
.withCaption("Please confirm")
.withMessage("Are you sure you want to edit the selected entities?")
.withActions(
new DialogAction(DialogAction.Type.YES)
.withHandler(e -> customersTableBulkEdit.execute()), // execute action
new DialogAction(DialogAction.Type.NO)
)
.show();
}另外，还可以先订阅 ActionPerformedEvent，但是不调用操作的 execute() 方法，而是直接使用 BulkEditors API。此时，会忽略所有的操作参数和行为，只能用其通用参数，比如 caption, icon 等。示例：
@Inject
private BulkEditors bulkEditors;
@Inject
private GroupTable<Customer> customersTable;
@Subscribe("customersTable.bulkEdit")
public void onCustomersTableBulkEdit(Action.ActionPerformedEvent event) {
bulkEditors.builder(metadata.getClassNN(Customer.class), customersTable.getSelected(), this)
.withListComponent(customersTable)
.withColumnsMode(ColumnsMode.ONE_COLUMN)
.withIncludeProperties(Arrays.asList("name", "email"))
.create()
.show();
}