/**
    * This file Copyright (c) 2013-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.form.field;
  
  import info.magnolia.cms.i18n.I18nContentSupport;
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
  import info.magnolia.ui.form.field.definition.SwitchableFieldDefinition;
  import info.magnolia.ui.form.field.factory.FieldFactoryFactory;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.vaadin.ui.Component;
  import com.vaadin.v7.data.Item;
  import com.vaadin.v7.data.util.PropertysetItem;
  import com.vaadin.v7.ui.Field;
  import com.vaadin.v7.ui.Label;
  import com.vaadin.v7.ui.VerticalLayout;
  
  /**
   * Switchable field.<br>
   * Display a field composed of two main sections <br>
   * - a Select Section (list or checkBox) <br>
   * - a Field Section displaying the field currently selected. <br>
   */
  public class SwitchableField extends AbstractCustomMultiField<SwitchableFieldDefinition, PropertysetItem> {
  
      private static final Logger log = LoggerFactory.getLogger(SwitchableField.class);
  
      // - key : Field name. Should be the same as the related select value.<br>
      // - value : Related Field. Created based on the definition coming from the Fields Definition list.
      private final Map<String, Field<?>> fieldMap = new HashMap<>();
  
      private Field<?> selectField;
  
      public SwitchableField(SwitchableFieldDefinition definition, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider, Item relatedFieldItem, I18NAuthoringSupport i18nAuthoringSupport) {
          super(definition, fieldFactoryFactory, componentProvider, relatedFieldItem, i18nAuthoringSupport);
      }
  
      /**
       * @deprecated since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
       */
      @Deprecated
      public SwitchableField(SwitchableFieldDefinition definition, FieldFactoryFactory fieldFactoryFactory, I18nContentSupport i18nContentSupport, ComponentProvider componentProvider, Item relatedFieldItem) {
          this(definition, fieldFactoryFactory, componentProvider, relatedFieldItem, componentProvider.getComponent(I18NAuthoringSupport.class));
      }
  
      @Override
      protected Component initContent() {
          // Initialize root
          root = new VerticalLayout();
          setWidth(100, Unit.PERCENTAGE);
          setHeight(-1, Unit.PIXELS);
          addStyleName("switchablefield");
          root.setWidth(100, Unit.PERCENTAGE);
          root.setHeight(-1, Unit.PIXELS);
          root.setSpacing(true);
  
          // Initialize Existing field
          initFields();
          return root;
      }
 
     @Override
     protected void initFields(PropertysetItem fieldValues) {
         root.removeAllComponents();
         fieldMap.clear();
         // Create all Fields including the select Field.
         for (ConfiguredFieldDefinition fieldDefinition : definition.getFields()) {
             String name = fieldDefinition.getName();
             // Only propagate read only if the parent definition is read only
             if (definition.isReadOnly()) {
                 fieldDefinition.setReadOnly(true);
             }
             Field<?> field = createLocalField(fieldDefinition, fieldValues.getItemProperty(fieldDefinition.getName()), false);
             // Do not add hidden field.
             if (!field.isVisible()) {
                 continue;
             }
             if (fieldValues.getItemProperty(fieldDefinition.getName()) == null) {
                 fieldValues.addItemProperty(fieldDefinition.getName(), field.getPropertyDataSource());
             }
             field.setWidth(100, Unit.PERCENTAGE);
             fieldMap.put(name, field);
             // set select field at the first position
             if (StringUtils.equals(fieldDefinition.getName(), definition.getName())) {
                 root.addComponentAsFirst(field);
             } else {
                 root.addComponent(field);
             }
         }
 
         // add listener to the select field
         selectField = fieldMap.get(definition.getName());
         selectField.setCaption(null);
         selectField.addValueChangeListener(createSelectValueChangeListener());
         selectField.addValueChangeListener(selectionListener);
         switchField((String) selectField.getValue());
     }
 
     /**
      * Returns a {@link Field} if it's existing. Otherwise returns a null.
      */
     protected Field<?> getFieldByName(String fieldName) {
         return fieldMap.get(fieldName);
     }
 
     /**
      * Change Listener bound to the select field. Once a selection is done, <br>
      * the value change listener will switch to the field linked to the current select value.
      */
     private ValueChangeListener createSelectValueChangeListener() {
         return (ValueChangeListener) event -> switchField(String.valueOf(event.getProperty().getValue()));
     }
 
     /**
      * Switch to the desired field. It the field is not part of the List, display a warn label.
      */
     private void switchField(String fieldName) {
         // Check
         if (root.getComponentCount() < 2 && StringUtils.equals(root.getComponent(0).getId(), definition.getName())) {
             log.warn("{} is not associated to a field. Nothing will be displayed.", fieldName);
             root.addComponent(new Label("No field configured for this switchable field "), 1);
             return;
         }
 
         for (String innerFieldName : fieldMap.keySet()) {
             Field<?> field = fieldMap.get(innerFieldName);
             // Set the select component visible and the selected field
             if (StringUtils.equals(innerFieldName, fieldName) || StringUtils.equals(innerFieldName, definition.getName())) {
                 field.setVisible(true);
             } else {
                 field.setVisible(false);
             }
         }
     }
 
     @Override
     public Class<? extends PropertysetItem> getType() {
         return PropertysetItem.class;
     }
 
     /**
      * A switchable field is empty when no choice has been made yet. This method is called by Vaadin framework to perform a basic isRequired check.
      */
     @Override
     public boolean isEmpty() {
         return selectField.isEmpty();
     }
 }