org.dominokit.domino.ui.breadcrumbs.BreadcrumbItem 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.breadcrumbs;

import static java.util.Objects.nonNull;
import static org.jboss.elemento.Elements.a;
import static org.jboss.elemento.Elements.li;

import elemental2.dom.HTMLAnchorElement;
import elemental2.dom.HTMLLIElement;
import elemental2.dom.Text;
import org.dominokit.domino.ui.icons.BaseIcon;
import org.dominokit.domino.ui.utils.BaseDominoElement;
import org.dominokit.domino.ui.utils.DominoElement;
import org.dominokit.domino.ui.utils.HasClickableElement;
import org.dominokit.domino.ui.utils.TextNode;

/**
 * A component for {@link Breadcrumb} location.
 *
 * This component provides basic styles of a location and functionalities that allows switching
 * between location statuses
 *
 * 
Customize the component can be done by overwriting classes provided by {@link
 * BreadcrumbStyles}
 *
 * 
For example:
 *
 * 
 *     Breadcrumb.create()
 *               .appendChild(BreadcrumbItem.create(" Home "))
 * 
 *
 * @see Breadcrumb
 * @see BaseDominoElement
 * @see HasClickableElement
 */
public class BreadcrumbItem extends BaseDominoElement
    implements HasClickableElement {

  private final DominoElement element = DominoElement.of(li().element());
  private final DominoElement anchorElement = DominoElement.of(a());
  private Text textElement;
  private BaseIcon icon;
  private boolean active = false;

  private BreadcrumbItem(String text) {
    init(text, null);
  }

  private BreadcrumbItem(String text, BaseIcon icon) {
    init(text, icon);
  }

  private void init(String text, BaseIcon icon) {
    init(this);
    this.textElement = TextNode.of(text);
    if (nonNull(icon)) {
      this.icon = icon;
      this.anchorElement.appendChild(icon);
    }
    this.anchorElement.appendChild(textElement);
    element.appendChild(anchorElement);
    anchorElement.setAttribute("tabindex", "0");
  }

  /**
   * Creates location with text content
   *
   * @param text the content of the item
   * @return new instance
   */
  public static BreadcrumbItem create(String text) {
    return new BreadcrumbItem(text);
  }

  /**
   * Creates item with text content and icon
   *
   * @param icon the {@link BaseIcon} of the item
   * @param text the content of the item
   * @return new instance
   */
  public static BreadcrumbItem create(BaseIcon icon, String text) {
    return new BreadcrumbItem(text, icon);
  }

  /**
   * Sets item as active, customizing the active style can be done by overwriting {@link
   * BreadcrumbStyles#ACTIVE} CSS class
   *
   * @return same instance
   */
  public BreadcrumbItem activate() {
    if (!active) {
      element.addCss(BreadcrumbStyles.ACTIVE);
      textElement.remove();
      anchorElement.remove();
      if (nonNull(icon)) {
        icon.element().remove();
        element.appendChild(icon);
      }
      element.appendChild(textElement);
      this.active = true;
    }

    return this;
  }

  /**
   * Sets item as inactive
   *
   * @return same instance
   */
  public BreadcrumbItem deActivate() {
    if (active) {
      element.removeCss(BreadcrumbStyles.ACTIVE);
      textElement.remove();
      if (nonNull(icon)) {
        icon.remove();
        anchorElement.appendChild(icon);
      }
      anchorElement.appendChild(textElement);
      element.appendChild(anchorElement);
      this.active = false;
    }

    return this;
  }

  /**
   * If true, sets the status to active, otherwise sets the status to inactive
   *
   * @param active the boolean to set the status
   * @return same instance
   */
  public BreadcrumbItem setActive(boolean active) {
    if (active) {
      return activate();
    } else {
      return deActivate();
    }
  }

  /** {@inheritDoc} */
  @Override
  public HTMLLIElement element() {
    return element.element();
  }

  /** {@inheritDoc} */
  @Override
  public HTMLAnchorElement getClickableElement() {
    return anchorElement.element();
  }

  /** @return the {@link Text} content */
  public Text getTextElement() {
    return textElement;
  }

  /** @return the {@link BaseIcon} */
  public BaseIcon getIcon() {
    return icon;
  }

  /** @return true if the item is active, false otherwise */
  public boolean isActive() {
    return active;
  }
}