/**
    * 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.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.field.FieldDefinition;
  
  import java.util.Locale;
  
  import javax.inject.Inject;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.vaadin.data.HasValue;
  import com.vaadin.server.Sizeable;
  import com.vaadin.ui.AbstractComponent;
  import com.vaadin.ui.Component;
  
  import lombok.AccessLevel;
  import lombok.Getter;
  
  
  /**
   * Abstract FieldFactory implementations.
   *
   * @param <D> definition type
   * @param <T> field value type
   * @param <F> field component type
   */
  @Getter(AccessLevel.PROTECTED)
  public abstract class AbstractFieldFactory<D extends FieldDefinition<T>, T, F extends Component & HasValue<T>> implements FieldFactory<T> {
  
      private static final Logger log = LoggerFactory.getLogger(AbstractFieldFactory.class);
  
      private ComponentProvider componentProvider;
      private final D definition;
      private final Locale locale;
      private final I18NAuthoringSupport i18NAuthoringSupport;
  
      @Inject
      public AbstractFieldFactory(D definition, ComponentProvider componentProvider, Locale locale, I18NAuthoringSupport i18NAuthoringSupport) {
          this.componentProvider = componentProvider;
          this.definition = definition;
          this.locale = locale;
          this.i18NAuthoringSupport = i18NAuthoringSupport;
      }
  
      protected abstract F createFieldComponent();
  
      @Override
      public F createField() {
          // Create the Vaadin field
          F field = createFieldComponent();
          if (AbstractComponent.class.isAssignableFrom(field.getClass())) {
              AbstractComponent abstractComponent = (AbstractComponent) field;
              abstractComponent.setLocale(locale);
  
              if (StringUtils.isNotBlank(getDefinition().getStyleName())) {
                  field.addStyleName(getDefinition().getStyleName());
              }
              field.setWidth(100, Sizeable.Unit.PERCENTAGE);
              setFieldCaption(field);
          }
          field.setRequiredIndicatorVisible(getDefinition().isRequired());
          field.setReadOnly(getDefinition().isReadOnly());
 
         return field;
     }
 
     private void setFieldCaption(Component field) {
         // Set field caption and append locale indicator if needed
         if (StringUtils.isNotBlank(getDefinition().getLabel())) {
             String caption = getDefinition().getLabel();
             if (locale != null && getDefinition().isI18n() && !i18NAuthoringSupport.isDefaultLocale(locale)) {
                 caption = String.format("%s (%s)", caption, locale.toString());
             }
             field.setCaption(caption);
         }
     }
 
     /**
      * Field factories may use this method to check whether an @i18nText config property has an actual translation, or is a generated key.
      * <p>By default, if no translation is found, these properties contain the longest key to provide such a translation.
      *
      * @returns true if the given string contains dots, does not end with a dot, and does not contain spaces
      */
     protected boolean isMessageKey(String key) {
         return !StringUtils.endsWith(key, ".") && StringUtils.contains(key, ".") && !StringUtils.contains(key, " ");
     }
 }