org.dominokit.domino.ui.carousel.Slide 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.carousel;

import static org.dominokit.domino.ui.carousel.CarouselStyles.*;
import static org.jboss.elemento.Elements.*;

import elemental2.dom.*;
import org.dominokit.domino.ui.style.Style;
import org.dominokit.domino.ui.utils.BaseDominoElement;
import org.dominokit.domino.ui.utils.DominoElement;

/**
 * A component for an element for {@link Carousel}
 *
 * Images can be added to the component with the ability to add label and description
 *
 * @see BaseDominoElement
 * @see Carousel
 */
public class Slide extends BaseDominoElement {

  private final HTMLLIElement indicatorElement = li().element();
  private final HTMLHeadingElement slideLabelElement = h(3).element();
  private final HTMLParagraphElement slideDescriptionElement = p().element();
  private final HTMLDivElement captionElement =
      DominoElement.of(div())
          .add(slideLabelElement)
          .add(slideDescriptionElement)
          .css(CAROUSEL_CAPTION)
          .element();

  private final HTMLDivElement slideElement = DominoElement.of(div()).css(ITEM).element();

  private final HTMLElement imageElement;
  private boolean active = false;

  public Slide(String imageSrc) {
    this(img(imageSrc).element());
  }

  public Slide(HTMLImageElement image) {
    imageElement = image;
    slideElement.appendChild(image);
    init(this);
  }

  public Slide(HTMLPictureElement pictureElement) {
    imageElement = pictureElement;
    slideElement.appendChild(pictureElement);
    init(this);
  }

  public Slide(String imageSrc, String label, String description) {
    this(img(imageSrc).element(), label, description);
  }

  public Slide(HTMLImageElement image, String label, String description) {
    this(image);
    slideLabelElement.textContent = label;
    slideDescriptionElement.textContent = description;
    slideElement.appendChild(captionElement);
    init(this);
  }

  public Slide(HTMLPictureElement pictureElement, String label, String description) {
    this(pictureElement);
    slideLabelElement.textContent = label;
    slideDescriptionElement.textContent = description;
    slideElement.appendChild(captionElement);
    init(this);
  }

  /**
   * Creates new slide with image source
   *
   * @param imageSrc the url for the image
   * @return new instance
   */
  public static Slide create(String imageSrc) {
    return new Slide(imageSrc);
  }

  /**
   * Creates new slide with image source, label and description
   *
   * @param imageSrc the url for the image
   * @param label the image label
   * @param description the image description
   * @return new instance
   */
  public static Slide create(String imageSrc, String label, String description) {
    return new Slide(imageSrc, label, description);
  }

  /**
   * Creates new slide with {@link HTMLImageElement}
   *
   * @param image the {@link HTMLImageElement}
   * @return new instance
   */
  public static Slide create(HTMLImageElement image) {
    return new Slide(image);
  }

  /**
   * Creates new slide with {@link HTMLPictureElement}
   *
   * @param pictureElement the {@link HTMLPictureElement}
   * @return new instance
   */
  public static Slide create(HTMLPictureElement pictureElement) {
    return new Slide(pictureElement);
  }

  /**
   * Creates new slide with {@link HTMLPictureElement}, label and description
   *
   * @param pictureElement the {@link HTMLPictureElement}
   * @param label the image label
   * @param description the image description
   * @return new instance
   */
  public static Slide create(HTMLPictureElement pictureElement, String label, String description) {
    return new Slide(pictureElement, label, description);
  }

  /**
   * Creates new slide with {@link HTMLImageElement}, label and description
   *
   * @param image the {@link HTMLImageElement}
   * @param label the image label
   * @param description the image description
   * @return new instance
   */
  public static Slide create(HTMLImageElement image, String label, String description) {
    return new Slide(image, label, description);
  }

  /** @return The indicator element */
  public DominoElement getIndicatorElement() {
    return DominoElement.of(indicatorElement);
  }

  /** {@inheritDoc} */
  @Override
  public HTMLDivElement element() {
    return slideElement;
  }

  /**
   * Activates this slide. This will add {@link CarouselStyles#ACTIVE} style to the slide
   *
   * @return same instance
   */
  public Slide activate() {
    this.active = true;
    if (!Style.of(indicatorElement).containsCss(ACTIVE)) {
      Style.of(indicatorElement).addCss(ACTIVE);
    }
    if (!style().containsCss(ACTIVE)) {
      addCss(ACTIVE);
    }

    return this;
  }

  void deActivate() {
    this.active = false;
    Style.of(indicatorElement).removeCss(ACTIVE);
    removeCss(ACTIVE);
  }

  /**
   * Sets the slide to active without changing the styles
   *
   * @param active a boolean that indicates this slide is active
   */
  public void setActiveFlag(boolean active) {
    this.active = active;
  }

  /** @return True if this slide is active, false otherwise */
  public boolean isActive() {
    return active;
  }

  /**
   * Checks if this slide has {@link CarouselStyles#ACTIVE} style
   *
   * @return true if the slide has active style, false otherwise
   */
  public boolean hasActiveStyle() {
    return style().containsCss(ACTIVE);
  }

  /** @return The slide label element */
  public DominoElement getSlideLabelElement() {
    return DominoElement.of(slideLabelElement);
  }

  /** @return The slide description element */
  public DominoElement getSlideDescriptionElement() {
    return DominoElement.of(slideDescriptionElement);
  }

  /** @return The slide caption element */
  public DominoElement getCaptionElement() {
    return DominoElement.of(captionElement);
  }

  /** @return The image element */
  public DominoElement getImageElement() {
    return DominoElement.of(imageElement);
  }
}