All Downloads are FREE. Search and download functionalities are using the official Maven repository.
org.dominokit.domino.ui.utils.DomElements Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2019 Dominokit
 *
 * 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
 *
 *     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.dominokit.domino.ui.utils;

import static elemental2.dom.DomGlobal.document;
import static jsinterop.base.Js.cast;
import static org.dominokit.domino.ui.utils.Domino.*;

import elemental2.dom.*;
import elemental2.svg.SVGCircleElement;
import elemental2.svg.SVGElement;
import elemental2.svg.SVGLineElement;

/**
 * The {@code DomElements} interface provides factory methods for creating various HTML and SVG
 * elements as well as accessing commonly used HTML elements from the DOM.
 *
 * Example Usage:
 *
 * 
 * // Create an anchor element
 * HTMLAnchorElement anchorElement = DomElements.dom.a();
 *
 * // Create an input element with a specific type
 * HTMLInputElement inputElement = DomElements.dom.input(InputType.TEXT);
 *
 * // Access the document body element
 * HTMLBodyElement bodyElement = DomElements.dom.body();
 * 
 */
public interface DomElements {

  /** The XML namespace for SVG elements. */
  String SVGNS = "http://www.w3.org/2000/svg";

  /** An instance of the {@code DomElements} interface for convenience. */
  DomElements dom = new DomElements() {};

  /**
   * Creates an HTML element of the specified type.
   *
   * @param element The name of the HTML element.
   * @param type The class representing the HTML element.
   * @return An instance of the created HTML element.
   */
  default  E create(String element, Class type) {
    return cast(document.createElement(element));
  }

  /**
   * Creates an SVG element of the specified type.
   *
   * @param element The name of the SVG element.
   * @param type The class representing the SVG element.
   * @return An instance of the created SVG element.
   */
  default  E createSVG(String element, Class type) {
    return cast(document.createElementNS(SVGNS, element));
  }

