Support facets in fragment jmix-framework/jmix#4185

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/DynAttrEmbeddingStrategies.java

@@ -19,7 +19,6 @@
 import com.vaadin.flow.component.Component;
 import io.jmix.core.annotation.Internal;
 import io.jmix.dynattrflowui.impl.EmbeddingStrategy;
-import io.jmix.flowui.view.View;
 import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.List;
@@ -35,7 +34,7 @@ public DynAttrEmbeddingStrategies(@Autowired(required = false) List<EmbeddingStr
     }
 
 
-    public void embedAttributes(Component component, View<?> owner) {
+    public void embedAttributes(Component component, Component owner) {
         if (embeddingStrategies != null) {
             for (EmbeddingStrategy strategy : embeddingStrategies) {
                 if (strategy.supportComponent(component)) {

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/facet/DynAttrFacetImpl.java

@@ -16,11 +16,12 @@
 
 package io.jmix.dynattrflowui.facet;
 
+import com.vaadin.flow.component.Composite;
 import io.jmix.core.annotation.Internal;
 import io.jmix.dynattrflowui.impl.AttributeDefaultValues;
+import io.jmix.flowui.facet.FacetOwner;
 import io.jmix.flowui.facet.impl.AbstractFacet;
 import io.jmix.flowui.view.StandardDetailView;
-import io.jmix.flowui.view.View;
 import io.jmix.flowui.view.ViewControllerUtils;
 import org.springframework.lang.Nullable;
 
@@ -34,19 +35,21 @@ public DynAttrFacetImpl(AttributeDefaultValues attributeDefaultValues) {
     }
 
     @Override
-    public void setOwner(@Nullable View<?> owner) {
+    public <T extends Composite<?> & FacetOwner> void setOwner(@Nullable T owner) {
         super.setOwner(owner);
         subscribe();
     }
 
-    private void subscribe() {
-        View<?> view = getOwner();
-        if (view == null) {
-            throw new IllegalStateException("DynAttrFacet is not attached to Frame");
+    protected void subscribe() {
+        FacetOwner owner = getOwner();
+        if (owner == null) {
+            throw new IllegalStateException("%s is not attached to owner"
+                    .formatted(DynAttrFacet.class.getSimpleName()));
         }
 
-        if (view instanceof StandardDetailView<?>) {
-            ViewControllerUtils.addInitEntityEventListener((StandardDetailView<?>) view, e -> attributeDefaultValues.initDefaultAttributeValues(e.getEntity()));
+        if (owner instanceof StandardDetailView<?> view) {
+            ViewControllerUtils.addInitEntityEventListener(view,
+                    e -> attributeDefaultValues.initDefaultAttributeValues(e.getEntity()));
         }
     }
 }

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/impl/BaseEmbeddingStrategy.java

@@ -24,9 +24,10 @@
 import io.jmix.dynattr.*;
 import io.jmix.flowui.accesscontext.UiEntityAttributeContext;
 import io.jmix.flowui.accesscontext.UiEntityContext;
+import io.jmix.flowui.component.UiComponentUtils;
+import io.jmix.flowui.fragment.Fragment;
+import io.jmix.flowui.fragment.FragmentUtils;
 import io.jmix.flowui.model.*;
-import io.jmix.flowui.view.View;
-import org.springframework.util.Assert;
 
 import java.util.Comparator;
 import java.util.List;
@@ -53,30 +54,41 @@ protected BaseEmbeddingStrategy(Metadata metadata,
 
     protected abstract void setLoadDynamicAttributes(Component component);
 
-    protected abstract void embed(Component component, View<?> owner, List<AttributeDefinition> attributes);
+    protected abstract void embed(Component component, List<AttributeDefinition> attributes);
 
     @Override
-    public void embed(Component component, View<?> owner) {
-        if (getWindowId(owner) != null) {
+    public void embed(Component component, Component owner) {
+        if (getOwnerId(owner) != null) {
 
             MetaClass entityMetaClass = getEntityMetaClass(component);
             if (metadataTools.isJpaEntity(entityMetaClass)) {
 
                 List<AttributeDefinition> attributes = findVisibleAttributes(
                         entityMetaClass,
-                        getWindowId(owner), component.getId().orElse(""));
+                        getOwnerId(owner), UiComponentUtils.getComponentId(component).orElse(""));
 
                 if (!attributes.isEmpty()) {
                     setLoadDynamicAttributes(component);
                 }
 
-                embed(component, owner, attributes);
+                embed(component, attributes);
             }
         }
     }
 
-    protected String getWindowId(View<?> view) {
-        return view.getId().orElseThrow();
+    protected String getOwnerId(Component owner) {
+        String ownerId = owner.getId()
+                .orElseThrow(() -> new IllegalStateException(
+                        "Cannot embed dynamic attributes into a component without an ID"));
+
+        if (owner instanceof Fragment<?> fragment) {
+            ownerId = FragmentUtils.getHostView(fragment)
+                    .getId()
+                    .orElseThrow(() -> new IllegalStateException(
+                            "Cannot embed dynamic attributes into a component with a host view without an ID"))
+                    + "." + ownerId;
+        }
+        return ownerId;
     }
 
     protected void setLoadDynamicAttributes(InstanceContainer<?> container) {

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/impl/DataGridEmbeddingStrategy.java

@@ -17,7 +17,6 @@
 package io.jmix.dynattrflowui.impl;
 
 import com.vaadin.flow.component.Component;
-import com.vaadin.flow.data.renderer.Renderer;
 import io.jmix.core.AccessManager;
 import io.jmix.core.DataManager;
 import io.jmix.core.Metadata;
@@ -32,7 +31,6 @@
 import io.jmix.flowui.component.grid.DataGrid;
 import io.jmix.flowui.data.EntityDataUnit;
 import io.jmix.flowui.data.grid.ContainerDataGridItems;
-import io.jmix.flowui.view.View;
 
 import java.util.List;
 
@@ -57,7 +55,7 @@ public boolean supportComponent(Component component) {
     }
 
     @Override
-    protected void embed(Component component, View<?> owner, List<AttributeDefinition> attributes) {
+    protected void embed(Component component, List<AttributeDefinition> attributes) {
         DataGrid<?> dataGrid = (DataGrid<?>) component;
         for (AttributeDefinition attribute : attributes) {
             addAttributeColumn(dataGrid, attribute);

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/impl/EmbeddingStrategy.java

@@ -17,11 +17,10 @@
 package io.jmix.dynattrflowui.impl;
 
 import com.vaadin.flow.component.Component;
-import io.jmix.flowui.view.View;
 
 public interface EmbeddingStrategy {
 
     boolean supportComponent(Component component);
 
-    void embed(Component component, View<?> owner);
+    void embed(Component component, Component owner);
 }

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/impl/FormEmbeddingStrategy.java

@@ -34,7 +34,6 @@
 import io.jmix.flowui.data.ValueSource;
 import io.jmix.flowui.data.ValueSourceProvider;
 import io.jmix.flowui.data.value.ContainerValueSourceProvider;
-import io.jmix.flowui.view.View;
 import org.springframework.util.Assert;
 
 import java.util.List;
@@ -65,7 +64,7 @@ public boolean supportComponent(Component component) {
     }
 
     @Override
-    protected void embed(Component component, View<?> view, List<AttributeDefinition> attributes) {
+    protected void embed(Component component, List<AttributeDefinition> attributes) {
         FormLayout form = (FormLayout) component;
         for (AttributeDefinition attribute : attributes) {
             addAttributeComponent((JmixFormLayout) form, attribute);

jmix-dynattr/dynattr-flowui/src/main/java/io/jmix/dynattrflowui/xml/facet/loader/DynAttrFacetLoader.java

@@ -16,13 +16,14 @@
 
 package io.jmix.dynattrflowui.xml.facet.loader;
 
+import com.vaadin.flow.component.Component;
 import io.jmix.dynattrflowui.DynAttrEmbeddingStrategies;
 import io.jmix.dynattrflowui.facet.DynAttrFacet;
 import io.jmix.flowui.component.UiComponentUtils;
 import io.jmix.flowui.impl.FacetsImpl;
-import io.jmix.flowui.view.View;
 import io.jmix.flowui.xml.facet.FacetProvider;
 import io.jmix.flowui.xml.facet.loader.AbstractFacetLoader;
+import io.jmix.flowui.xml.layout.ComponentLoader;
 
 public class DynAttrFacetLoader extends AbstractFacetLoader<DynAttrFacet> {
 
@@ -39,17 +40,16 @@ public void loadFacet() {
         if (facets instanceof FacetsImpl facetsImpl) {
             FacetProvider<DynAttrFacet> provider = facetsImpl.getProvider(DynAttrFacet.class);
 
-            if (provider != null) {
-                provider.loadFromXml(resultFacet, element, context);
+            if (provider != null && context instanceof ComponentLoader.ComponentContext componentContext) {
+                provider.loadFromXml(resultFacet, element, componentContext);
                 return;
             }
         }
 
-        View<?> view = context.getView();
-        context.addInitTask(__ -> {
-            UiComponentUtils.traverseComponents(view, component ->
-                    getEmbeddingStrategies().embedAttributes(component, view));
-        });
+        Component owner = context.getOrigin();
+        context.addInitTask(__ ->
+                UiComponentUtils.traverseComponents(owner, component ->
+                        getEmbeddingStrategies().embedAttributes(component, owner)));
     }
 
     protected DynAttrEmbeddingStrategies getEmbeddingStrategies() {

jmix-flowui/flowui-data/src/test/java/test_support/AbstractSettingsTest.java

@@ -17,8 +17,8 @@
 package test_support;
 
 import io.jmix.core.security.SystemAuthenticator;
+import io.jmix.flowui.facet.settings.ComponentSettingsManager;
 import io.jmix.flowui.facet.settings.ViewSettings;
-import io.jmix.flowui.facet.settings.ViewSettingsComponentManager;
 import io.jmix.flowui.facet.settings.ViewSettingsJson;
 import io.jmix.flowui.settings.UserSettingsService;
 import io.jmix.flowui.testassist.UiTestUtils;
@@ -37,7 +37,7 @@ public abstract class AbstractSettingsTest {
     @Autowired
     protected SystemAuthenticator authenticator;
     @Autowired
-    protected ViewSettingsComponentManager settingsManager;
+    protected ComponentSettingsManager settingsManager;
     @Autowired
     protected ViewNavigationSupport navigationSupport;
 

jmix-flowui/flowui-kit/src/main/java/io/jmix/flowui/kit/meta/element/StudioDataElements.java

@@ -164,6 +164,18 @@ public interface StudioDataElements {
     )
     void onViewEventLoadTrigger();
 
+    @StudioElement(
+            name = "OnFragmentEventLoadTrigger",
+            classFqn = "io.jmix.flowui.facet.dataloadcoordinator.OnFragmentEventLoadTrigger",
+            xmlElement = "onFragmentEvent",
+            icon = "io/jmix/flowui/kit/meta/icon/element/onFragmentEventLoadTrigger.svg",
+            properties = {
+                    @StudioProperty(xmlAttribute = "type", type = StudioPropertyType.ENUMERATION,
+                            options = {"Ready", "Host.Init", "Host.BeforeShow", "Host.Ready"}, required = true)
+            }
+    )
+    void onFragmentEventLoadTrigger();
+
     @StudioElement(
             name = "OnComponentValueChangedLoadTrigger",
             classFqn = "io.jmix.flowui.facet.dataloadcoordinator.OnComponentValueChangedLoadTrigger",

jmix-flowui/flowui-kit/src/main/java/io/jmix/flowui/kit/meta/facet/StudioFacets.java

@@ -26,7 +26,7 @@ public interface StudioFacets {
 
     @StudioFacet(
             name = "DataLoadCoordinator",
-            classFqn = "io.jmix.flowui.facet.DataLoadCoordinator",
+            classFqn = "io.jmix.flowui.facet.ViewDataLoadCoordinator",
             category = "Facets",
             xmlElement = "dataLoadCoordinator",
             icon = "io/jmix/flowui/kit/meta/icon/facet/dataLoadCoordinator.svg",
@@ -43,6 +43,25 @@ public interface StudioFacets {
     )
     void dataLoadCoordinator();
 
+    @StudioFacet(
+            name = "FragmentDataLoadCoordinator",
+            classFqn = "io.jmix.flowui.facet.FragmentDataLoadCoordinator",
+            category = "Facets",
+            xmlElement = "fragmentDataLoadCoordinator",
+            icon = "io/jmix/flowui/kit/meta/icon/facet/dataLoadCoordinator.svg",
+            documentationLink = "%VERSION%/flow-ui/facets/dataLoadCoordinator.html",
+            properties = {
+                    @StudioProperty(xmlAttribute = "id", type = StudioPropertyType.COMPONENT_ID),
+                    @StudioProperty(xmlAttribute = "auto", type = StudioPropertyType.BOOLEAN,
+                            defaultValue = "false", initialValue = "true"),
+                    @StudioProperty(xmlAttribute = "componentPrefix", type = StudioPropertyType.STRING,
+                            defaultValue = "component_"),
+                    @StudioProperty(xmlAttribute = "containerPrefix", type = StudioPropertyType.STRING,
+                            defaultValue = "container_"),
+            }
+    )
+    void fragmentDataLoadCoordinator();
+
     @StudioFacet(
             name = "UrlQueryParameters",
             classFqn = "io.jmix.flowui.facet.UrlQueryParametersFacet",
@@ -74,7 +93,7 @@ public interface StudioFacets {
 
     @StudioFacet(
             name = "Settings",
-            classFqn = "io.jmix.flowui.facet.SettingsFacet",
+            classFqn = "io.jmix.flowui.facet.ViewSettingsFacet",
             category = "Facets",
             xmlElement = "settings",
             icon = "io/jmix/flowui/kit/meta/icon/facet/settings.svg",
@@ -85,4 +104,18 @@ public interface StudioFacets {
             }
     )
     void settings();
+
+    @StudioFacet(
+            name = "FragmentSettings",
+            classFqn = "io.jmix.flowui.facet.FragmentSettingsFacet",
+            category = "Facets",
+            xmlElement = "fragmentSettings",
+            icon = "io/jmix/flowui/kit/meta/icon/facet/settings.svg",
+            properties = {
+                    @StudioProperty(xmlAttribute = "id", type = StudioPropertyType.COMPONENT_ID),
+                    @StudioProperty(xmlAttribute = "auto", type = StudioPropertyType.BOOLEAN,
+                            defaultValue = "false", initialValue = "true"),
+            }
+    )
+    void fragmentSettings();
 }