org.patternfly.component.SubComponent 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.Container;
import org.jboss.elemento.Finder;
import org.jboss.elemento.HasElement;
import org.jboss.elemento.HasHTMLElement;
import org.jboss.elemento.Id;
import org.jboss.elemento.TypedBuilder;

import elemental2.dom.HTMLElement;

import static java.util.Objects.requireNonNull;

public abstract class SubComponent>
        implements HasElement, HasHTMLElement, Finder, Container {

    final ComponentType componentType;
    final String name;
    private final E element;

    protected SubComponent(ComponentType componentType, String name, E element) {
        this.componentType = requireNonNull(componentType, "component type required");
        this.name = requireNonNull(name, "name required");
        this.element = requireNonNull(element, "element required");
    }

    protected String subComponentId() {
        return Id.build(componentType.id, name);
    }

    @Override
    public E element() {
        return element;
    }

    // ------------------------------------------------------ component store

    protected void storeSubComponent() {
        ComponentStore.storeSubComponent(this);
    }

    protected , E1 extends HTMLElement, B1 extends TypedBuilder> C lookupComponent() {
        return lookupComponent(false);
    }

    protected , E1 extends HTMLElement, B1 extends TypedBuilder> C lookupComponent(
            boolean lenient) {
        return ComponentStore.lookupComponent(componentType, element, lenient);
    }

    protected , E1 extends HTMLElement, B1 extends TypedBuilder> C lookupComponentDelegate() {
        return lookupComponentDelegate(false);
    }

    protected , E1 extends HTMLElement, B1 extends TypedBuilder> C lookupComponentDelegate(
            boolean lenient) {
        return ComponentStore.lookupComponentDelegate(componentType, element, lenient);
    }

    protected , E1 extends HTMLElement, B1 extends TypedBuilder> C lookupFlatComponent() {
        return lookupFlatComponent(false);
    }

    protected , E1 extends HTMLElement, B1 extends TypedBuilder> C lookupFlatComponent(
            boolean lenient) {
        return ComponentStore.lookupFlatComponent(componentType, element, lenient);
    }

    protected , E2 extends HTMLElement, B2 extends TypedBuilder> S lookupSubComponent(
            String name) {
        return lookupSubComponent(name, false);
    }

    protected , E2 extends HTMLElement, B2 extends TypedBuilder> S lookupSubComponent(
            String name, boolean lenient) {
        return ComponentStore.lookupSubComponent(componentType, name, element, lenient);
    }
}