Class DataListItem

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLLIElement, DataListItem>

org.patternfly.component.list.DataListItem

All Implemented Interfaces:

ElementAttributeMethods<elemental2.dom.HTMLLIElement, DataListItem>, ElementClassListMethods<elemental2.dom.HTMLLIElement, DataListItem>, ElementConsumerMethods<elemental2.dom.HTMLLIElement, DataListItem>, ElementContainerMethods<elemental2.dom.HTMLLIElement, DataListItem>, ElementEventMethods<elemental2.dom.HTMLLIElement, DataListItem>, ElementIdMethods<elemental2.dom.HTMLLIElement, DataListItem>, ElementQueryMethods<elemental2.dom.HTMLLIElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLLIElement, DataListItem>, HTMLElementDataMethods<elemental2.dom.HTMLLIElement, DataListItem>, HTMLElementStyleMethods<elemental2.dom.HTMLLIElement, DataListItem>, HTMLElementVisibilityMethods<elemental2.dom.HTMLLIElement, DataListItem>, IsElement<elemental2.dom.HTMLLIElement>, TypedBuilder<elemental2.dom.HTMLLIElement, DataListItem>, Expandable<elemental2.dom.HTMLLIElement, DataListItem>, ComponentContext<elemental2.dom.HTMLLIElement, DataListItem>, HasIdentifier<elemental2.dom.HTMLLIElement, DataListItem>, OuiaSupport<elemental2.dom.HTMLLIElement, DataListItem>

public class DataListItem
extends SubComponent<elemental2.dom.HTMLLIElement, DataListItem>
implements ComponentContext<elemental2.dom.HTMLLIElement, DataListItem>, Expandable<elemental2.dom.HTMLLIElement, DataListItem>, HasIdentifier<elemental2.dom.HTMLLIElement, DataListItem>

A data list item within a DataList component.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_ID
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
DataListItem	add(DataListAction action)
DataListItem	add(DataListCell cell)
DataListItem	add(DataListExpandableContent expandableContent)
DataListItem	addAction(DataListAction action)
DataListItem	addCell(DataListCell cell)
<T> DataListItem	addCells(Iterable<T> items, Function<T, DataListCell> display)
DataListItem	addExpandableContent(DataListExpandableContent expandableContent)
DataListItem	ariaToggleLabel(String label)
void	collapse(boolean fireEvent)
static DataListItem	dataListItem(String identifier)	Creates a new data list item.
void	expand(boolean fireEvent)
DataListItem	expandable()	Make this data list item expandable.
DataListItem	expandable(ToggleHandler<DataListItem> toggleHandler)	Make this data list item expandable and register a ToggleHandler.
<T> T	get(String key)	Retrieves the value associated with the given key from the ComponentContext.
boolean	has(String key)	Determines whether a value is stored with the specified key.
String	identifier()	Retrieves the identifier associated with this component.
<T> DataListItem	store(String key, T value)	Stores a value associated with a key.
DataListItem	that()

Methods inherited from class SubComponent

element, ouiaComponentType, registerSubComponent

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ComponentContext

get, get

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 Expandable

collapse, expand, expanded, toggle, toggle

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 OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Field Details

SUB_COMPONENT_ID

public static final String SUB_COMPONENT_ID

See Also:

• Constant Field Values

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

dataListItem

public static DataListItem dataListItem(String identifier)

Creates a new data list item. The identifier is not used directly as an element ID but used to wire ARIA-related attributes. It is expected that you add a DataListCell with an element ID matching the identifier.

addCells

public <T> DataListItem addCells(Iterable<T> items,
 Function<T, DataListCell> display)

addCell

public DataListItem addCell(DataListCell cell)

add

public DataListItem add(DataListCell cell)

addAction

public DataListItem addAction(DataListAction action)

add

public DataListItem add(DataListAction action)

addExpandableContent

public DataListItem addExpandableContent(DataListExpandableContent expandableContent)

add

public DataListItem add(DataListExpandableContent expandableContent)

expandable

public DataListItem expandable()

Make this data list item expandable. Please make sure to add expandable content using addExpandableContent(DataListExpandableContent).

expandable

public DataListItem expandable(ToggleHandler<DataListItem> toggleHandler)

Make this data list item expandable and register a ToggleHandler. Please make sure to add expandable content using addExpandableContent(DataListExpandableContent).

store

public <T> DataListItem store(String key,
 T value)

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<elemental2.dom.HTMLLIElement, DataListItem>

Type Parameters:

T - the type of the value being stored

Parameters:

key - the key associated with the value

value - the value to be stored

that

public DataListItem that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLLIElement, DataListItem>

ariaToggleLabel

public DataListItem ariaToggleLabel(String label)

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLLIElement, DataListItem>

Returns:

the identifier of the component

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<elemental2.dom.HTMLLIElement, DataListItem>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<elemental2.dom.HTMLLIElement, DataListItem>

has

public boolean has(String key)

Description copied from interface: ComponentContext

Determines whether a value is stored with the specified key.

Specified by:

has in interface ComponentContext<elemental2.dom.HTMLLIElement, DataListItem>

Parameters:

key - the key to check

Returns:

true if a value is stored with the specified key, false otherwise

get

public <T> T get(String key)

Description copied from interface: ComponentContext

Retrieves the value associated with the given key from the ComponentContext.

Specified by:

get in interface ComponentContext<elemental2.dom.HTMLLIElement, DataListItem>

Type Parameters:

T - the type of the value being retrieved

Parameters:

key - the key associated with the value

Returns:

the value associated with the key, or null if no value is found