org.dominokit.domino.ui.utils.DisableUtil 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.utils;

import static org.dominokit.domino.ui.utils.Domino.*;
import static org.dominokit.domino.ui.utils.ElementsFactory.elements;

import elemental2.dom.Element;
import java.util.Optional;
import org.dominokit.domino.ui.IsElement;

/**
 * The {@code DisableUtil} class provides utility methods for enabling and disabling HTML elements
 * and their focusable child elements. It offers the ability to disable elements, making them
 * non-interactable, and later re-enable them.
 *
 * Example Usage:
 *
 * 
 * // Disable a DOMino UI element
 * IsElement dominoElement = // Obtain the DOMino UI element
 * DisableUtil.disable(dominoElement);
 *
 * // Enable a DOMino UI element
 * DisableUtil.enable(dominoElement);
 * 
 */
public class DisableUtil {

  /** A comma-separated list of HTML element types considered focusable elements. */
  public static final String FOCUSABLE_ELEMENTS =
      "a, button, embed, iframe, label, audio[controls], video[controls], img[usemap], object[usemap], input, textarea, select, details, [tabindex]";

  /**
   * Disables the specified {@code IsElement} by making it non-interactable and disabling its
   * focusable child elements.
   *
   * @param element The {@code IsElement} to be disabled.
   */
  public static  void disable(IsElement element) {
    Optional.ofNullable(element).ifPresent(e -> disable(e.element()));
  }

  /**
   * Disables the specified HTML element by making it non-interactable and disabling its focusable
   * child elements.
   *
   * @param element The HTML element to be disabled.
   */
  public static void disable(Element element) {
    Optional.ofNullable(element)
        .ifPresent(
            e -> {
              DominoElement dominoElement = elements.elementOf(e);
              if (!isDisabled(dominoElement)) {
                disableElement(dominoElement);
                elements
                    .elementOf(element)
                    .querySelectorAll(FOCUSABLE_ELEMENTS)
                    .forEach(child -> disableChild(elements.elementOf(child)));
              }
            });
  }

  private static  void disableChild(DominoElement element) {
    if (element.isDisabled()) {
      element.setAttribute("dui-disabled", "true");
    } else {
      disableElement(element);
    }
  }

  private static  void disableElement(DominoElement element) {
    element.removeAttribute("dui-disabled");
    element.setAttribute("disabled", "");

    if (element.hasAttribute("tabindex")) {
      String original = element.getAttribute("tabindex");
      element.setAttribute("dui-tabindex", original);
    }
    element.setTabIndex(-1);
  }

  private static  boolean isDisabled(DominoElement element) {
    return element.hasAttribute("disabled");
  }

  /**
   * Enables the specified {@code IsElement} by making it interactable and enabling its focusable
   * child elements.
   *
   * @param element The {@code IsElement} to be enabled.
   */
  public static  void enable(IsElement element) {
    Optional.ofNullable(element).ifPresent(e -> enable(e.element()));
  }

  /**
   * Enables the specified HTML element by making it interactable and enabling its focusable child
   * elements.
   *
   * @param element The HTML element to be enabled.
   */
  public static void enable(Element element) {
    Optional.ofNullable(element)
        .ifPresent(
            e -> {
              DominoElement dominoElement = elements.elementOf(e);
              if (isDisabled(dominoElement)) {
                enableElement(dominoElement);
                elements
                    .elementOf(element)
                    .querySelectorAll(FOCUSABLE_ELEMENTS)
                    .forEach(child -> enableChild(elements.elementOf(child)));
              }
            });
  }

  private static  void enableChild(DominoElement element) {
    if (element.hasAttribute("dui-disabled")) {
      element.removeAttribute("dui-disabled");
    } else {
      enableElement(element);
    }
  }

  private static  void enableElement(DominoElement element) {
    element.removeAttribute("dui-disabled");
    element.removeAttribute("disabled");
    if (element.hasAttribute("dui-tabindex")) {
      String original = element.getAttribute("dui-tabindex");
      element.setTabIndex(Integer.parseInt(original));
    } else {
      element.removeAttribute("tabindex");
    }
  }
}