/*
    * Copyright (c) 2002-2025 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.javascript.host.html;
  
  import org.htmlunit.html.DomElement;
  import org.htmlunit.html.HtmlForm;
  import org.htmlunit.html.HtmlOutput;
  import org.htmlunit.javascript.configuration.JsxClass;
  import org.htmlunit.javascript.configuration.JsxConstructor;
  import org.htmlunit.javascript.configuration.JsxFunction;
  import org.htmlunit.javascript.configuration.JsxGetter;
  import org.htmlunit.javascript.configuration.JsxSetter;
  import org.htmlunit.javascript.host.dom.NodeList;
  
  /**
   * The JavaScript object {@code HTMLOutputElement}.
   *
   * @author Ronald Brill
   * @author Ahmed Ashour
   */
  @JsxClass(domClass = HtmlOutput.class)
  public class HTMLOutputElement extends HTMLElement {
  
      /** "Live" labels collection; has to be a member to have equality (==) working. */
      private NodeList labels_;
  
      /**
       * JavaScript constructor.
       */
      @Override
      @JsxConstructor
      public void jsConstructor() {
          super.jsConstructor();
      }
  
      /**
       * Returns the {@code name} attribute.
       * @return the {@code name} attribute
       */
      @JsxGetter
      @Override
      public String getName() {
          return getDomNodeOrDie().getAttributeDirect(DomElement.NAME_ATTRIBUTE);
      }
  
      /**
       * Sets the {@code name} attribute.
       * @param name the {@code name} attribute
       */
      @JsxSetter
      @Override
      public void setName(final String name) {
          getDomNodeOrDie().setAttribute(DomElement.NAME_ATTRIBUTE, name);
      }
  
      /**
       * Returns the value of the JavaScript {@code form} attribute.
       *
       * @return the value of the JavaScript {@code form} attribute
       */
      @JsxGetter
      @Override
      public HTMLFormElement getForm() {
          final HtmlForm form = getDomNodeOrDie().getEnclosingForm();
          if (form == null) {
              return null;
          }
          return (HTMLFormElement) getScriptableFor(form);
      }
  
      /**
       * Returns the labels associated with the element.
       * @return the labels associated with the element
       */
      @JsxGetter
      public NodeList getLabels() {
          if (labels_ == null) {
              labels_ = new LabelsNodeList(getDomNodeOrDie());
          }
          return labels_;
      }
  
      /**
       * Checks whether the element has any constraints and whether it satisfies them.
       * @return if the element is valid
       */
      @JsxFunction
     public boolean checkValidity() {
         return getDomNodeOrDie().isValid();
     }
 
     /**
      * @return a ValidityState with the validity states that this element is in.
      */
     @JsxGetter
     public ValidityState getValidity() {
         final ValidityState validityState = new ValidityState();
         validityState.setPrototype(getPrototype(validityState.getClass()));
         validityState.setParentScope(getParentScope());
         validityState.setDomNode(getDomNodeOrDie());
         return validityState;
     }
 
     /**
      * @return whether the element is a candidate for constraint validation
      */
     @JsxGetter
     public boolean getWillValidate() {
         return ((HtmlOutput) getDomNodeOrDie()).willValidate();
     }
 
     /**
      * Sets the custom validity message for the element to the specified message.
      * @param message the new message
      */
     @JsxFunction
     public void setCustomValidity(final String message) {
         ((HtmlOutput) getDomNodeOrDie()).setCustomValidity(message);
     }
 }