Class SimpleList

java.lang.Object

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

org.patternfly.component.list.SimpleList

All Implemented Interfaces:

Iterable<SimpleListItem>, ElementAttributeMethods<HTMLElement, SimpleList>, ElementClassListMethods<HTMLElement, SimpleList>, ElementConsumerMethods<HTMLElement, SimpleList>, ElementContainerMethods<HTMLElement, SimpleList>, ElementEventMethods<HTMLElement, SimpleList>, ElementIdMethods<HTMLElement, SimpleList>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, SimpleList>, HTMLElementDataMethods<HTMLElement, SimpleList>, HTMLElementStyleMethods<HTMLElement, SimpleList>, HTMLElementVisibilityMethods<HTMLElement, SimpleList>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, SimpleList>, Component, HasItems<HTMLElement, SimpleList, SimpleListItem>, Ordered<HTMLElement, SimpleList, SimpleListItem>

public class SimpleList
extends BaseComponent<HTMLElement, SimpleList>
implements Ordered<HTMLElement, SimpleList, SimpleListItem>

A simple list provides a list of selectable items that can be shown within a page. Each item is described by a text label. The list may be divided into logical sections by introducing group headers.

See Also:

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

Field Summary

Fields inherited from interface org.patternfly.component.Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
SimpleList	add(SimpleListGroup group)
SimpleList	add(SimpleListItem item)
SimpleList	addGroup(SimpleListGroup group)
SimpleList	ariaLabel(String label)
void	clear()
Comparator<SimpleListItem>	comparator()	Retrieves the comparator used for ordering elements in a component.
boolean	contains(String identifier)
boolean	isEmpty()
SimpleListItem	item(String identifier)
Iterator<SimpleListItem>	iterator()
SimpleList	onAdd(BiConsumer<SimpleList, SimpleListItem> onAdd)
SimpleList	onRemove(BiConsumer<SimpleList, SimpleListItem> onRemove)
SimpleList	onSelect(SelectHandler<SimpleListItem> selectHandler)
SimpleList	ordered(Comparator<SimpleListItem> comparator)	Orders the elements contained in the component using the specified comparator.
void	removeItem(String identifier)
void	select(String identifier)
void	select(String identifier, boolean selected)
void	select(String identifier, boolean selected, boolean fireEvent)
void	select(SimpleListItem item)
void	select(SimpleListItem item, boolean selected)
void	select(SimpleListItem item, boolean selected, boolean fireEvent)
static SimpleList	simpleList()
int	size()
SimpleList	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.component.Ordered

addOrdered, defaultOrder, ordered

Method Details

simpleList

public static SimpleList simpleList()

addGroup

public SimpleList addGroup(SimpleListGroup group)

add

public SimpleList add(SimpleListGroup group)

add

public SimpleList add(SimpleListItem item)

Specified by:

add in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

ordered

public SimpleList ordered(Comparator<SimpleListItem> 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, SimpleList, SimpleListItem>

Parameters:

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

Returns:

the builder instance with the elements ordered

that

public SimpleList that()

Specified by:

that in interface TypedBuilder<HTMLElement, SimpleList>

ariaLabel

public SimpleList ariaLabel(String label)

onAdd

public SimpleList onAdd(BiConsumer<SimpleList, SimpleListItem> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

onRemove

public SimpleList onRemove(BiConsumer<SimpleList, SimpleListItem> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

onSelect

public SimpleList onSelect(SelectHandler<SimpleListItem> selectHandler)

comparator

public Comparator<SimpleListItem> comparator()

Description copied from interface: Ordered

Retrieves the comparator used for ordering elements in a component.

Specified by:

comparator in interface Ordered<HTMLElement, SimpleList, SimpleListItem>

Returns:

the comparator that determines the order of elements

select

public void select(String identifier)

select

public void select(String identifier,
 boolean selected)

select

public void select(String identifier,
 boolean selected,
 boolean fireEvent)

select

public void select(SimpleListItem item)

select

public void select(SimpleListItem item,
 boolean selected)

select

public void select(SimpleListItem item,
 boolean selected,
 boolean fireEvent)

iterator

public Iterator<SimpleListItem> iterator()

Specified by:

iterator in interface Iterable<SimpleListItem>

size

public int size()

Specified by:

size in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

item

public SimpleListItem item(String identifier)

Specified by:

item in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement, SimpleList, SimpleListItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement, SimpleList, SimpleListItem>