/**
    * 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.field.factory;
  
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.ui.datasource.ItemResolver;
  import info.magnolia.ui.editor.ItemPreviewDefinition;
  import info.magnolia.ui.field.LinkField;
  import info.magnolia.ui.field.LinkFieldDefinition;
  import info.magnolia.ui.field.SelectFieldSupport;
  import info.magnolia.ui.framework.overlay.ChooserController;
  import info.magnolia.ui.framework.overlay.ChooserController.ChooseResult;
  import info.magnolia.ui.preview.ItemPreviewComponent;
  
  import java.util.Optional;
  import java.util.concurrent.CompletableFuture;
  
  import javax.inject.Inject;
  
  import com.vaadin.data.HasValue;
  import com.vaadin.ui.ComboBox;
  
  /**
   * Creates and initializes a {@link LinkField} field based on a {@link LinkFieldDefinition}.
   *
   * @param <D> the type of link field definition.
   */
  public class LinkFieldFactory<T, D extends LinkFieldDefinition<T>> extends ComboBoxFieldFactory<T, LinkFieldDefinition<T>> {
  
      private final ChooserController chooserController;
  
      @Inject
      public LinkFieldFactory(D definition, ComponentProvider componentProvider, ChooserController chooserController, SelectFieldSupport<T> selectFieldSupport) {
          super(definition, componentProvider, selectFieldSupport);
  
          if (definition.getChooser() == null) {
              throw new IllegalArgumentException("Could not find a chooser dialog definition at LinkField definition " + definition.getName());
          }
  
          this.chooserController = chooserController;
      }
  
      /**
       * @deprecated since 6.2.1. Use {@link #LinkFieldFactory(D, info.magnolia.objectfactory.ComponentProvider, info.magnolia.ui.framework.overlay.ChooserController, info.magnolia.ui.field.SelectFieldSupport)} instead.
       */
      @Deprecated
      public LinkFieldFactory(LinkFieldDefinition<T> definition, ComponentProvider componentProvider, ItemResolver<T> itemResolver, ChooserController chooserController) {
          this((D) definition, componentProvider, chooserController, Components.getComponent(SelectFieldSupport.class));
      }
  
      @Override
      public HasValue<T> createField() {
          LinkField<T> linkField = new LinkField<>((ComboBox<T>) super.createField());
          linkField.setCaption(getDefinition().getLabel());
          linkField.setButtonCaptionNew(getDefinition().getButtonSelectNewLabel());
          linkField.setButtonCaptionOther(getDefinition().getButtonSelectOtherLabel());
          linkField.setEditable(getDefinition().isEditable());
          linkField.setDisableOnClick(true);
          linkField.addClickListener(event -> openChooser(linkField));
  
          newItemPreviewComponent().ifPresent(itemPreviewComponent -> {
              linkField.addValueChangeListener(event -> {
                  T item = event.getValue();
                  itemPreviewComponent.onValueChange(item);
                  itemPreviewComponent.setVisible(item != null);
              });
              linkField.setContentPreview(itemPreviewComponent);
         });
 
         return linkField;
     }
 
     CompletableFuture<ChooseResult<T>> openChooser(LinkField<T> linkField) {
         return chooserController.openChooser(getDefinition().getChooser(), linkField.getValue())
                 .whenComplete((ChooseResult<T> result, Throwable err) -> {
                     linkField.setEnabled(true);
                     if (err != null) {
                         throw new RuntimeException(err);
                     }
                     result.getChoice().ifPresent(linkField::setValue);
                 });
     }
 
     protected Optional<? extends ItemPreviewComponent<T>> newItemPreviewComponent() {
         return Optional.ofNullable(getDefinition().getPreview())
                 .map(ItemPreviewDefinition::getImplementationClass)
                 .map(clazz -> componentProvider.newInstance(clazz));
     }
 
 }