  /**
   * Accesses the document's body element.
   *
   * @return The HTML body element.
   */
  default HTMLBodyElement body() {
    return document.body;
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created picture element.
   */
  default HTMLPictureElement picture() {
    return create("picture", HTMLPictureElement.class);
  }

  /**
   * Creates an {@code } element.
   *
   * @return The created address element.
   */
  default HTMLElement address() {
    return create("address", HTMLElement.class);
  }

  /**
   * Creates an {@code } element.
   *
   * @return The created article element.
   */
  default HTMLElement article() {
    return create("article", HTMLElement.class);
  }

  /**
   * Creates an {@code } element.
   *
   * @return The created aside element.
   */
  default HTMLElement aside() {
    return create("aside", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created footer element.
   */
  default HTMLElement footer() {
    return create("footer", HTMLElement.class);
  }

  /**
   * Creates an {@code } element with the specified level.
   *
   * @param n The heading level (e.g., 1 for {@code }, 2 for {@code 
}).
   * @return The created heading element.
   */
  default HTMLHeadingElement h(int n) {
    return create("h" + n, HTMLHeadingElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created header element.
   */
  default HTMLElement header() {
    return create("header", HTMLElement.class);
  }

  /**
   * Creates an {@code } element.
   *
   * @return The created hgroup element.
   */
  default HTMLElement hgroup() {
    return create("hgroup", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created nav element.
   */
  default HTMLElement nav() {
    return create("nav", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created section element.
   */
  default HTMLElement section() {
    return create("section", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created blockquote element.
   */
  default HTMLQuoteElement blockquote() {
    return create("blockquote", HTMLQuoteElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created dd element.
   */
  default HTMLElement dd() {
    return create("dd", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created div element.
   */
  default HTMLDivElement div() {
    return create("div", HTMLDivElement.class);
  }

  /**
   * Creates a {@code } element (definition list).
   *
   * @return The created dl element.
   */
  default HTMLDListElement dl() {
    return create("dl", HTMLDListElement.class);
  }

  /**
   * Creates a {@code } element (definition term).
   *
   * @return The created dt element.
   */
  default HTMLElement dt() {
    return create("dt", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created figcaption element.
   */
  default HTMLElement figcaption() {
    return create("figcaption", HTMLElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created figure element.
   */
  default HTMLElement figure() {
    return create("figure", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (horizontal rule).
   *
   * @return The created hr element.
   */
  default HTMLHRElement hr() {
    return create("hr", HTMLHRElement.class);
  }

  /**
   * Creates a {@code } element (list item).
   *
   * @return The created li element.
   */
  default HTMLLIElement li() {
    return create("li", HTMLLIElement.class);
  }

  /**
   * Creates a {@code } element.
   *
   * @return The created main element.
   */
  default HTMLElement main() {
    return create("main", HTMLElement.class);
  }

  /**
   * Creates an {@code } element (ordered list).
   *
   * @return The created ol element.
   */
  default HTMLOListElement ol() {
    return create("ol", HTMLOListElement.class);
  }

  /**
   * Creates a {@code } element (paragraph).
   *
   * @return The created p element.
   */
  default HTMLParagraphElement p() {
    return create("p", HTMLParagraphElement.class);
  }

  /**
   * Creates a {@code 
} element (preformatted text).
   *
   * @return The created pre element.
   */
  default HTMLPreElement pre() {
    return create("pre", HTMLPreElement.class);
  }

  /**
   * Creates a {@code } element (unordered list).
   *
   * @return The created ul element.
   */
  default HTMLUListElement ul() {
    return create("ul", HTMLUListElement.class);
  }

  /**
   * Creates an {@code } element (anchor).
   *
   * @return The created a element.
   */
  default HTMLAnchorElement a() {
    return create("a", HTMLAnchorElement.class);
  }

  /**
   * Creates an {@code } element (abbreviation).
   *
   * @return The created abbr element.
   */
  default HTMLElement abbr() {
    return create("abbr", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (bold text).
   *
   * @return The created b element.
   */
  default HTMLElement b() {
    return create("b", HTMLElement.class);
  }

  /**
   * Creates a {@code 
} element (line break).
   *
   * @return The created br element.
   */
  default HTMLBRElement br() {
    return create("br", HTMLBRElement.class);
  }

  /**
   * Creates a {@code } element (citation).
   *
   * @return The created cite element.
   */
  default HTMLElement cite() {
    return create("cite", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (code).
   *
   * @return The created code element.
   */
  default HTMLElement code() {
    return create("code", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (definition).
   *
   * @return The created dfn element.
   */
  default HTMLElement dfn() {
    return create("dfn", HTMLElement.class);
  }

  /**
   * Creates an {@code } element (emphasized text).
   *
   * @return The created em element.
   */
  default HTMLElement em() {
    return create("em", HTMLElement.class);
  }

  /**
   * Creates an {@code } element (italicized text).
   *
   * @return The created i element.
   */
  default HTMLElement i() {
    return create("i", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (keyboard input).
   *
   * @return The created kbd element.
   */
  default HTMLElement kbd() {
    return create("kbd", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (highlighted text).
   *
   * @return The created mark element.
   */
  default HTMLElement mark() {
    return create("mark", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (short inline quotation).
   *
   * @return The created q element.
   */
  default HTMLQuoteElement q() {
    return create("q", HTMLQuoteElement.class);
  }

  /**
   * Creates a {@code } element (small text).
   *
   * @return The created small element.
   */
  default HTMLElement small() {
    return create("small", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (generic inline container).
   *
   * @return The created span element.
   */
  default HTMLElement span() {
    return create("span", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (strong importance).
   *
   * @return The created strong element.
   */
  default HTMLElement strong() {
    return create("strong", HTMLElement.class);
  }

  /**
   * Creates a {@code _{} element (subscript).
   *
   * @return The created sub element.
   */
  default HTMLElement sub() {
    return create("sub", HTMLElement.class);
  }

  /**
   * Creates a {@code ^{} element (superscript).
   *
   * @return The created sup element.
   */
  default HTMLElement sup() {
    return create("sup", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (time or date).
   *
   * @return The created time element.
   */
  default HTMLElement time() {
    return create("time", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (underlined text).
   *
   * @return The created u element.
   */
  default HTMLElement u() {
    return create("u", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (variable).
   *
   * @return The created var element.
   */
  default HTMLElement var() {
    return create("var", HTMLElement.class);
  }

  /**
   * Creates a {@code } element (word break opportunity).
   *
   * @return The created wbr element.
   */
  default HTMLElement wbr() {
    return create("wbr", HTMLElement.class);
  }

  /**
   * Creates an {@code } element (image map area).
   *
   * @return The created area element.
   */
  default HTMLAreaElement area() {
    return create("area", HTMLAreaElement.class);
  }

  /**
   * Creates an {@code}}