/*
 * 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 org.apache.juneau.annotation.*;
import org.apache.juneau.internal.*;

/**
 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-template-element">&lt;template&gt;</a>
 * element.
 *
 * <p>
 * The template element represents a template for a fragment of HTML that can be cloned and
 * inserted into the document by script. It is used to define reusable HTML content that
 * can be instantiated multiple times using JavaScript. The template element is not rendered
 * in the document until its content is cloned and inserted into the DOM. It is commonly
 * used for creating dynamic content, such as repeating elements in lists or generating
 * content based on data.
 *
 * <h5 class='section'>Examples:</h5>
 * <p class='bcode w800'>
 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
 *
 *    <jc>// Simple template</jc>
 *    Template <jv>simple</jv> = <jsm>template</jsm>(
 *       <jsm>p</jsm>(<js>"This is a template paragraph."</js>)
 *    );
 *
 *    <jc>// Template with styling</jc>
 *    Template <jv>styled</jv> = <jsm>template</jsm>(
 *       <jsm>div</jsm>(
 *          <jsm>h3</jsm>(<js>"Item Title"</js>),
 *          <jsm>p</jsm>(<js>"Item description"</js>)
 *       )._class(<js>"item"</js>)
 *    )._class(<js>"item-template"</js>);
 *
 *    <jc>// Template with complex content</jc>
 *    Template <jv>complex</jv> = <jsm>template</jsm>(
 *       <jsm>article</jsm>(
 *          <jsm>header</jsm>(
 *             <jsm>h2</jsm>(<js>"Article Title"</js>),
 *             <jsm>p</jsm>(<js>"Article subtitle"</js>)
 *          ),
 *          <jsm>p</jsm>(<js>"Article content goes here."</js>),
 *          <jsm>footer</jsm>(<js>"Article footer"</js>)
 *             )
 *       );
 *
 *    // Template with ID
 *    Template withId = template()
 *       .id("user-card-template")
 *       .children(
 *          div()._class("user-card")
 *             .children(
 *                img().src("/avatar.jpg").alt("User Avatar"),
 *                h3().children("User Name"),
 *                p().children("User Bio")
 *             )
 *       );
 *
 *    // Template with styling
 *    Template styled2 = template()
 *       .style("display: none;")
 *       .children(
 *          div()._class("modal")
 *             .children(
 *                h2().children("Modal Title"),
 *                p().children("Modal content")
 *             )
 *       );
 *
 *    // Template with multiple elements
 *    Template multiple = template()
 *       .children(
 *          div()._class("product-card")
 *             .children(
 *                img().src("/product.jpg").alt("Product Image"),
 *                h3().children("Product Name"),
 *                p().children("Product Description"),
 *                span()._class("price").children("$99.99"),
 *                button().children("Add to Cart")
 *             )
 *       );
 *
 *    // Template with form
 *    Template withForm = template()
 *       .children(
 *          form()._class("comment-form")
 *             .children(
 *                textarea().placeholder("Enter your comment"),
 *                button().type("submit").children("Submit Comment")
 *             )
 *       );
 * </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#template() template()}
 *       <li class='jm'>{@link HtmlBuilder#template(Object, Object...) template(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="template")
public class Template extends HtmlElementMixed {

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

   /**
    * Creates a {@link Template} element with the specified {@link Template#id(String)} attribute and child nodes.
    *
    * @param id The {@link Template#id(String)} attribute.
    * @param children The child nodes.
    */
   public Template(String id, Object...children) {
      id(id).children(children);
   }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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