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

public class Masthead
extends BaseComponent<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(MastheadContent content)	Adds a MastheadContent to this component.
Masthead	addMain(MastheadMain main)
Masthead	addToggle(MastheadToggle toggle)
Masthead	addToolbar(Toolbar toolbar)	Wraps the toolbar inside a MastheadContent component and adds the MastheadContent to this component.
Masthead	background(Brightness brightness)	Background theme color of the masthead
Masthead	display(Tuples<Breakpoint,Display> displayModifiers)	Display type at various breakpoints.
Masthead	inset(Tuples<Breakpoint,Inset> insetModifiers)	Insets at various breakpoints
static Masthead	masthead()	Factory method to create a new instance of this component.
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, classList, classList, css, id, id, innerHtml, on, textContent, textNode, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

Method Detail

masthead

public static Masthead masthead()

Factory method to create a new instance of this component.

addToggle

public Masthead addToggle(MastheadToggle toggle)

addMain

public Masthead addMain(MastheadMain main)

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(MastheadContent content)

Adds a MastheadContent to this component.

display

public Masthead display(Tuples<Breakpoint,Display> displayModifiers)

Display type at various breakpoints. Defaults to tuples(md, inline).

inset

public Masthead inset(Tuples<Breakpoint,Inset> insetModifiers)

Insets at various breakpoints

background

public Masthead background(Brightness brightness)

Background theme color of the masthead

that

public Masthead that()