org.dominokit.domino.ui.elements.svg.UseElement 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.svg;

import elemental2.svg.SVGUseElement;
import org.dominokit.domino.ui.elements.BaseElement;

/**
 * This class provides a wrapper for the {@link SVGUseElement}, which represents an SVG use element.
 * The {@code UseElement} class allows you to work with use elements within the Domino UI framework,
 * making it easier to create and manipulate use elements in SVG graphics.
 *
 * @see BaseElement
 * @see SVGUseElement
 */
public class UseElement extends BaseElement {

  /**
   * Factory method for creating a new {@code UseElement} instance from an existing {@code
   * SVGUseElement}. This method provides a standardized way of wrapping {@code SVGUseElement}
   * objects within the Domino UI framework, promoting a consistent object creation pattern.
   *
   * @param e the {@code SVGUseElement} to wrap
   * @return a new instance of {@code UseElement}
   */
  public static UseElement of(SVGUseElement e) {
    return new UseElement(e);
  }

  /**
   * Constructs a new {@code UseElement} by encapsulating the provided {@code SVGUseElement}. The
   * constructor is protected to encourage the use of the static factory method {@code of()} for
   * creating new instances, ensuring uniformity across the framework.
   *
   * @param element the {@code SVGUseElement} to be wrapped
   */
  public UseElement(SVGUseElement element) {
    super(element);
  }
}