/**
    * This file Copyright (c) 2012-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.factory;
  
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.ui.api.context.UiContext;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.form.field.definition.Layout;
  import info.magnolia.ui.form.field.definition.OptionGroupFieldDefinition;
  import info.magnolia.ui.form.field.transformer.Transformer;
  
  import java.util.Set;
  
  import javax.inject.Inject;
  
  import com.vaadin.v7.data.Item;
  import com.vaadin.v7.ui.AbstractSelect;
  import com.vaadin.v7.ui.OptionGroup;
  
  /**
   * Creates and initializes a select field based on a field definition.
   * 
   * @param <D> type of definition
   */
  public class OptionGroupFieldFactory<D extends OptionGroupFieldDefinition> extends SelectFieldFactory<D> {
  
      private ComponentProvider componentProvider;
  
      @Inject
      public OptionGroupFieldFactory(D definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport, ComponentProvider componentProvider) {
          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
          this.componentProvider = componentProvider;
      }
  
      /**
       * @deprecated since 5.4.7 - use {@link #OptionGroupFieldFactory(OptionGroupFieldDefinition, Item, UiContext, I18NAuthoringSupport, ComponentProvider)} instead.
       */
      @Deprecated
      public OptionGroupFieldFactory(D definition, Item relatedFieldItem, ComponentProvider componentProvider) {
          this(definition, relatedFieldItem, null, componentProvider.getComponent(I18NAuthoringSupport.class), componentProvider);
      }
  
      @Override
      protected AbstractSelect createFieldComponent() {
          super.createFieldComponent();
          select.setMultiSelect(getFieldDefinition().isMultiselect());
          select.setNullSelectionAllowed(true);
          if (definition.getLayout() == Layout.horizontal) {
              select.addStyleName("horizontal");
          }
          return select;
      }
  
      @Override
      protected AbstractSelect createSelectionField() {
          return new OptionGroup();
      }
  
      /**
       * Override in order to define the field property type.<br>
       * In case of single select, use the default mechanism.<br>
       * In case of multi select, set property type as {@link Set}, type used by the Vaadin MultiSelect field.
       */
      @Override
      protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
          final Transformer<?> transformer = componentProvider.newInstance(transformerClass, item, definition, defineType(), Components.getComponent(I18NAuthoringSupport.class));
          transformer.setLocale(getLocale());
         return transformer;
     }
 
     protected Class<?> defineType() {
         if (!select.isMultiSelect()) {
             return getFieldType();
         } else {
             return Set.class;
         }
     }
 }