org.dominokit.domino.ui.elements.PreElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-ui Show documentation

There is a newer version: 2.0.3

/*
 * 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.elements;

import static org.dominokit.domino.ui.utils.Domino.*;

import elemental2.dom.HTMLPreElement;

/**
 * Represents an HTML  element wrapper.
 * 
 * The HTML  element defines preformatted text. This element is used to display text where whitespace and line breaks
 * inside the  element are rendered as written. It is often used for displaying code snippets or any text where
 * formatting is important.
 * This class provides a Java-based way to create, manipulate, and control the behavior of  elements in web applications.
 * 
 *
 * Example usage:
 *  * {@code
 * HTMLPreElement preElement = ...;  // Obtain a  element from somewhere
 * PreElement pre = PreElement.of(preElement);
 * }
 * 
 *
 * @see MDN Web Docs (pre)
 */
public class PreElement extends BaseElement {

  /**
   * Creates a new {@link PreElement} instance by wrapping the provided HTML  element.
   *
   * @param e The HTML  element to wrap.
   * @return A new {@link PreElement} instance wrapping the provided element.
   */
  public static PreElement of(HTMLPreElement e) {
    return new PreElement(e);
  }

  /**
   * Constructs a {@link PreElement} instance by wrapping the provided HTML  element.
   *
   * @param element The HTML  element to wrap.
   */
  public PreElement(HTMLPreElement element) {
    super(element);
  }
}