Class PageGroup

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLDivElement, PageGroup>

org.patternfly.component.page.PageGroup

All Implemented Interfaces:

ElementAttributeMethods<elemental2.dom.HTMLDivElement, PageGroup>, ElementClassListMethods<elemental2.dom.HTMLDivElement, PageGroup>, ElementConsumerMethods<elemental2.dom.HTMLDivElement, PageGroup>, ElementContainerMethods<elemental2.dom.HTMLDivElement, PageGroup>, ElementEventMethods<elemental2.dom.HTMLDivElement, PageGroup>, ElementIdMethods<elemental2.dom.HTMLDivElement, PageGroup>, ElementQueryMethods<elemental2.dom.HTMLDivElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLDivElement, PageGroup>, HTMLElementDataMethods<elemental2.dom.HTMLDivElement, PageGroup>, HTMLElementStyleMethods<elemental2.dom.HTMLDivElement, PageGroup>, HTMLElementVisibilityMethods<elemental2.dom.HTMLDivElement, PageGroup>, IsElement<elemental2.dom.HTMLDivElement>, TypedBuilder<elemental2.dom.HTMLDivElement, PageGroup>, OuiaSupport<elemental2.dom.HTMLDivElement, PageGroup>

public class PageGroup
extends SubComponent<elemental2.dom.HTMLDivElement, PageGroup>

Container to group multiple PageSectionLike containers. Can be used in combination with the sticky(Breakpoints) modifier to make multiple sections sticky.

pageGroup()
        .addSection(pageBreadcrumb())
        .addSection(pageSection());

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_ID
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
<E extends elemental2.dom.HTMLElement, P extends PageSectionLike<E,P>> PageGroup	addSection(PageSectionLike<E,P> pageSection)	Adds a PageSectionLike to this component.
PageGroup	overflowScroll()	Modifies this component to show a scrollbar if it has overflow content.
static PageGroup	pageGroup()	Factory method to create a new instance of this component.
PageGroup	shadowBottom()	Modifies this component to have a bottom shadow.
PageGroup	shadowTop()	Modifies this component to have a top shadow.
PageGroup	sticky(Breakpoints<Sticky> sticky)	Modifies this component to be sticky at the given breakpoints.
PageGroup	sticky(Sticky sticky)	Same as sticky(breakpoints(default_, sticky))
PageGroup	that()

Methods inherited from class SubComponent

element, ouiaComponentType, registerSubComponent

Methods inherited from class Object

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

Methods inherited from interface ElementAttributeMethods

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

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerMethods

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

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Field Details

SUB_COMPONENT_ID

public static final String SUB_COMPONENT_ID

See Also:

• Constant Field Values

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

pageGroup

public static PageGroup pageGroup()

Factory method to create a new instance of this component.

addSection

public <E extends elemental2.dom.HTMLElement, P extends PageSectionLike<E,P>>
PageGroup addSection(PageSectionLike<E,P> pageSection)

Adds a PageSectionLike to this component.

sticky

public PageGroup sticky(Sticky sticky)

Same as sticky(breakpoints(default_, sticky))

sticky

public PageGroup sticky(Breakpoints<Sticky> sticky)

Modifies this component to be sticky at the given breakpoints.

shadowTop

public PageGroup shadowTop()

Modifies this component to have a top shadow.

shadowBottom

public PageGroup shadowBottom()

Modifies this component to have a bottom shadow.

overflowScroll

public PageGroup overflowScroll()

Modifies this component to show a scrollbar if it has overflow content.

that

public PageGroup that()