Mixin for CMS Form #11377

Author: anatol-sialitski

modules/app/app-system/src/main/resources/i18n/phrases.properties

@@ -67,7 +67,7 @@ media.unknown.displayName=Unknown
 media.default.media.label=Media
 media.default.tags.label=Tags
 #
-# Image mixins
+# Image form fragments
 #
 media.imageInfo.displayName=Properties
 media.imageInfo.pixelSize.label=Size (px)
@@ -99,7 +99,7 @@ media.cameraInfo.exposureMode.label=Exposure Mode
 media.cameraInfo.focusDistance.label=Focus Distance
 media.cameraInfo.orientation.label=Orientation
 #
-# Base mixins
+# Base form fragments
 #
 base.gpsInfo.displayName=Location
 base.gpsInfo.geoPoint.label=Geo Point

modules/core/core-api/src/main/java/com/enonic/xp/app/ApplicationRelativeResolver.java

@@ -40,9 +40,9 @@ public Input getInput( final String path )
         return formItems.getInput( FormItemPath.from( path ) );
     }
 
-    public InlineMixin getInlineMixin( final String path )
+    public FormFragment getFormFragment( final String path )
     {
-        return formItems.getInlineMixin( FormItemPath.from( path ) );
+        return formItems.getFormFragment( FormItemPath.from( path ) );
     }
 
     public FormOptionSet getOptionSet( final String path )

modules/core/core-api/src/main/java/com/enonic/xp/form/Form.java

@@ -0,0 +1,127 @@
+package com.enonic.xp.form;
+
+
+import java.util.Objects;
+
+import com.enonic.xp.annotation.PublicApi;
+import com.enonic.xp.schema.formfragment.FormFragmentDescriptor;
+import com.enonic.xp.schema.formfragment.FormFragmentName;
+
+@PublicApi
+public final class FormFragment
+    extends FormItem
+{
+    private final FormFragmentName formFragmentName;
+
+    private FormFragment( Builder builder )
+    {
+        super();
+
+        Objects.requireNonNull( builder.formFragmentName, "formFragmentName is required" );
+        this.formFragmentName = builder.formFragmentName;
+    }
+
+    @Override
+    public FormItemType getType()
+    {
+        return FormItemType.FORM_FRAGMENT;
+    }
+
+    public FormFragmentName getFormFragmentName()
+    {
+        return formFragmentName;
+    }
+
+    @Override
+    public String getName()
+    {
+        return formFragmentName.getLocalName();
+    }
+
+    @Override
+    public boolean equals( final Object o )
+    {
+        if ( this == o )
+        {
+            return true;
+        }
+        if ( o == null || getClass() != o.getClass() )
+        {
+            return false;
+        }
+
+        final FormFragment that = (FormFragment) o;
+        return super.equals( o ) && Objects.equals( this.formFragmentName, that.formFragmentName );
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hash( super.hashCode(), this.formFragmentName );
+    }
+
+    public static Builder create()
+    {
+        return new Builder();
+    }
+
+    @Override
+    public FormFragment copy()
+    {
+        return create( this ).build();
+    }
+
+    public static Builder create( final FormFragmentDescriptor descriptor )
+    {
+        return new Builder( descriptor );
+    }
+
+    public static Builder create( final FormFragment inline )
+    {
+        return new Builder( inline );
+    }
+
+    public static final class Builder
+    {
+        private FormFragmentName formFragmentName;
+
+        private Builder()
+        {
+        }
+
+        private Builder( FormFragment source )
+        {
+            this.formFragmentName = source.formFragmentName;
+        }
+
+        private Builder( final FormFragmentDescriptor descriptor )
+        {
+            this.formFragmentName = descriptor.getName();
+        }
+
+        public Builder formFragment( final FormFragmentDescriptor descriptor )
+        {
+            this.formFragmentName = descriptor.getName();
+            return this;
+        }
+
+        public Builder formFragment( final String name )
+        {
+            this.formFragmentName = FormFragmentName.from( name );
+            return this;
+        }
+
+        public Builder formFragment( final FormFragmentName formFragmentName )
+        {
+            this.formFragmentName = formFragmentName;
+            return this;
+        }
+
+        public FormFragment build()
+        {
+            return new FormFragment( this );
+        }
+    }
+
+
+}

