/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      http://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.apache.juneau.bean.html5;

import java.net.*;

import org.apache.juneau.*;
import org.apache.juneau.annotation.*;

/**
 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-a-element">&lt;a&gt;</a>
 * element.
 *
 * <p>
 * The anchor element creates a hyperlink to other web pages, files, locations within the same page,
 * email addresses, or any other URL. It is one of the most fundamental elements for web navigation.
 *
 * <h5 class='section'>Examples:</h5>
 * <p class='bcode w800'>
 *    <jc>// Simple link to another page</jc>
 *    A <jv>a1</jv> = <jsm>a</jsm>().href(<js>"https://example.com"</js>).text(<js>"Visit Example"</js>);
 *
 *    <jc>// Link with target to open in new window</jc>
 *    A <jv>a2</jv> = <jsm>a</jsm>().href(<js>"https://example.com"</js>).target(<js>"_blank"</js>).text(<js>"Open in New Window"</js>);
 *
 *    <jc>// Email link</jc>
 *    A <jv>a3</jv> = <jsm>a</jsm>().href(<js>"mailto:user@example.com"</js>).text(<js>"Send Email"</js>);
 *
 *    <jc>// Link with relationship and language</jc>
 *    A <jv>a4</jv> = <jsm>a</jsm>().href(<js>"https://example.com"</js>).rel(<js>"nofollow"</js>).hreflang(<js>"en"</js>).text(<js>"English Version"</js>);
 * </p>
 *
 * <p>
 * The following convenience methods are provided for constructing instances of this bean:
 * <ul class='javatree'>
 *    <li class='jc'>{@link HtmlBuilder}
 *    <ul class='javatree'>
 *       <li class='jm'>{@link HtmlBuilder#a() a()}
 *       <li class='jm'>{@link HtmlBuilder#a(Object, Object...) a(Object, Object...)}
 *    </ul>
 * </ul>
 * </p>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
 * </ul>
 */
@Bean(typeName = "a")
public class A extends HtmlElementMixed {

   /**
    * Creates an empty {@link A} element.
    */
   public A() {}

   /**
    * Creates an {@link A} element with the specified {@link A#href(Object)} attribute and {@link A#children(Object[])}
    * nodes.
    *
    * @param href The {@link A#href(Object)} attribute.
    * @param children The {@link A#children(Object[])} nodes.
    */
   public A(Object href, Object[] children) {
      href(href).children(children);
   }

