package info.magnolia.ui.framework.layout;
   
   import info.magnolia.ui.field.EditorPropertyDefinition;
   import info.magnolia.ui.field.FormRowOutliner;
   import info.magnolia.ui.framework.layout.field.FieldComponentDecorator;
   import info.magnolia.ui.vaadin.extension.FocusFieldCaption;
   
   import java.util.Map;
   
  import javax.inject.Inject;
  
  import com.vaadin.ui.Component;
  import com.vaadin.ui.VerticalLayout;
  
  /**
   * Lays out the form fields in a vertical layout. Unlike {@link FormLayoutProducer} this producer
   * puts the field captions above the respective components allocating more horizontal space for the
   * latter. This strategy is optimal for the the complex sub-editors, especially when they are recursively
   * nested.
   */
  public class StackedLayoutProducer implements FieldLayoutProducer<StackedLayoutProducer.Definition> {
  
      private FieldComponentDecorator fieldComponentDecorator;
  
      @Inject
      public StackedLayoutProducer(FieldComponentDecorator fieldComponentDecorator) {
          this.fieldComponentDecorator = fieldComponentDecorator;
      }
  
      @Override
      public Component createLayout(StackedLayoutProducer.Definition definition, Map<EditorPropertyDefinition, Component> mappings) {
          VerticalLayout layout = new VerticalLayout();
          layout.addStyleName("stacked-form-layout");
          if (mappings.size() > 1) {
              layout.addStyleName("with-multiple-entries");
          }
  
          layout.setSpacing(true);
          layout.setMargin(false);
  
          mappings.forEach((propertyDefinition, component) -> {
              Component wrappedField = createFieldComponentLayout(component, propertyDefinition);
              layout.addStyleName(propertyDefinition.getStyleName());
              layout.addComponent(wrappedField);
  
              FormRowOutliner.considerOutlining(wrappedField, propertyDefinition);
          });
  
          FocusFieldCaption.focusCaptionOf(layout);
          return layout;
      }
  
      @LayoutType("stacked")
      public static class Definition extends ConfiguredFieldLayoutDefinition<StackedLayoutProducer> {
          public Definition() {
              setImplementationClass(StackedLayoutProducer.class);
          }
      }
  
      private Component createFieldComponentLayout(Component component, EditorPropertyDefinition editorPropertyDefinition) {
          return fieldComponentDecorator.decorateField(component, editorPropertyDefinition);
      }
  }