org.dominokit.domino.ui.elements.BRElement 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.HTMLBRElement;

/**
 * Represents a break (`

 * `) HTML element wrapper.
 *
 * This class provides a convenient way to create, manipulate, and control the behavior of break
 * HTML elements. Example usage:
 *
 * 
 * HTMLBRElement htmlElement = ...;  // Obtain a 
 element from somewhere
 * BRElement brElement = BRElement.of(htmlElement);
 * 
 *
 * @see MDN Web Docs (br
 *     element)
 */
public class BRElement extends BaseElement {

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

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