org.patternfly.component.page.MastheadMain 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.page;

import org.patternfly.component.brand.Brand;

import elemental2.dom.HTMLDivElement;

import static org.jboss.elemento.Elements.div;
import static org.patternfly.style.Classes.component;
import static org.patternfly.style.Classes.main;
import static org.patternfly.style.Classes.masthead;

/**
 * Container for the main area of a {@link Masthead} component. This container represents the smaller area taken up by a logo,
 * and will typically contain a {@link Brand} inside an {@code } element.
 */
public class MastheadMain extends MastheadSubComponent {

    // ------------------------------------------------------ factory

    /**
     * Factory method to create a new instance of this component.
     */
    public static MastheadMain mastheadMain() {
        return new MastheadMain();
    }

    // ------------------------------------------------------ instance

    static final String SUB_COMPONENT_NAME = "mhm";

    MastheadMain() {
        super(SUB_COMPONENT_NAME, div().css(component(masthead, main)).element());
    }

    // ------------------------------------------------------ add

    public MastheadMain addBrand(MastheadBrand brand) {
        return add(brand);
    }

    // ------------------------------------------------------ builder

    @Override
    public MastheadMain that() {
        return this;
    }
}