org.patternfly.component.Expandable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of patternfly-java-components Show documentation
PatternFly Java components
There is a newer version: 0.2.11
Show newest version
/*
 *  Copyright 2023 Red Hat
 *
 *  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
 *
 *      https://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.patternfly.component;

import org.jboss.elemento.IsElement;
import org.jboss.elemento.TypedBuilder;
import org.patternfly.core.Aria;
import org.patternfly.style.Classes;

import elemental2.dom.Element;
import elemental2.dom.HTMLElement;

import static org.patternfly.style.Classes.modifier;

/**
 * Contains methods and default implementations for components that are expandable.
 */
public interface Expandable> extends TypedBuilder,
        IsElement {

    // ------------------------------------------------------ static helper methods

    static void collapse(HTMLElement root, HTMLElement toggle, HTMLElement menu) {
        collapse(root, toggle, menu, false);
    }

    static void collapse(HTMLElement root, HTMLElement toggle, HTMLElement menu, boolean force) {
        if (force || expanded(root)) {
            root.classList.remove(modifier(Classes.expanded));
            if (toggle != null) {
                toggle.setAttribute(Aria.expanded, false);
            }
            if (menu != null) {
                menu.hidden = true;
            }
        }
    }

    static void expand(HTMLElement root, HTMLElement toggle, HTMLElement menu) {
        expand(root, toggle, menu, false);
    }

    static void expand(HTMLElement root, HTMLElement toggle, HTMLElement menu, boolean force) {
        if (force || !expanded(root)) {
            root.classList.add(modifier(Classes.expanded));
            if (toggle != null) {
                toggle.setAttribute(Aria.expanded, true);
            }
            if (menu != null) {
                menu.hidden = false;
            }
        }
    }

    static boolean expanded(Element root) {
        return root != null && root.classList.contains(modifier(Classes.expanded));
    }

    // ------------------------------------------------------ interface methods

    /**
     * Same as {@linkplain #toggle(boolean) toggle(true)}
     */
    default void toggle() {
        toggle(true);
    }

    /**
     * Calls {@link #collapse(boolean)}, if {@link #expanded()} is {@code true}, {@link #expand(boolean)} otherwise.
     */
    default void toggle(boolean fireEvent) {
        if (expanded()) {
            collapse(fireEvent);
        } else {
            expand(fireEvent);
        }
    }

    /**
     * Same as {@linkplain #collapse(boolean) collapse(true)}
     */
    default void collapse() {
        collapse(true);
    }

    void collapse(boolean fireEvent);

    /**
     * Same as {@linkplain #expand(boolean) expand(true)}
     */
    default void expand() {
        expand(true);
    }

    void expand(boolean fireEvent);

    /**
     * @return {@code true} if the elements class list has the modifier {@link Classes#expanded}, {@code false} otherwise.
     */
    default boolean expanded() {
        return expanded(element());
    }
}