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

/**
 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-embed-element">&lt;embed&gt;</a>
 * element.
 *
 * <p>
 * The embed element represents an integration point for an external application or interactive content.
 * It is used to embed content such as Flash applications, PDF documents, or other multimedia content
 * that requires a plugin or external application to display.
 *
 * <h5 class='section'>Examples:</h5>
 * <p class='bcode w800'>
 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
 * 
 *    <jc>// Embed a PDF document</jc>
 *    Embed <jv>embed1</jv> = <jsm>embed</jsm>()
 *       .src(<js>"document.pdf"</js>)
 *       .type(<js>"application/pdf"</js>)
 *       .width(<js>"800"</js>)
 *       .height(<js>"600"</js>);
 * 
 *    <jc>// Embed a Flash application</jc>
 *    Embed <jv>embed2</jv> = <jsm>embed</jsm>()
 *       .src(<js>"game.swf"</js>)
 *       .type(<js>"application/x-shockwave-flash"</js>)
 *       .width(<js>"640"</js>)
 *       .height(<js>"480"</js>);
 * 
 *    <jc>// Embed with fallback content</jc>
 *    Embed <jv>embed3</jv> = <jsm>embed</jsm>()
 *       .src(<js>"interactive-content.swf"</js>)
 *       .type(<js>"application/x-shockwave-flash"</js>)
 *       .children(
 *          <jsm>p</jsm>(<js>"Your browser does not support embedded content."</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#embed() embed()}
 *    </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="embed")
public class Embed extends HtmlElementVoid {

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

   /**
    * Creates an {@link Embed} element with the specified {@link Embed#src(Object)} attribute.
    *
    * @param src The {@link Embed#src(Object)} attribute.
    */
   public Embed(Object src) {
      src(src);
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
    * attribute.
    *
    * <p>
    * Vertical dimension.
    *
    * @param height
    *    The new value for this attribute.
    *    Typically a {@link Number} or {@link String}.
    * @return This object.
    */
   public Embed height(Object value) {
      attr("height", value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-embed-src">src</a> attribute.
    *
    * <p>
    * Address of the resource.
    *
    * <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 src
    *    The new value for this attribute.
    *    Typically a {@link URL} or {@link String}.
    * @return This object.
    */
   public Embed src(Object value) {
      attrUri("src", value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-embed-type">type</a> attribute.
    *
    * <p>
    * Specifies the MIME type of the embedded resource. Helps browsers determine how to handle the resource.
    *
    * <p>
    * Common values:
    * <ul>
    *    <li><js>"application/pdf"</js> - PDF document</li>
    *    <li><js>"application/x-shockwave-flash"</js> - Flash content</li>
    *    <li><js>"image/svg+xml"</js> - SVG image</li>
    *    <li><js>"video/mp4"</js> - MP4 video</li>
    *    <li><js>"audio/mp3"</js> - MP3 audio</li>
    * </ul>
    *
    * @param type The MIME type of the embedded resource.
    * @return This object.
    */
   public Embed type(String value) {
      attr("type", value);
      return this;
   }

   /**
    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
    *
    * <p>
    * Horizontal dimension.
    *
    * @param width
    *    The new value for this attribute.
    *    Typically a {@link Number} or {@link String}.
    * @return This object.
    */
   public Embed width(Object value) {
      attr("width", value);
      return this;
   }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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