/**
    * This file Copyright (c) 2013-2015 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.factory;
  
  import info.magnolia.cms.i18n.I18nContentSupport;
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.form.field.MultiField;
  import info.magnolia.ui.form.field.definition.MultiValueFieldDefinition;
  import info.magnolia.ui.form.field.transformer.Transformer;
  
  import javax.inject.Inject;
  
  import com.vaadin.data.Item;
  import com.vaadin.data.util.PropertysetItem;
  import com.vaadin.ui.Field;
  
  
  /**
   * Creates and initializes an multi value field based on a field definition.<br>
   * Multi-field basicaly handle: <br>
   * - Add remove Fields <br>
   * This field builder create a {@link ListProperty} based on the definition and set this property as <br>
   * Field property datasource.
   *
   * @param <T>
   */
  public class MultiValueFieldFactory<T> extends AbstractFieldFactory<MultiValueFieldDefinition, PropertysetItem> {
  
      private FieldFactoryFactory fieldFactoryFactory;
      private ComponentProvider componentProvider;
      private I18NAuthoringSupport i18nAuthoringSupport;
  
      @Inject
      public MultiValueFieldFactory(MultiValueFieldDefinition definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider, I18NAuthoringSupport i18nAuthoringSupport) {
          super(definition, relatedFieldItem);
          this.fieldFactoryFactory = fieldFactoryFactory;
          this.componentProvider = componentProvider;
          this.i18nAuthoringSupport = i18nAuthoringSupport;
      }
  
      /**
       * @deprecated since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
       */
      @Deprecated
      public MultiValueFieldFactory(MultiValueFieldDefinition definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, I18nContentSupport i18nContentSupport, ComponentProvider componentProvider) {
          this(definition, relatedFieldItem, fieldFactoryFactory, componentProvider, null);
      }
  
      @Override
      protected Field<PropertysetItem> createFieldComponent() {
          // FIXME change i18n setting : MGNLUI-1548
          definition.setI18nBasename(getMessages().getBasename());
  
          MultiField field = new MultiField(definition, fieldFactoryFactory, componentProvider, item, i18nAuthoringSupport);
          // Set Caption
          field.setButtonCaptionAdd(getMessage(definition.getButtonSelectAddLabel()));
          field.setButtonCaptionRemove(getMessage(definition.getButtonSelectRemoveLabel()));
  
          return field;
      }
  
      /**
       * Create a new Instance of {@link Transformer}.
       */
      @Override
      protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
          return this.componentProvider.newInstance(transformerClass, item, definition, PropertysetItem.class);
     }
 
 }