org.dominokit.domino.ui.forms.SelectOptionGroup 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.forms;

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

import elemental2.dom.DomGlobal;
import elemental2.dom.HTMLElement;
import elemental2.dom.HTMLLIElement;
import elemental2.dom.Node;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
import org.dominokit.domino.ui.utils.BaseDominoElement;
import org.dominokit.domino.ui.utils.DominoElement;
import org.jboss.elemento.IsElement;

/**
 * A component that can group a set of {@link SelectOption}
 *
 * @param  The type of the SelectOption value
 */
public class SelectOptionGroup extends BaseDominoElement> {

  private DominoElement element = DominoElement.of(li()).css("dropdown-header");
  private List> options = new ArrayList<>();
  private Node titleElement;
  private Consumer> addOptionConsumer = (option) -> {};

  /**
   * Creates a group with title
   *
   * @param titleElement {@link Node} to be used as the title
   */
  public SelectOptionGroup(Node titleElement) {
    this.titleElement = titleElement;
    element.addEventListener(
        "click",
        evt -> {
          evt.preventDefault();
          evt.stopPropagation();
        });
    element.appendChild(titleElement);
    init(this);
  }

  /**
   * Creates a group with title
   *
   * @param title String to be used as the title
   * @return new SelectOptionGroup instance
   */
  public static  SelectOptionGroup create(String title) {
    return create(DomGlobal.document.createTextNode(title));
  }

  /**
   * Creates a group with title
   *
   * @param titleElement {@link Node} to be used as the title
   * @return new SelectOptionGroup instance
   */
  public static  SelectOptionGroup create(Node titleElement) {
    return new SelectOptionGroup<>(titleElement);
  }

  /**
   * Creates a group with title
   *
   * @param titleElement {@link HTMLElement} to be used as the title
   * @return new SelectOptionGroup instance
   */
  public static  SelectOptionGroup create(HTMLElement titleElement) {
    return create((Node) titleElement);
  }

  /**
   * Creates a group with title
   *
   * @param titleElement {@link IsElement} to be used as the title
   * @return new SelectOptionGroup instance
   */
  public static  SelectOptionGroup create(IsElement titleElement) {
    return create(titleElement.element());
  }

  /**
   * Adds a SelectOption to this group
   *
   * @param option {@link SelectOption}
   * @return same SelectOptionGroup instance
   */
  public SelectOptionGroup appendChild(SelectOption option) {
    option.addCss("opt");
    options.add(option);
    if (nonNull(addOptionConsumer)) {
      addOptionConsumer.accept(option);
    }
    return this;
  }

  /**
   * Sets a consumer to be called when ever a SelectOption is added to this group
   *
   * @param addOptionConsumer Consumer of {@link SelectOption}
   */
  public void setAddOptionConsumer(Consumer> addOptionConsumer) {
    this.addOptionConsumer = addOptionConsumer;
  }

  /** @return List of all {@link SelectOption} in this group */
  public List> getOptions() {
    return options;
  }

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

  /** @return boolean, true if all the options in the group are hidden */
  boolean isAllHidden() {
    return options.stream().allMatch(SelectOption::isCollapsed);
  }

  /**
   * Adds the options in this group to the specified Select
   *
   * @param select {@link Select}
   */
  void addOptionsTo(AbstractSelect select) {
    for (SelectOption option : options) {
      option.addHideListener(this::changeVisibility);
      option.addShowListener(this::changeVisibility);
      select.appendChild(option);
    }
  }

  /** Change the visibility of this group based on its options visibility */
  void changeVisibility() {
    if (isAllHidden()) {
      hide();
    } else {
      show();
    }
  }

  /** @return the {@link Node} used as title for this group */
  public Node getTitleElement() {
    return titleElement;
  }
}