Class List

java.lang.Object

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

org.patternfly.component.list.List

All Implemented Interfaces:

Iterable<ListItem>, ElementAttributeMethods<HTMLElement, List>, ElementClassListMethods<HTMLElement, List>, ElementConsumerMethods<HTMLElement, List>, ElementContainerMethods<HTMLElement, List>, ElementEventMethods<HTMLElement, List>, ElementIdMethods<HTMLElement, List>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, List>, HTMLElementDataMethods<HTMLElement, List>, HTMLElementStyleMethods<HTMLElement, List>, HTMLElementVisibilityMethods<HTMLElement, List>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, List>, Component, HasItems<HTMLElement, List, ListItem>, Ordered<HTMLElement, List, ListItem>, Modifiers.Bordered<HTMLElement, List>, Modifiers.Inline<HTMLElement, List>, Modifiers.Plain<HTMLElement, List>

public class List
extends BaseComponent<HTMLElement, List>
implements Modifiers.Bordered<HTMLElement, List>, Modifiers.Inline<HTMLElement, List>, Ordered<HTMLElement, List, ListItem>, Modifiers.Plain<HTMLElement, List>

A list component embeds a formatted list (bulleted or numbered list) into page content.

See Also:

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

Field Summary

Fields inherited from interface Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
List	add(ListItem item)	Adds an item to the component.
List	addDivider()
void	clear()	Clears all items from the component.
Comparator<ListItem>	comparator()	Retrieves the comparator used for ordering elements in a component.
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
ListItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<ListItem>	iterator()
List	largeIcons()
static List	list()	Creates an unordered list component.
static <E extends HTMLElement> List	list(HTMLContainerBuilder<E> builder)
List	onAdd(AddItemHandler<List,ListItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
List	onRemove(RemoveItemHandler<List,ListItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
List	onUpdate(UpdateItemHandler<List,ListItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
List	ordered(Comparator<ListItem> comparator)	Orders the elements contained in the component using the specified comparator.
void	removeItem(String identifier)	Removes an item from the component based on the provided identifier.
int	size()	Retrieves the total number of items currently contained in the component.
List	that()
void	updateItem(ListItem 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 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

Methods inherited from interface Modifiers.Inline

inline, inline

Methods inherited from interface Modifiers.Plain

plain, plain

Methods inherited from interface Ordered

addOrdered, defaultOrder, ordered

Method Details

list

public static List list()

Creates an unordered list component.

list

public static <E extends HTMLElement> List list(HTMLContainerBuilder<E> builder)

add

public List add(ListItem item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, List, ListItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

addDivider

public List addDivider()

largeIcons

public List largeIcons()

ordered

public List ordered(Comparator<ListItem> comparator)

Description copied from interface: Ordered

Orders the elements contained in the component using the specified comparator. The comparator determines the order in which the elements are arranged.

Specified by:

ordered in interface Ordered<HTMLElement, List, ListItem>

Parameters:

comparator - the comparator used to define the ordering of the elements

Returns:

the builder instance with the elements ordered

that

public List that()

Specified by:

that in interface TypedBuilder<HTMLElement, List>

onAdd

public List onAdd(AddItemHandler<List,ListItem> 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, List, ListItem>

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 List onUpdate(UpdateItemHandler<List,ListItem> 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, List, ListItem>

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 List onRemove(RemoveItemHandler<List,ListItem> 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, List, ListItem>

Parameters:

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

Returns:

the builder instance after adding the callback

comparator

public Comparator<ListItem> comparator()

Description copied from interface: Ordered

Retrieves the comparator used for ordering elements in a component.

Specified by:

comparator in interface Ordered<HTMLElement, List, ListItem>

Returns:

the comparator that determines the order of elements

iterator

public Iterator<ListItem> iterator()

Specified by:

iterator in interface Iterable<ListItem>

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, List, ListItem>

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, List, ListItem>

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, List, ListItem>

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 ListItem 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, List, ListItem>

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(ListItem item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, List, ListItem>

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, List, ListItem>

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, List, ListItem>