/**
    * This file Copyright (c) 2019 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.admincentral.findbar;
  
  import info.magnolia.i18nsystem.SimpleTranslator;
  import info.magnolia.periscope.operation.OperationRequest;
  
  import java.util.Optional;
  import java.util.concurrent.atomic.AtomicBoolean;
  
  import com.vaadin.data.HasValue;
  import com.vaadin.event.FieldEvents;
  import com.vaadin.shared.Registration;
  import com.vaadin.ui.Component;
  import com.vaadin.ui.Label;
  import com.vaadin.ui.Panel;
  import com.vaadin.ui.TextField;
  
  /**
   * A TextField-like component providing a visual aid when the query sniffer detects a valid command.
   */
  public class FindBarTextField extends Panel {
  
      private TextField textField = new TextField();
      private AtomicBoolean textFieldHasFocus = new AtomicBoolean(false);
      private OperationRequest command;
      private final Label commandHint = new Label();
  
      FindBarTextField(SimpleTranslator i18n, Runnable search) {
          this.textField.setSizeFull();
          this.textField.addStyleNames("findbar");
          this.textField.setPlaceholder(i18n.translate("findbar.placeholder"));
          this.textField.addAttachListener(event -> search.run());
          // be a bit more eager than the default 400 ms to make live type-ahead search feel more responsive
          this.textField.setValueChangeTimeout(200);
          this.textField.focus();
          setContent(textField);
          setSizeFull();
  
          this.commandHint.setStyleName("command");
          this.commandHint.setValue((i18n.translate("findbar.command")));
          this.commandHint.setVisible(false);
      }
  
      @Override
      public void focus() {
          textField.focus();
      }
  
      @SuppressWarnings("UnusedReturnValue")
      Registration addFocusListener(FieldEvents.FocusListener listener) {
          return textField.addFocusListener(listener);
      }
  
      @SuppressWarnings("UnusedReturnValue")
      Registration addBlurListener(FieldEvents.BlurListener listener) {
          return textField.addBlurListener(listener);
      }
  
      @SuppressWarnings("UnusedReturnValue")
      Registration addValueChangeListener(HasValue.ValueChangeListener<String> listener) {
          return textField.addValueChangeListener(listener);
      }
  
      void clear() {
          textField.clear();
          clearCommand();
      }
 
     String getValue() {
         return textField.getValue();
     }
 
     void setValue(String value) {
         textField.setValue(value);
     }
 
     boolean hasFocus() {
         return textFieldHasFocus.get();
     }
 
     void setFocusStatus(boolean focus) {
         textFieldHasFocus.set(focus);
         if (command == null && !focus) {
             commandHint.setVisible(false);
         }
     }
 
     Component getCommandHint() {
         return commandHint;
     }
 
     Optional<OperationRequest> getCommand() {
         return Optional.ofNullable(command);
     }
 
     void setCommand(OperationRequest command) {
         this.command = command;
         commandHint.setVisible(true);
     }
 
     void clearCommand() {
         command = null;
         commandHint.setVisible(false);
     }
 }