Package org.patternfly.component.page

Class Masthead

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement,Masthead>

org.patternfly.component.page.Masthead

All Implemented Interfaces:

Container<HTMLElement,Masthead>, Finder<HTMLElement>, HasElement<HTMLElement,Masthead>, HasHTMLElement<HTMLElement,Masthead>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Masthead>, Component, Modifiers.Inline<HTMLElement,Masthead>

public class Masthead
extends BaseComponent<HTMLElement,Masthead>
implements Modifiers.Inline<HTMLElement,Masthead>

A masthead contains global properties such as logotype, navigation and settings in an organized fashion, and it is accessible from all parts of the application.

All pages should share a common masthead. Use Page.masthead() to get the masthead.

See Also:

https://www.patternfly.org/components/masthead/html

Method Summary

Modifier and Type	Method	Description
Masthead	addBrand(Brand brand, String homeLink)	Wraps the brand inside an <a/> element, adds the <a/> element to a MastheadMain component and finally adds the MastheadMain to this component.
Masthead	addContent()	Adds a MastheadContent to this component.
Masthead	addMain()	Adds a MastheadMain to this component.
Masthead	addToggle(MastheadToggle toggle)	Adds a MastheadToggle to this component.
Masthead	addToolbar(Toolbar toolbar)	Wraps the toolbar inside a MastheadContent component and adds the MastheadContent to this component.
Masthead	inline(Breakpoint breakpoint)	Modifies this component to have an inline display at the given breakpoint.
Masthead	inset(Size size)	Modifies this component to have a horizontal padding.
Masthead	inset(Size size, Breakpoint breakpoint)	Modifies this component to have a horizontal padding at the given breakpoint.
Masthead	light()	Modifies this component to have a light theme with a background color of --pf-v5-global--BackgroundColor--200.
Masthead	lighter()	Modifies this component to have a light theme with a background color of --pf-v5-global--BackgroundColor--100.
Masthead	noInset()	Modifies this component to have no horizontal padding.
Masthead	noInset(Breakpoint breakpoint)	Modifies this component to have no horizontal padding at the given breakpoint.
static Masthead	pageMasthead()	Factory method to create a new instance of this component.
Masthead	stack()	Modifies this component to have a stacked display.
Masthead	stack(Breakpoint breakpoint)	Modifies this component to have a stacked display at the given breakpoint.
Masthead	that()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.elemento.Container

add, add, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, css, id, id, innerHtml, on, textContent, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.core.Modifiers.Inline

inline, inline

Method Detail

pageMasthead

public static Masthead pageMasthead()

Factory method to create a new instance of this component.

that

public Masthead that()

Specified by:

that in interface TypedBuilder<HTMLElement,Masthead>

addToggle

public Masthead addToggle(MastheadToggle toggle)

Adds a MastheadToggle to this component.

addMain

public Masthead addMain()

Adds a MastheadMain to this component.

addBrand

public Masthead addBrand(Brand brand,
                         String homeLink)

Wraps the brand inside an <a/> element, adds the <a/> element to a MastheadMain component and finally adds the MastheadMain to this component.

Shortcut for

addToolbar

public Masthead addToolbar(Toolbar toolbar)

Wraps the toolbar inside a MastheadContent component and adds the MastheadContent to this component.

Shortcut for

addContent

public Masthead addContent()

Adds a MastheadContent to this component.

noInset

public Masthead noInset()

Modifies this component to have no horizontal padding.

noInset

public Masthead noInset(Breakpoint breakpoint)

Modifies this component to have no horizontal padding at the given breakpoint.

inset

public Masthead inset(Size size)

Modifies this component to have a horizontal padding.

inset

public Masthead inset(Size size,
                      Breakpoint breakpoint)

Modifies this component to have a horizontal padding at the given breakpoint.

light

public Masthead light()

Modifies this component to have a light theme with a background color of --pf-v5-global--BackgroundColor--200.

lighter

public Masthead lighter()

Modifies this component to have a light theme with a background color of --pf-v5-global--BackgroundColor--100.

inline

public Masthead inline(Breakpoint breakpoint)

Modifies this component to have an inline display at the given breakpoint.

stack

public Masthead stack()

Modifies this component to have a stacked display.

stack

public Masthead stack(Breakpoint breakpoint)

Modifies this component to have a stacked display at the given breakpoint.