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>, HasItems<HTMLElement, List, ListItem>, 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 org.patternfly.component.Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
List	add(ListItem item)
List	addDivider()
void	clear()
Comparator<ListItem>	comparator()	Retrieves the comparator used for ordering elements in a component.
boolean	contains(String identifier)
boolean	isEmpty()
ListItem	item(String identifier)
Iterator<ListItem>	iterator()
List	largeIcons()
static List	list()	Creates an unordered list component.
static <E extends HTMLElement> List	list(HTMLContainerBuilder<E> builder)
List	onAdd(BiConsumer<List,ListItem> onAdd)
List	onRemove(BiConsumer<List,ListItem> onRemove)
List	ordered(Comparator<ListItem> comparator)	Orders the elements contained in the component using the specified comparator.
void	removeItem(String identifier)
int	size()
List	that()

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.patternfly.component.HasItems

addItem, addItems, items

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

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.patternfly.style.Modifiers.Bordered

bordered, bordered

Methods inherited from interface org.patternfly.style.Modifiers.Inline

inline, inline

Methods inherited from interface org.patternfly.style.Modifiers.Plain

plain, plain

Methods inherited from interface org.patternfly.component.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)

Specified by:

add in interface HasItems<HTMLElement, List, ListItem>

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(BiConsumer<List,ListItem> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement, List, ListItem>

onRemove

public List onRemove(BiConsumer<List,ListItem> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement, List, ListItem>

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

Specified by:

size in interface HasItems<HTMLElement, List, ListItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement, List, ListItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement, List, ListItem>

item

public ListItem item(String identifier)

Specified by:

item in interface HasItems<HTMLElement, List, ListItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement, List, ListItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement, List, ListItem>