3.5.15. 插件工厂

插件工厂机制扩展了标准组件的创建过程，允许在Form、Table和DataGrid 中创建不同的编辑字段。这意味着应用程序组件或应用程序项目本身可以提供自定义策略，以创建非标准的组件或支持自定义数据类型。

该机制的入口点是 UiComponentsGenerator.generate(ComponentGenerationContext) 方法。其工作原理如下：

  • 尝试查找 ComponentGenerationStrategy 实现。如果找到至少一种策略，那么：

    • 根据 org.springframework.core.Ordered 接口遍历策略。

    • 返回第一个创建的非 null 组件。

ComponentGenerationStrategy 实现用于创建 UI 组件。项目可以包含任意数量的此类策略。

ComponentGenerationContext 是一个类，该类存储创建组件时可以使用的以下信息：

  • metaClass - 定义为其创建组件的实体。

  • property - 定义为其创建组件的实体属性。

  • datasource - 数据源。

  • optionsDatasource - 可用于显示选项列表的数据源。

  • valueSource - 可用于创建组件的值来源。

  • options - 可用于显示选项的选项对象。

  • xmlDescriptor - 在组件以声明的方式在 XML 描述中定义时，包含附加信息的 XML 描述。

  • componentClass - 要创建的组件的类型。例如，Form、Table、DataGrid。

有两种内置组件策略：

  • DefaultComponentGenerationStrategy - 用于根据给定的 ComponentGenerationContext 对象创建组件。顺序值为 ComponentGenerationStrategy.LOWEST_PLATFORM_PRECEDENCE （1000）。

  • DataGridEditorComponentGenerationStrategy - 用于根据给定的 ComponentGenerationContext 对象为数据网格编辑器创建组件。顺序值为 ComponentGenerationStrategy.HIGHEST_PLATFORM_PRECEDENCE + 30 （130）。

以下示例展示如何替换为特定实体的某个属性 Form 组件的默认生成过程。

  1. import com.company.sales.entity.Order;
  2. import com.haulmont.chile.core.model.MetaClass;
  3. import com.haulmont.cuba.core.global.Metadata;
  4. import com.haulmont.cuba.gui.UiComponents;
  5. import com.haulmont.cuba.gui.components.*;
  6. import com.haulmont.cuba.gui.components.data.ValueSource;
  7. import org.springframework.core.Ordered;
  9. import javax.annotation.Nullable;
  10. import javax.inject.Inject;
  11. import java.sql.Date;
  13. @org.springframework.stereotype.Component(SalesComponentGenerationStrategy.NAME)
  14. public class SalesComponentGenerationStrategy implements ComponentGenerationStrategy, Ordered {
  16.     public static final String NAME = "sales_SalesComponentGenerationStrategy";
  18.     @Inject
  19.     private UiComponents uiComponents;
  21.     @Inject
  22.     private Metadata metadata;
  24.     @Nullable
  25.     @Override
  26.     public Component createComponent(ComponentGenerationContext context) {
  27.         String property = context.getProperty();
  28.         MetaClass orderMetaClass = metadata.getClassNN(Order.class);
  30.         // Check the specific field of the Order entity
  31.         // and that the component is created for the Form component
  32.         if (orderMetaClass.equals(context.getMetaClass())
  33.                 && "date".equals(property)
  34.                 && context.getComponentClass() != null
  35.                 && Form.class.isAssignableFrom(context.getComponentClass())) {
  36.             DatePicker<Date> datePicker = uiComponents.create(DatePicker.TYPE_DATE);
  38.             ValueSource valueSource = context.getValueSource();
  39.             if (valueSource != null) {
  40.                 //noinspection unchecked
  41.                 datePicker.setValueSource(valueSource);
  42.             }
  44.             return datePicker;
  45.         }
  47.         return null;
  48.     }
  50.     @Override
  51.     public int getOrder() {
  52.         return 50;
  53.     }
  54. }

以下示例展示如何为特定的 datatype 定义 ComponentGenerationStrategy。

  1. import com.company.colordatatype.datatypes.ColorDatatype;
  2. import com.haulmont.chile.core.datatypes.Datatype;
  3. import com.haulmont.chile.core.model.MetaClass;
  4. import com.haulmont.chile.core.model.MetaPropertyPath;
  5. import com.haulmont.chile.core.model.Range;
  6. import com.haulmont.cuba.core.app.dynamicattributes.DynamicAttributesUtils;
  7. import com.haulmont.cuba.gui.UiComponents;
  8. import com.haulmont.cuba.gui.components.ColorPicker;
  9. import com.haulmont.cuba.gui.components.Component;
  10. import com.haulmont.cuba.gui.components.ComponentGenerationContext;
  11. import com.haulmont.cuba.gui.components.ComponentGenerationStrategy;
  12. import com.haulmont.cuba.gui.components.data.ValueSource;
  13. import org.springframework.core.annotation.Order;
  15. import javax.annotation.Nullable;
  16. import javax.inject.Inject;
  18. @Order(100)
  19. @org.springframework.stereotype.Component(ColorComponentGenerationStrategy.NAME)
  20. public class ColorComponentGenerationStrategy implements ComponentGenerationStrategy {
  22.     public static final String NAME = "colordatatype_ColorComponentGenerationStrategy";
  24.     @Inject
  25.     private UiComponents uiComponents;
  27.     @Nullable
  28.     @Override
  29.     public Component createComponent(ComponentGenerationContext context) {
  30.         String property = context.getProperty();
  31.         MetaPropertyPath mpp = resolveMetaPropertyPath(context.getMetaClass(), property);
  33.         if (mpp != null) {
  34.             Range mppRange = mpp.getRange();
  35.             if (mppRange.isDatatype()
  36.                     && ((Datatype) mppRange.asDatatype()) instanceof ColorDatatype) {
  37.                 ColorPicker colorPicker = uiComponents.create(ColorPicker.class);
  38.                 colorPicker.setDefaultCaptionEnabled(true);
  40.                 ValueSource valueSource = context.getValueSource();
  41.                 if (valueSource != null) {
  42.                     //noinspection unchecked
  43.                     colorPicker.setValueSource(valueSource);
  44.                 }
  46.                 return colorPicker;
  47.             }
  48.         }
  50.         return null;
  51.     }
  53.     protected MetaPropertyPath resolveMetaPropertyPath(MetaClass metaClass, String property) {
  54.         MetaPropertyPath mpp = metaClass.getPropertyPath(property);
  56.         if (mpp == null && DynamicAttributesUtils.isDynamicAttribute(property)) {
  57.             mpp = DynamicAttributesUtils.getMetaPropertyPath(metaClass, property);
  58.         }
  60.         return mpp;
  61.     }
  62. }