modules/core/core-api/src/main/java/com/enonic/xp/form/FormFragment.java

@@ -57,14 +57,14 @@ public Input toInput()
         return (Input) this;
     }
 
-    public InlineMixin toInlineMixin()
+    public FormFragment toFormFragment()
     {
-        if ( !( this instanceof InlineMixin ) )
+        if ( !( this instanceof FormFragment ) )
         {
             throw new IllegalArgumentException(
-                "This FormItem [" + getName() + "] is not an InlineMixin: " + this.getClass().getSimpleName() );
+                "This FormItem [" + getName() + "] is not an FormFragment: " + this.getClass().getSimpleName() );
         }
-        return (InlineMixin) this;
+        return (FormFragment) this;
     }
 
     public FormItemSet toFormItemSet()

modules/core/core-api/src/main/java/com/enonic/xp/form/FormItem.java

@@ -186,9 +186,9 @@ public Input getInput( final String path )
         return formItems.getInput( FormItemPath.from( path ) );
     }
 
-    public InlineMixin getInlineMixin( final String name )
+    public FormFragment getFormFragment( final String name )
     {
-        return formItems.getInlineMixin( FormItemPath.from( name ) );
+        return formItems.getFormFragment( FormItemPath.from( name ) );
     }
 
     public static Builder create()

modules/core/core-api/src/main/java/com/enonic/xp/form/FormItemSet.java

@@ -9,7 +9,7 @@ public enum FormItemType
     INPUT,
     FORM_ITEM_SET,
     LAYOUT,
-    MIXIN_REFERENCE,
+    FORM_FRAGMENT,
     FORM_OPTION_SET,
     FORM_OPTION_SET_OPTION;
 
@@ -27,9 +27,9 @@ else if ( FieldSet.class.getSimpleName().equals( value ) )
         {
             return LAYOUT;
         }
-        else if ( InlineMixin.class.getSimpleName().equals( value ) )
+        else if ( FormFragment.class.getSimpleName().equals( value ) )
         {
-            return MIXIN_REFERENCE;
+            return FORM_FRAGMENT;
         }
         else if ( FormOptionSetOption.class.getSimpleName().equals( value ) )
         {

modules/core/core-api/src/main/java/com/enonic/xp/form/FormItemType.java

@@ -84,10 +84,10 @@ else if ( foundFormItem instanceof final FormOptionSetOption formOptionSetOption
         {
             return formOptionSetOption.getFormItem( path.asNewWithoutFirstPathElement() );
         }
-        else if ( foundFormItem instanceof InlineMixin )
+        else if ( foundFormItem instanceof FormFragment )
         {
-            throw new IllegalArgumentException( "Cannot get formItem [" + path + "] because it's past a InlineMixin [" + foundFormItem +
-                                                    "], resolve the InlineMixin first." );
+            throw new IllegalArgumentException( "Cannot get formItem [" + path + "] because it's past a FormFragment [" + foundFormItem +
+                                                    "], resolve the FormFragment first." );
         }
         else
         {
@@ -117,9 +117,9 @@ FormItemSet getFormItemSet( final FormItemPath path )
         return typeCast( getFormItem( path ), FormItemSet.class );
     }
 
-    InlineMixin getInlineMixin( final FormItemPath path )
+    FormFragment getFormFragment( final FormItemPath path )
     {
-        return typeCast( getFormItem( path ), InlineMixin.class );
+        return typeCast( getFormItem( path ), FormFragment.class );
     }
 
     FormOptionSet getOptionSet( final FormItemPath path )

modules/core/core-api/src/main/java/com/enonic/xp/form/FormItems.java

@@ -18,7 +18,7 @@ private static void validateFormItems( final Iterable<FormItem> formItems, Map<F
             switch ( item.getType() )
             {
                 case INPUT:
-                case MIXIN_REFERENCE:
+                case FORM_FRAGMENT:
                 case FORM_OPTION_SET_OPTION:
                     if ( items.containsKey( item.getPath() ) )
                     {