org.dominokit.domino.ui.themes.DominoThemeDark 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.themes;

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

import elemental2.dom.Element;
import org.dominokit.domino.ui.style.CssClass;
import org.dominokit.domino.ui.style.DominoCss;
import org.dominokit.domino.ui.utils.ElementsFactory;

/**
 * Represents the dark theme for Domino UI components.
 *
 * This class provides methods to apply, check, and remove the dark theme on a specific UI
 * element.
 *
 * 
Usage Example:
 *
 * 
{@code
 * DominoThemeDark darkTheme = DominoThemeDark.INSTANCE;
 * darkTheme.apply(myElement);
 * }
 *
 * @see IsDominoTheme
 * @see CssClass
 * @see ElementsFactory
 * @see DominoCss
 */
public class DominoThemeDark implements IsDominoTheme, ElementsFactory, DominoCss {

  /** Singleton instance of {@link DominoThemeDark}. */
  public static final IsDominoTheme INSTANCE = new DominoThemeDark();

  /** CSS class representing the dark theme. */
  private CssClass dui_theme_dark = () -> "dui-colors-dark";

  /**
   * Retrieves the name of the theme.
   *
   * @return theme name as a string.
   */
  @Override
  public String getName() {
    return "dui-theme-dark";
  }

  /**
   * Retrieves the category of the theme.
   *
   * @return theme category as a string. In this case, it's categorized under "dui-dark-mode".
   */
  @Override
  public String getCategory() {
    return "dui-dark-mode";
  }

  /**
   * Applies the dark theme to the specified element.
   *
   * @param element target element to apply the theme on.
   */
  @Override
  public void apply(Element element) {
    elementOf(element).addCss(dui_theme_dark);
  }

  /**
   * Removes the dark theme from the specified element.
   *
   * @param element target element to remove the theme from.
   */
  @Override
  public void cleanup(Element element) {
    elementOf(element).removeCss(dui_theme_dark);
  }

  /**
   * Checks if the dark theme is applied to the specified element.
   *
   * @param element the target element to check.
   * @return {@code true} if the theme is applied, otherwise {@code false}.
   */
  @Override
  public boolean isApplied(Element element) {
    return dui_theme_dark.isAppliedTo(element);
  }
}