Class Accordion

java.lang.Object

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

org.patternfly.component.accordion.Accordion

All Implemented Interfaces:

Iterable<AccordionItem>, Attachable, ElementAttributeMethods<HTMLElement, Accordion>, ElementClassListMethods<HTMLElement, Accordion>, ElementConsumerMethods<HTMLElement, Accordion>, ElementContainerMethods<HTMLElement, Accordion>, ElementEventMethods<HTMLElement, Accordion>, ElementIdMethods<HTMLElement, Accordion>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, Accordion>, HTMLElementDataMethods<HTMLElement, Accordion>, HTMLElementStyleMethods<HTMLElement, Accordion>, HTMLElementVisibilityMethods<HTMLElement, Accordion>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, Accordion>, Component, HasItems<HTMLElement, Accordion, AccordionItem>, Modifiers.Bordered<HTMLElement, Accordion>

public class Accordion
extends BaseComponent<HTMLElement, Accordion>
implements Attachable, Modifiers.Bordered<HTMLElement, Accordion>, HasItems<HTMLElement, Accordion, AccordionItem>

An accordion is an interactive container that expands and collapses to hide or reveal nested content. It takes advantage of progressive disclosure to help reduce page scrolling by allowing users to choose whether they want to show or hide more detailed information as needed.

See Also:

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

Method Summary

Modifier and Type	Method	Description
static Accordion	accordion()	Creates a new Accordion instance backed by a <dl/>.
static Accordion	accordion(AccordionType type)
Accordion	add(AccordionItem item)	Adds an item to the component.
void	attach(MutationRecord mutationRecord)
void	clear()	Clears all items from the component.
void	collapse(String identifier)
void	collapse(String identifier, boolean fireEvent)
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
void	expand(String identifier)
void	expand(String identifier, boolean fireEvent)
Accordion	fixed()	Same as fixed(true)
Accordion	fixed(boolean fixed)	Flag to indicate Accordion content is fixed
Accordion	headingLevel(int headingLevel)
Accordion	iconPosition(IconPosition iconPosition)
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
AccordionItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<AccordionItem>	iterator()
Accordion	large()	Same as large(true)
Accordion	large(boolean large)	Adds/removes modifier(large, lg)
Accordion	onAdd(AddItemHandler<Accordion, AccordionItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
Accordion	onRemove(RemoveItemHandler<Accordion, AccordionItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
Accordion	onToggle(ToggleHandler<AccordionItem> toggleHandler)
Accordion	onUpdate(UpdateItemHandler<Accordion, AccordionItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
void	removeItem(String identifier)	Removes an item from the component based on the provided identifier.
Accordion	singleExpand()	Same as singleExpand(true)
Accordion	singleExpand(boolean singleExpand)	Whether only one AccordionItem can be expanded
int	size()	Retrieves the total number of items currently contained in the component.
Accordion	that()
void	updateItem(AccordionItem item)	Updates an existing item in the component.

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 HasItems

addItem, addItems, items, replaceItemElement, updateItem, updateItem

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Modifiers.Bordered

bordered, bordered

Method Details

accordion

public static Accordion accordion()

Creates a new Accordion instance backed by a <dl/>.

accordion

public static Accordion accordion(AccordionType type)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

add

public Accordion add(AccordionItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

fixed

public Accordion fixed()

Same as fixed(true)

fixed

public Accordion fixed(boolean fixed)

Flag to indicate Accordion content is fixed

large

public Accordion large()

Same as large(true)

large

public Accordion large(boolean large)

Adds/removes modifier(large, lg)

singleExpand

public Accordion singleExpand()

Same as singleExpand(true)

singleExpand

public Accordion singleExpand(boolean singleExpand)

Whether only one AccordionItem can be expanded

headingLevel

public Accordion headingLevel(int headingLevel)

iconPosition

public Accordion iconPosition(IconPosition iconPosition)

that

public Accordion that()

Specified by:

that in interface TypedBuilder<HTMLElement, Accordion>

onAdd

public Accordion onAdd(AddItemHandler<Accordion, AccordionItem> onAdd)

Description copied from interface: HasItems

Registers a callback to be invoked whenever a new item is added to the component.

Specified by:

onAdd in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

onAdd - a AddItemHandler that takes the builder instance and the item being added as arguments

Returns:

the builder instance after adding the callback

onUpdate

public Accordion onUpdate(UpdateItemHandler<Accordion, AccordionItem> onUpdate)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is updated in the component.

Specified by:

onUpdate in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

onUpdate - a UpdateItemHandler that takes the component, the previous state of the item, and the updated state of the item as arguments

Returns:

the builder instance after adding the callback

onRemove

public Accordion onRemove(RemoveItemHandler<Accordion, AccordionItem> onRemove)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is removed from the component.

Specified by:

onRemove in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

onRemove - a RemoveItemHandler that takes the component and the item being removed as arguments

Returns:

the builder instance after adding the callback

onToggle

public Accordion onToggle(ToggleHandler<AccordionItem> toggleHandler)

collapse

public void collapse(String identifier)

collapse

public void collapse(String identifier,
 boolean fireEvent)

expand

public void expand(String identifier)

expand

public void expand(String identifier,
 boolean fireEvent)

iterator

public Iterator<AccordionItem> iterator()

Specified by:

iterator in interface Iterable<AccordionItem>

size

public int size()

Description copied from interface: HasItems

Retrieves the total number of items currently contained in the component.

Specified by:

size in interface HasItems<HTMLElement, Accordion, AccordionItem>

Returns:

the number of items contained in the component

isEmpty

public boolean isEmpty()

Description copied from interface: HasItems

Checks whether the collection of items in the component is empty.

Specified by:

isEmpty in interface HasItems<HTMLElement, Accordion, AccordionItem>

Returns:

true if the component contains no items; false otherwise

contains

public boolean contains(String identifier)

Description copied from interface: HasItems

Checks whether the component contains an item associated with the given identifier.

Specified by:

contains in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

identifier - the identifier of the item to be checked

Returns:

true if the component contains an item associated with the provided identifier, false otherwise

item

public AccordionItem item(String identifier)

Description copied from interface: HasItems

Retrieves the item associated with the specified identifier from the component.

Specified by:

item in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

identifier - the identifier of the item to be retrieved

Returns:

the item associated with the given identifier, or null if no item is found

updateItem

public void updateItem(AccordionItem item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

item - the item to be updated

removeItem

public void removeItem(String identifier)

Description copied from interface: HasItems

Removes an item from the component based on the provided identifier.

Specified by:

removeItem in interface HasItems<HTMLElement, Accordion, AccordionItem>

Parameters:

identifier - the identifier of the item to be removed

clear

public void clear()

Description copied from interface: HasItems

Clears all items from the component. This method removes any existing items within the component, leaving it empty. Any associated or registered callbacks related to the removal of items may be invoked as part of this operation.

Specified by:

clear in interface HasItems<HTMLElement, Accordion, AccordionItem>