/**
    * This file Copyright (c) 2020 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.ui.framework.layout.field;
  
  import info.magnolia.ui.field.EditorPropertyDefinition;
  
  import java.util.Collection;
  
  import javax.inject.Inject;
  import javax.inject.Provider;
  
  import com.vaadin.ui.Component;
  import com.vaadin.ui.HorizontalLayout;
  import com.vaadin.ui.VerticalLayout;
  
  /**
   * Decorates form field with implementations of {@link info.magnolia.ui.framework.layout.field.FieldLayoutComponent}.
   * This is done by injecting multibound components for this interface.
   * @see info.magnolia.ui.framework.layout.field.FieldLayoutComponent
   */
  public class FieldComponentDecorator {
  
      private final Collection<Provider<FieldLayoutComponent>> extraComponents;
  
      @Inject
      protected FieldComponentDecorator(Collection<Provider<FieldLayoutComponent>> extraComponents) {
          this.extraComponents = extraComponents;
      }
  
      public Component decorateField(Component field, EditorPropertyDefinition editorPropertyDefinition) {
  
          final HorizontalLayout horizontalLayout = new HorizontalLayout(field);
          horizontalLayout.addStyleName("help-button-field-layout");
          horizontalLayout.setSizeFull();
          horizontalLayout.setSpacing(false);
          horizontalLayout.setExpandRatio(field, 1);
          extraComponents.stream()
                  .map(Provider::get)
                  .filter(fieldLayoutComponent -> fieldLayoutComponent.getPosition() == FieldLayoutComponent.Position.horizontal)
                  .peek(component -> component.init(editorPropertyDefinition, field))
                  .sorted((o1, o2) -> o1 instanceof FieldLayoutComponent.Description ? 1 : o2 instanceof FieldLayoutComponent.Description ? -1 : 0) //description always first
                  .forEach(horizontalLayout::addComponent);
  
          final VerticalLayout verticalLayout = new VerticalLayout(horizontalLayout);
          verticalLayout.setMargin(false);
          extraComponents.stream()
                  .map(Provider::get)
                  .filter(fieldLayoutComponent -> fieldLayoutComponent.getPosition() == FieldLayoutComponent.Position.vertical)
                  .sorted((o1, o2) -> o1 instanceof FieldLayoutComponent.ValidationLabel ? 1 : o2 instanceof FieldLayoutComponent.ValidationLabel ? -1 : 0) //validation labels always first
                  .peek(component -> component.init(editorPropertyDefinition, field))
                  .forEach(verticalLayout::addComponent);
  
          return new FieldLayoutComponent.Root<>(field, verticalLayout, editorPropertyDefinition);
      }
  }