Class ExpandableSection

java.lang.Object

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

org.patternfly.component.expandable.ExpandableSection

All Implemented Interfaces:

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

public class ExpandableSection
extends BaseComponent<HTMLDivElement, ExpandableSection>
implements Attachable, Expandable<HTMLDivElement, ExpandableSection>

An expandable section component is used to support progressive disclosure in a form or page by hiding additional content when you don't want it to be shown by default. An expandable section can contain any type of content such as plain text, form inputs, and charts.

See Also:

• https://www.patternfly.org/components/expandable-section

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_TRUNCATE

Method Summary

Modifier and Type	Method	Description
ExpandableSection	add(ExpandableSectionContent content)
ExpandableSection	add(ExpandableSectionToggle toggle)
ExpandableSection	addContent(ExpandableSectionContent content)
ExpandableSection	addToggle(ExpandableSectionToggle toggle)
void	attach(MutationRecord mutationRecord)
void	collapse(boolean fireEvent)
ExpandableSectionContent	content()
ExpandableSection	detached()	Make this expandable section detached from another one.
ExpandableSection	disclosure()	Same as disclosure(true)
ExpandableSection	disclosure(boolean disclosure)	Adds/removes the disclosure modifiers
void	expand(boolean fireEvent)
static ExpandableSection	expandableSection()
static ExpandableSection	expandableSection(String id)	Creates and returns a new instance of ExpandableSection with the specified ID.
ExpandableSection	indented()	Same as indented(true)
ExpandableSection	indented(boolean indented)	Adds/removes modifier(indented)
ExpandableSection	onToggle(ToggleHandler<ExpandableSection> toggleHandler)
ExpandableSection	that()
ExpandableSection	truncate()	Same as truncate(3)
ExpandableSection	truncate(int truncate)	Adds modifier(truncate)

Methods inherited from class BaseComponent

componentType, element, registerComponent

Methods inherited from class Object

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

Methods inherited from interface Attachable

detach

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 Expandable

collapse, expand, expanded, toggle, toggle

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 IsElement

element

Field Details

DEFAULT_TRUNCATE

public static final int DEFAULT_TRUNCATE

See Also:

• Constant Field Values

Method Details

expandableSection

public static ExpandableSection expandableSection()

expandableSection

public static ExpandableSection expandableSection(String id)

Creates and returns a new instance of ExpandableSection with the specified ID.

If you want to create a detached expandable section, you must use the same ID for the two expandable sections, one containing the ExpandableSectionToggle and one containing the ExpandableSectionContent.

stack().gutter()
        .addItem(stackItem()
                .add(expandableSection("detached-expandable-section")
                        .detached()
                        .addContent(expandableSectionContent()
                                .text("This content is visible only when the component is expanded."))))
        .addItem(stackItem()
                .add(expandableSection("detached-expandable-section")
                        .detached()
                        .addToggle(expandableSectionToggle("Show more", "Show less"))));

Parameters:

id - the unique identifier for the expandable section

Returns:

a new instance of ExpandableSection initialized with the provided ID

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

addToggle

public ExpandableSection addToggle(ExpandableSectionToggle toggle)

add

public ExpandableSection add(ExpandableSectionToggle toggle)

addContent

public ExpandableSection addContent(ExpandableSectionContent content)

add

public ExpandableSection add(ExpandableSectionContent content)

detached

public ExpandableSection detached()

Make this expandable section detached from another one. Must be called on both the expandable section containing the ExpandableSectionToggle and the expandable section containing the ExpandableSectionContent.

stack().gutter()
        .addItem(stackItem()
                .add(expandableSection("detached-expandable-section")
                        .detached()
                        .addContent(expandableSectionContent()
                                .text("This content is visible only when the component is expanded."))))
        .addItem(stackItem()
                .add(expandableSection("detached-expandable-section")
                        .detached()
                        .addToggle(expandableSectionToggle("Show more", "Show less"))));

indented

public ExpandableSection indented()

Same as indented(true)

indented

public ExpandableSection indented(boolean indented)

Adds/removes modifier(indented)

disclosure

public ExpandableSection disclosure()

Same as disclosure(true)

disclosure

public ExpandableSection disclosure(boolean disclosure)

Adds/removes the disclosure modifiers

truncate

public ExpandableSection truncate()

Same as truncate(3)

truncate

public ExpandableSection truncate(int truncate)

Adds modifier(truncate)

that

public ExpandableSection that()

Specified by:

that in interface TypedBuilder<HTMLDivElement, ExpandableSection>

onToggle

public ExpandableSection onToggle(ToggleHandler<ExpandableSection> toggleHandler)

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLDivElement, ExpandableSection>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLDivElement, ExpandableSection>

content

public ExpandableSectionContent content()