/*
    * Copyright (c) 2002-2026 Gargoyle Software Inc.
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * https://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.htmlunit.html;
  
  import java.io.IOException;
  import java.io.PrintWriter;
  import java.util.Map;
  
  import org.htmlunit.SgmlPage;
  import org.htmlunit.javascript.host.event.KeyboardEvent;
  import org.htmlunit.util.NameValuePair;
  import org.htmlunit.util.StringUtils;
  
  /**
   * Wrapper for the HTML element "input".
   *
   * @author Mike Bowler
   * @author David K. Taylor
   * @author Christian Sell
   * @author Daniel Gredler
   * @author Ahmed Ashour
   * @author Marc Guillemot
   * @author Ronald Brill
   * @author Frank Danek
   */
  public class HtmlSubmitInput extends HtmlInput implements LabelableElement {
  
      /**
       * Value to use if no specified <code>value</code> attribute.
       */
      public static final String DEFAULT_VALUE = "Submit Query";
  
      /**
       * Creates an instance.
       *
       * @param qualifiedName the qualified name of the element type to instantiate
       * @param page the page that contains this element
       * @param attributes the initial attributes
       */
      HtmlSubmitInput(final String qualifiedName, final SgmlPage page,
              final Map<String, DomAttr> attributes) {
          super(qualifiedName, page, attributes);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      protected void doType(final int keyCode, final boolean lastType) throws IOException {
          if (keyCode == KeyboardEvent.DOM_VK_SPACE) {
              click();
              return;
          }
  
          super.doType(keyCode, lastType);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      protected boolean doClickStateUpdate(final boolean shiftKey, final boolean ctrlKey) throws IOException {
          if (!isDisabled()) {
              final HtmlForm form = getEnclosingForm();
              if (form != null) {
                  form.submit(this);
                  return false;
              }
          }
          super.doClickStateUpdate(shiftKey, ctrlKey);
          return false;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void setValue(final String newValue) {
          unmarkValueDirty();
          setDefaultValue(newValue);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void setDefaultChecked(final boolean defaultChecked) {
         // Empty.
     }
 
     /**
      * {@inheritDoc} This method <b>does nothing</b> for submit input elements.
      * @see SubmittableElement#reset()
      */
     @Override
     public void reset() {
         // Empty.
     }
 
     /**
      * {@inheritDoc} Doesn't print the attribute if it is <code>value="Submit Query"</code>.
      */
     @Override
     protected void printOpeningTagContentAsXml(final PrintWriter printWriter) {
         printWriter.print(getTagName());
 
         for (final DomAttr attribute : getAttributesMap().values()) {
             final String name = attribute.getNodeName();
             final String value = attribute.getValue();
             if (!VALUE_ATTRIBUTE.equals(name) || !DEFAULT_VALUE.equals(value)) {
                 printWriter.print(" ");
                 printWriter.print(name);
                 printWriter.print("=\"");
                 printWriter.print(StringUtils.escapeXmlAttributeValue(value));
                 printWriter.print("\"");
             }
         }
     }
 
     /**
      * {@inheritDoc}
      *
      * Returns "Submit Query" if <code>name</code> attribute is defined and <code>value</code> attribute is not defined.
      */
     @Override
     public NameValuePair[] getSubmitNameValuePairs() {
         if (!getNameAttribute().isEmpty() && !hasAttribute(VALUE_ATTRIBUTE)) {
             return new NameValuePair[]{new NameValuePair(getNameAttribute(), DEFAULT_VALUE)};
         }
         return super.getSubmitNameValuePairs();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     protected boolean isRequiredSupported() {
         return false;
     }
 }