Package org.patternfly.component.page

Class Page

java.lang.Object

org.patternfly.component.BaseComponent<HTMLDivElement,Page>

org.patternfly.component.page.Page

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLDivElement,Page>, ElementClassListMethods<HTMLDivElement,Page>, ElementConsumerMethods<HTMLDivElement,Page>, ElementContainerMethods<HTMLDivElement,Page>, ElementEventMethods<HTMLDivElement,Page>, ElementIdMethods<HTMLDivElement,Page>, ElementQueryMethods<HTMLDivElement>, HTMLElementAttributeMethods<HTMLDivElement,Page>, HTMLElementDataMethods<HTMLDivElement,Page>, HTMLElementStyleMethods<HTMLDivElement,Page>, HTMLElementVisibilityMethods<HTMLDivElement,Page>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement,Page>, Component

public class Page
extends BaseComponent<HTMLDivElement,Page>
implements Attachable

The page component is used to define the basic layout of a page with either vertical or horizontal navigation.

page()
        .addSkipToContent(skipToContent("main-id"))
        .addMasthead(masthead())
        .addSidebar(pageSidebar())
        .addMain(pageMain("main-id"));

See Also:

• https://www.patternfly.org/components/page

Method Summary

Modifier and Type	Method	Description
Page	add(NotificationDrawer notificationDrawer)
Page	add(Masthead masthead)	Adds the Masthead component and removes the previous one (if any).
Page	add(PageMain main)	Adds the PageMain component and removes the previous one (if any).
Page	add(PageSidebar sidebar)	Adds the PageSidebar component and removes the previous one (if any).
Page	add(SkipToContent skipToContent)	Adds the SkipToContent component as the first element and removes the previous one (if any).
Page	addMain(PageMain main)	Adds the PageMain component and removes the previous one (if any).
Page	addMasthead(Masthead masthead)	Adds the Masthead component and removes the previous one (if any).
Page	addNotificationDrawer(NotificationDrawer notificationDrawer)
Page	addSidebar(PageSidebar sidebar)	Adds the PageSidebar component and removes the previous one (if any).
Page	addSkipToContent(SkipToContent skipToContent)	Adds the SkipToContent component as the first element and removes the previous one (if any).
void	attach(MutationRecord mutationRecord)
Page	breakpoint(Function<Integer,Breakpoint> breakpointFn)	The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class.
void	detach(MutationRecord mutationRecord)
Drawer	drawer()	Returns the Drawer that contains the current NotificationDrawer or null if no notification drawer has been defined yet.
PageMain	main()	Returns the current PageMain or null if no main has been defined yet.
Masthead	masthead()	Returns the current Masthead or null if no masthead has been defined yet.
Page	noSidebar()
NotificationDrawer	notificationDrawer()	Returns the current NotificationDrawer or null if no notification drawer has been defined yet.
Page	onResize(ResizeHandler<Page> resizeHandler)
static Page	page()	Create or returns the page singleton.
static Page	page(boolean newInstance)
PageSidebar	sidebar()	Returns the current PageSidebar or null if no sidebar has been defined yet.
Page	that()
Page	verticalBreakpoint(Function<Integer,Breakpoint> verticalBreakpointFn)	The page resize observer uses the breakpoints returned from this function when adding the pf-m-height-breakpoint-[default|sm|md|lg|xl|2xl] class.
void	wire(NotificationBadge notificationBadge, NotificationDrawer notificationDrawer)

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element, registerComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

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

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Method Details

page

public static Page page()

Create or returns the page singleton.

page

public static Page page(boolean newInstance)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addSkipToContent

public Page addSkipToContent(SkipToContent skipToContent)

Adds the SkipToContent component as the first element and removes the previous one (if any).

add

public Page add(SkipToContent skipToContent)

Adds the SkipToContent component as the first element and removes the previous one (if any).

addMasthead

public Page addMasthead(Masthead masthead)

Adds the Masthead component and removes the previous one (if any).

add

public Page add(Masthead masthead)

Adds the Masthead component and removes the previous one (if any).

addSidebar

public Page addSidebar(PageSidebar sidebar)

Adds the PageSidebar component and removes the previous one (if any).

add

public Page add(PageSidebar sidebar)

Adds the PageSidebar component and removes the previous one (if any).

addMain

public Page addMain(PageMain main)

Adds the PageMain component and removes the previous one (if any).

add

public Page add(PageMain main)

Adds the PageMain component and removes the previous one (if any).

addNotificationDrawer

public Page addNotificationDrawer(NotificationDrawer notificationDrawer)

add

public Page add(NotificationDrawer notificationDrawer)

breakpoint

public Page breakpoint(Function<Integer,Breakpoint> breakpointFn)

The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class. You can override the default function Breakpoint.breakpoint(int) to return breakpoints at different sizes than the default.

noSidebar

public Page noSidebar()

verticalBreakpoint

public Page verticalBreakpoint(Function<Integer,Breakpoint> verticalBreakpointFn)

The page resize observer uses the breakpoints returned from this function when adding the pf-m-height-breakpoint-[default|sm|md|lg|xl|2xl] class. You can override the default function Breakpoint.verticalBreakpoint(int) to return breakpoints at different sizes than the default.

that

public Page that()

Specified by:

that in interface TypedBuilder<HTMLDivElement,Page>

onResize

public Page onResize(ResizeHandler<Page> resizeHandler)

wire

public void wire(NotificationBadge notificationBadge,
 NotificationDrawer notificationDrawer)

masthead

public Masthead masthead()

Returns the current Masthead or null if no masthead has been defined yet.

sidebar

public PageSidebar sidebar()

Returns the current PageSidebar or null if no sidebar has been defined yet.

main

public PageMain main()

Returns the current PageMain or null if no main has been defined yet.

drawer

public Drawer drawer()

Returns the Drawer that contains the current NotificationDrawer or null if no notification drawer has been defined yet.

notificationDrawer

public NotificationDrawer notificationDrawer()

Returns the current NotificationDrawer or null if no notification drawer has been defined yet.