org.dominokit.domino.ui.elements.ProgressElement 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.HTMLProgressElement;

/**
 * Represents an HTML  element wrapper.
 *
 * The HTML  element is used to view the completion progress of a task. It is often
 * used to represent the progress of a download/upload operation, file processing, or any task that
 * has a measurable progress. This class provides a Java-based way to create, manipulate, and
 * control the behavior of  elements in web applications. Example usage:
 *
 * 
 * HTMLProgressElement progressElement = ...;  // Obtain a  element from somewhere
 * ProgressElement progress = ProgressElement.of(progressElement);
 * 
 *
 * @see MDN Web Docs
 *     (progress)
 */
public class ProgressElement extends BaseElement {

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

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