   @Override /* Overridden from HtmlElement */
   public A _class(String value) { // NOSONAR - Intentional naming.
      super._class(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A accesskey(String value) {
      super.accesskey(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A attr(String key, Object val) {
      super.attr(key, val);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A attrUri(String key, Object val) {
      super.attrUri(key, val);
      return this;
   }

   @Override /* Overridden from HtmlElementMixed */
   public A child(Object value) {
      super.child(value);
      return this;
   }

   @Override /* Overridden from HtmlElementMixed */
   public A children(Object...value) {
      super.children(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A contenteditable(Object value) {
      super.contenteditable(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A dir(String value) {
      super.dir(value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download">download</a> attribute.
    *
    * <p>
    * Whether to download the resource instead of navigating to it, and its file name if so.
    *
    * @param value
    *    The new value for this attribute.
    *    Typically a {@link Boolean} or {@link String}.
    * @return This object.
    */
   public A download(Object value) {
      attr("download", value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A hidden(Object value) {
      super.hidden(value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-href">href</a> attribute.
    *
    * <p>
    * Address of the hyperlink.
    *
    * <p>
    * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
    * Strings must be valid URIs.
    *
    * <p>
    * URIs defined by {@link UriResolver} can be used for values.
    *
    * @param value
    *    The new value for this attribute.
    *    Typically a {@link URL} or {@link String}.
    * @return This object.
    */
   public A href(Object value) {
      attrUri("href", value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang">hreflang</a> attribute.
    *
    * <p>
    * Specifies the language of the linked resource. Used for SEO and accessibility purposes.
    *
    * <p>
    * Examples:
    * <ul>
    *    <li><js>"en"</js> - English</li>
    *    <li><js>"es"</js> - Spanish</li>
    *    <li><js>"fr"</js> - French</li>
    *    <li><js>"de"</js> - German</li>
    *    <li><js>"zh"</js> - Chinese</li>
    *    <li><js>"ja"</js> - Japanese</li>
    * </ul>
    *
    * @param value The language code of the linked resource.
    * @return This object.
    */
   public A hreflang(String value) {
      attr("hreflang", value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A id(String value) {
      super.id(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A lang(String value) {
      super.lang(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onabort(String value) {
      super.onabort(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onblur(String value) {
      super.onblur(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A oncancel(String value) {
      super.oncancel(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A oncanplay(String value) {
      super.oncanplay(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A oncanplaythrough(String value) {
      super.oncanplaythrough(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onchange(String value) {
      super.onchange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onclick(String value) {
      super.onclick(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A oncuechange(String value) {
      super.oncuechange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A ondblclick(String value) {
      super.ondblclick(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A ondurationchange(String value) {
      super.ondurationchange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onemptied(String value) {
      super.onemptied(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onended(String value) {
      super.onended(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onerror(String value) {
      super.onerror(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onfocus(String value) {
      super.onfocus(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A oninput(String value) {
      super.oninput(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A oninvalid(String value) {
      super.oninvalid(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onkeydown(String value) {
      super.onkeydown(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onkeypress(String value) {
      super.onkeypress(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onkeyup(String value) {
      super.onkeyup(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onload(String value) {
      super.onload(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onloadeddata(String value) {
      super.onloadeddata(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onloadedmetadata(String value) {
      super.onloadedmetadata(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onloadstart(String value) {
      super.onloadstart(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmousedown(String value) {
      super.onmousedown(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmouseenter(String value) {
      super.onmouseenter(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmouseleave(String value) {
      super.onmouseleave(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmousemove(String value) {
      super.onmousemove(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmouseout(String value) {
      super.onmouseout(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmouseover(String value) {
      super.onmouseover(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmouseup(String value) {
      super.onmouseup(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onmousewheel(String value) {
      super.onmousewheel(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onpause(String value) {
      super.onpause(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onplay(String value) {
      super.onplay(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onplaying(String value) {
      super.onplaying(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onprogress(String value) {
      super.onprogress(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onratechange(String value) {
      super.onratechange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onreset(String value) {
      super.onreset(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onresize(String value) {
      super.onresize(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onscroll(String value) {
      super.onscroll(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onseeked(String value) {
      super.onseeked(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onseeking(String value) {
      super.onseeking(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onselect(String value) {
      super.onselect(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onshow(String value) {
      super.onshow(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onstalled(String value) {
      super.onstalled(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onsubmit(String value) {
      super.onsubmit(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onsuspend(String value) {
      super.onsuspend(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A ontimeupdate(String value) {
      super.ontimeupdate(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A ontoggle(String value) {
      super.ontoggle(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onvolumechange(String value) {
      super.onvolumechange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A onwaiting(String value) {
      super.onwaiting(value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel">rel</a> attribute.
    *
    * <p>
    * Specifies the relationship between the current document and the linked resource.
    *
    * <p>
    * Common values:
    * <ul>
    *    <li><js>"alternate"</js> - Alternative version of the page</li>
    *    <li><js>"author"</js> - Link to the author of the page</li>
    *    <li><js>"bookmark"</js> - Permalink for bookmarking</li>
    *    <li><js>"external"</js> - External link</li>
    *    <li><js>"help"</js> - Link to help documentation</li>
    *    <li><js>"license"</js> - Link to license information</li>
    *    <li><js>"next"</js> - Next page in a sequence</li>
    *    <li><js>"nofollow"</js> - Don't follow this link for SEO</li>
    *    <li><js>"noreferrer"</js> - Don't send referrer information</li>
    *    <li><js>"prev"</js> - Previous page in a sequence</li>
    *    <li><js>"search"</js> - Link to search functionality</li>
    *    <li><js>"tag"</js> - Tag for the current page</li>
    * </ul>
    *
    * @param value The relationship between the document and linked resource.
    * @return This object.
    */
   public A rel(String value) {
      attr("rel", value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A spellcheck(Object value) {
      super.spellcheck(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A style(String value) {
      super.style(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A tabindex(Object value) {
      super.tabindex(value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target">target</a> attribute.
    *
    * <p>
    * Specifies where to open the linked resource when the link is clicked.
    *
    * <p>
    * Common values:
    * <ul>
    *    <li><js>"_blank"</js> - Open in a new window/tab</li>
    *    <li><js>"_self"</js> - Open in the same frame (default)</li>
    *    <li><js>"_parent"</js> - Open in the parent frame</li>
    *    <li><js>"_top"</js> - Open in the full body of the window</li>
    *    <li><js>"framename"</js> - Open in a named frame</li>
    * </ul>
    *
    * @param value Where to open the linked resource.
    * @return This object.
    */
   public A target(String value) {
      attr("target", value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A title(String value) {
      super.title(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public A translate(Object value) {
      super.translate(value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type">type</a> attribute.
    *
    * <p>
    * Specifies the MIME type of the linked resource. Helps browsers determine how to handle the resource.
    *
    * <p>
    * Common values:
    * <ul>
    *    <li><js>"text/html"</js> - HTML document</li>
    *    <li><js>"text/css"</js> - CSS stylesheet</li>
    *    <li><js>"application/pdf"</js> - PDF document</li>
    *    <li><js>"image/png"</js> - PNG image</li>
    *    <li><js>"application/zip"</js> - ZIP archive</li>
    * </ul>
    *
    * @param value The MIME type of the linked resource.
    * @return This object.
    */
   public A type(String value) {
      attr("type", value);
      return this;
   }
}