added helper classes for ease of use in table and form component

Author: mariodavid

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [0.5.0] - 2019-02-23
 
+## Added
+- `SoftReferenceFormFieldGenerator` to render a soft reference into a CUBA 7 form component
+- `SoftReferenceInstanceNameTableColumnGenerator` to render a soft reference with an instance name as a link into a table component
+
 ## Changed
 - fixed entity import / export of entities containing a soft reference via entity inspector. The soft reference in the EntityLoadInfo output format is used.
 - `EntitySoftReferenceDatatype` uses EntityLoadInfo output format: `example$Customer-2fdc4906-fa89-11e7-8c3f-9a214cf093ae`

modules/web/src/de/diedavids/cuba/entitysoftreference/web/SoftReferenceFormFieldGenerator.java

@@ -0,0 +1,73 @@
+package de.diedavids.cuba.entitysoftreference.web;
+
+import com.haulmont.cuba.core.global.Messages;
+import com.haulmont.cuba.gui.components.ComponentGenerationContext;
+import com.haulmont.cuba.gui.components.Field;
+import com.haulmont.cuba.gui.components.Form;
+import com.haulmont.cuba.gui.components.UiComponentsGenerator;
+import com.haulmont.cuba.gui.components.data.value.ContainerValueSource;
+import com.haulmont.cuba.gui.model.InstanceContainer;
+import org.springframework.stereotype.Component;
+
+import javax.inject.Inject;
+
+/**
+ * Helper class that generates a entity soft reference into a form component
+ *
+ * Usage:
+ *
+ * Inside a Editor the EntitySoftReferenceFormFieldGenerator bean can be injected. In the initialization
+ * phase of the editor, the bean can be used to add the soft reference form field into the form
+ *
+ *   @Inject
+ *   private EntitySoftReferenceFormFieldGenerator entitySoftReferenceFormFieldGenerator;
+ *
+ *   @Subscribe
+ *   protected void onInit(InitEvent event) {
+ *
+ *     entitySoftReferenceFormFieldGenerator.initSoftReferenceFormField(form, "mySoftReferenceFieldName", instanceContainer);
+ *
+ *   }
+ *
+ */
+@Component(SoftReferenceFormFieldGenerator.NAME)
+public class SoftReferenceFormFieldGenerator {
+
+    public static final String NAME = "ddcser_SoftReferenceFormFieldGenerator";
+
+    @Inject
+    protected UiComponentsGenerator uiComponentsGenerator;
+
+    @Inject
+    protected Messages messages;
+
+
+    /**
+     * initialized the soft reference as a form field
+     * @param form the destination form component instance
+     * @param container the instance container
+     * @param property the soft reference property
+     */
+    public void initSoftReferenceFormField(Form form, InstanceContainer container, String property) {
+
+        Field field = generateSoftReferenceField(property, container);
+
+        setCaption(property, container, field);
+        setValueSource(property, container, field);
+
+        form.add(field);
+    }
+
+    private void setValueSource(String property, InstanceContainer container, Field field) {
+        field.setValueSource(new ContainerValueSource<>(container, property));
+    }
+
+    private void setCaption(String property, InstanceContainer container, Field field) {
+        String propertyCaption = messages.getTools().getPropertyCaption(container.getEntityMetaClass(), property);
+        field.setCaption(propertyCaption);
+    }
+
+    private Field generateSoftReferenceField(String property, InstanceContainer container) {
+        return (Field) uiComponentsGenerator.generate(new ComponentGenerationContext(container.getEntityMetaClass(), property));
+    }
+}

modules/web/src/de/diedavids/cuba/entitysoftreference/web/SoftReferenceInstanceNameTableColumnGenerator.java

@@ -0,0 +1,85 @@
+package de.diedavids.cuba.entitysoftreference.web;
+
+import com.haulmont.cuba.core.entity.Entity;
+import com.haulmont.cuba.core.global.MetadataTools;
+import com.haulmont.cuba.gui.ScreenBuilders;
+import com.haulmont.cuba.gui.UiComponents;
+import com.haulmont.cuba.gui.components.Component;
+import com.haulmont.cuba.gui.components.LinkButton;
+import com.haulmont.cuba.gui.components.Table;
+import com.haulmont.cuba.gui.screen.FrameOwner;
+import com.haulmont.cuba.gui.screen.Screen;
+
+/**
+ * Helper class that generates an entity soft reference as a generated table column
+ *
+ * Usage:
+ *
+ * Within a controller a table can add a generated column with a new instance of a
+ * EntitySoftReferenceTableColumnGenerator.
+ *
+ * @Subscribe
+ * protected void onInit(InitEvent event) {
+ *  myTable.addGeneratedColumn("myEntitySoftReferenceColumnName",
+ *      new SoftReferenceInstanceNameTableColumnGenerator(
+ *      "myEntitySoftReferenceColumnName",
+ *      uiComponents,
+ *      metadataTools,
+ *      screenBuilders,
+ *      this
+ *  ));
+ * }
+ */
+public class SoftReferenceInstanceNameTableColumnGenerator implements Table.ColumnGenerator {
+
+    private final String property;
+
+    private final UiComponents uiComponents;
+    private final MetadataTools metadataTools;
+    private final ScreenBuilders screenBuilders;
+    private final FrameOwner frameOwner;
+
+    /**
+     * Creates a new SoftReferenceInstanceNameTableColumnGenerator
+     * @param property the entity soft reference property name
+     * @param uiComponents instance of CUBAs UiComponents bean
+     * @param metadataTools instance of CUBAs metadataTools bean
+     * @param screenBuilders instance of CUBAs screenBuilders bean
+     * @param frameOwner the frame owner that renders the frame
+     */
+    public SoftReferenceInstanceNameTableColumnGenerator(String property, UiComponents uiComponents, MetadataTools metadataTools, ScreenBuilders screenBuilders, FrameOwner frameOwner) {
+        this.property = property;
+        this.uiComponents = uiComponents;
+        this.metadataTools = metadataTools;
+        this.screenBuilders = screenBuilders;
+        this.frameOwner = frameOwner;
+    }
+
+
+    @Override
+    public Component generateCell(Entity entity) {
+
+        Entity softReference = getSoftReference(entity);
+        return softReferenceLinkButton(softReference);
+    }
+
+    private LinkButton softReferenceLinkButton(Entity entitySoftReference) {
+        LinkButton linkButton = uiComponents.create(LinkButton.class);
+        linkButton.setCaption(metadataTools.getInstanceName(entitySoftReference));
+
+        linkButton.addClickListener(clickEvent -> {
+            softReferenceEditor(entitySoftReference).show();
+        });
+        return linkButton;
+    }
+
+    private Entity getSoftReference(Entity entity) {
+        return (Entity) entity.getValue(property);
+    }
+
+    private Screen softReferenceEditor(Entity softReference) {
+        return screenBuilders.editor((Class<Entity>) softReference.getClass(), frameOwner)
+                .editEntity(softReference)
+                .build();
+    }
+}