Class DataList

java.lang.Object

org.patternfly.component.BaseComponent<HTMLUListElement, DataList>

org.patternfly.component.list.DataList

All Implemented Interfaces:

Iterable<DataListItem>, ElementAttributeMethods<HTMLUListElement, DataList>, ElementClassListMethods<HTMLUListElement, DataList>, ElementConsumerMethods<HTMLUListElement, DataList>, ElementContainerMethods<HTMLUListElement, DataList>, ElementEventMethods<HTMLUListElement, DataList>, ElementIdMethods<HTMLUListElement, DataList>, ElementQueryMethods<HTMLUListElement>, HTMLElementAttributeMethods<HTMLUListElement, DataList>, HTMLElementDataMethods<HTMLUListElement, DataList>, HTMLElementStyleMethods<HTMLUListElement, DataList>, HTMLElementVisibilityMethods<HTMLUListElement, DataList>, IsElement<HTMLUListElement>, TypedBuilder<HTMLUListElement, DataList>, Component, HasItems<HTMLUListElement, DataList, DataListItem>, Ordered<HTMLUListElement, DataList, DataListItem>, Modifiers.Compact<HTMLUListElement, DataList>

public class DataList
extends BaseComponent<HTMLUListElement, DataList>
implements Modifiers.Compact<HTMLUListElement, DataList>, Ordered<HTMLUListElement, DataList, DataListItem>

A data list is used to display large data sets when you need a flexible layout or need to include interactive content like charts.

See Also:

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

Field Summary

Fields inherited from interface org.patternfly.component.Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
DataList	add(DataListItem item)
void	clear()
Comparator<DataListItem>	comparator()	Retrieves the comparator used for ordering elements in a component.
boolean	contains(String identifier)
static DataList	dataList()
DataList	gridBreakpoint(GridBreakpoint breakpoint)	Specifies the grid breakpoints
boolean	isEmpty()
DataListItem	item(String identifier)
Iterator<DataListItem>	iterator()
DataList	onAdd(BiConsumer<DataList, DataListItem> onAdd)
DataList	onRemove(BiConsumer<DataList, DataListItem> onRemove)
DataList	ordered(Comparator<DataListItem> comparator)	Orders the elements contained in the component using the specified comparator.
void	removeItem(String identifier)
int	size()
DataList	that()
DataList	wrap(Wrap wrap)	Determines which wrapping modifier to apply to the data list

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.Compact

compact, compact

Methods inherited from interface org.patternfly.component.Ordered

addOrdered, defaultOrder, ordered

Method Details

dataList

public static DataList dataList()

add

public DataList add(DataListItem item)

Specified by:

add in interface HasItems<HTMLUListElement, DataList, DataListItem>

gridBreakpoint

public DataList gridBreakpoint(GridBreakpoint breakpoint)

Specifies the grid breakpoints

ordered

public DataList ordered(Comparator<DataListItem> 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<HTMLUListElement, DataList, DataListItem>

Parameters:

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

Returns:

the builder instance with the elements ordered

wrap

public DataList wrap(Wrap wrap)

Determines which wrapping modifier to apply to the data list

that

public DataList that()

Specified by:

that in interface TypedBuilder<HTMLUListElement, DataList>

onAdd

public DataList onAdd(BiConsumer<DataList, DataListItem> onAdd)

Specified by:

onAdd in interface HasItems<HTMLUListElement, DataList, DataListItem>

onRemove

public DataList onRemove(BiConsumer<DataList, DataListItem> onRemove)

Specified by:

onRemove in interface HasItems<HTMLUListElement, DataList, DataListItem>

comparator

public Comparator<DataListItem> comparator()

Description copied from interface: Ordered

Retrieves the comparator used for ordering elements in a component.

Specified by:

comparator in interface Ordered<HTMLUListElement, DataList, DataListItem>

Returns:

the comparator that determines the order of elements

iterator

public Iterator<DataListItem> iterator()

Specified by:

iterator in interface Iterable<DataListItem>

size

public int size()

Specified by:

size in interface HasItems<HTMLUListElement, DataList, DataListItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLUListElement, DataList, DataListItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLUListElement, DataList, DataListItem>

item

public DataListItem item(String identifier)

Specified by:

item in interface HasItems<HTMLUListElement, DataList, DataListItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLUListElement, DataList, DataListItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLUListElement, DataList, DataListItem>