/**
    * This file Copyright (c) 2018 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;
  
  import info.magnolia.objectfactory.Components;
  import info.magnolia.ui.field.EditorPropertyDefinition;
  import info.magnolia.ui.field.FormRowOutliner;
  import info.magnolia.ui.field.NamedFieldDefinition;
  import info.magnolia.ui.framework.layout.field.FieldComponentDecorator;
  import info.magnolia.ui.vaadin.extension.FocusFieldCaption;
  
  import java.util.List;
  import java.util.Map;
  import java.util.Map.Entry;
  import java.util.stream.Collectors;
  import java.util.stream.StreamSupport;
  
  import javax.inject.Inject;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.vaadin.ui.Component;
  import com.vaadin.ui.FormLayout;
  import com.vaadin.ui.TabSheet;
  import com.vaadin.ui.themes.ValoTheme;
  
  /**
   * Produces a tab layout.
   *
   * @see TabbedLayoutDefinition
   */
  public class TabbedLayoutProducer implements FieldLayoutProducer<TabbedLayoutDefinition> {
  
      private static final Logger log = LoggerFactory.getLogger(TabbedLayoutProducer.class);
  
      private final FieldComponentDecorator fieldComponentDecorator;
  
      @Inject
      protected TabbedLayoutProducer(FieldComponentDecorator fieldComponentDecorator) {
          this.fieldComponentDecorator = fieldComponentDecorator;
      }
  
      /**
       * @deprecated since 6.2.1. Use {@link #TabbedLayoutProducer(info.magnolia.ui.framework.layout.field.FieldComponentDecorator)} instead.
       */
      @Deprecated
      public TabbedLayoutProducer() {
          this(Components.getComponent(FieldComponentDecorator.class));
      }
  
      @Override
      public Component createLayout(TabbedLayoutDefinition definition, Map<EditorPropertyDefinition, Component> mappings) {
          TabSheet tabSheet = new TabSheet();
  
          tabSheet.addStyleNames(ValoTheme.TABSHEET_FRAMED);
  
          List<TabDefinition> tabs = definition.getTabs();
          Map<String, Entry<EditorPropertyDefinition, Component>> fieldNameMappings = mappings.entrySet().stream()
                  .collect(Collectors.toMap(def -> def.getKey().getName(), entry -> entry));
  
          if (tabs.size() == 1) {
              tabSheet.addStyleName("single-tab");
          }
  
          for (TabDefinition tabDefinition : tabs) {
              FormLayout formSection = new FormLayout();
             formSection.setWidth("100%");
             formSection.setMargin(true);
 
             for (NamedFieldDefinition tabField : tabDefinition.getFields()) {
                 String fieldName = tabField.getName();
                 if (fieldNameMappings.containsKey(fieldName)) {
                     Entry<EditorPropertyDefinition, Component> tabFieldMapping = fieldNameMappings.get(fieldName);
                     Component decoratedField = createFieldComponentLayout(tabFieldMapping.getValue(), tabFieldMapping.getKey());
                     FormRowOutliner.considerOutlining(decoratedField, tabFieldMapping.getKey());
                     formSection.addComponent(decoratedField);
                 } else {
                     log.warn(String.format("Could not retrieve component field named %s from mappings", fieldName));
                 }
             }
 
             tabSheet.addTab(formSection, StringUtils.defaultIfBlank(tabDefinition.getLabel(), tabDefinition.getName()));
             FocusFieldCaption.focusCaptionOf(formSection);
         }
 
         tabSheet.addAttachListener(event -> focusFirstField(tabSheet));
         tabSheet.addSelectedTabChangeListener(event -> focusFirstField(tabSheet));
 
         return tabSheet;
     }
 
     private Component createFieldComponentLayout(Component component, EditorPropertyDefinition editorPropertyDefinition) {
         return fieldComponentDecorator.decorateField(component, editorPropertyDefinition);
     }
 
     private void focusFirstField(TabSheet tabSheet) {
         if (tabSheet.getSelectedTab() instanceof FormLayout) {
             StreamSupport.stream(((FormLayout) tabSheet.getSelectedTab()).spliterator(), false)
                     .filter(field -> field instanceof Component.Focusable)
                     .findFirst()
                     .ifPresent(field -> ((Component.Focusable) field).focus());
         }
     }
 }