Class DescriptionList

java.lang.Object

org.patternfly.component.BaseComponent<elemental2.dom.HTMLElement, DescriptionList>

org.patternfly.component.list.DescriptionList

All Implemented Interfaces:

Iterable<DescriptionListGroup>, ElementAttributeMethods<elemental2.dom.HTMLElement, DescriptionList>, ElementClassListMethods<elemental2.dom.HTMLElement, DescriptionList>, ElementConsumerMethods<elemental2.dom.HTMLElement, DescriptionList>, ElementContainerMethods<elemental2.dom.HTMLElement, DescriptionList>, ElementEventMethods<elemental2.dom.HTMLElement, DescriptionList>, ElementIdMethods<elemental2.dom.HTMLElement, DescriptionList>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, DescriptionList>, HTMLElementDataMethods<elemental2.dom.HTMLElement, DescriptionList>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, DescriptionList>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, DescriptionList>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, DescriptionList>, Component, HasItems<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>, Ordered<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>, OuiaSupport<elemental2.dom.HTMLElement, DescriptionList>, Modifiers.Compact<elemental2.dom.HTMLElement, DescriptionList>, Modifiers.Horizontal<elemental2.dom.HTMLElement, DescriptionList>

public class DescriptionList
extends BaseComponent<elemental2.dom.HTMLElement, DescriptionList>
implements Modifiers.Compact<elemental2.dom.HTMLElement, DescriptionList>, Modifiers.Horizontal<elemental2.dom.HTMLElement, DescriptionList>, Ordered<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

A description list contains terms and their corresponding descriptions.

See Also:

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

Field Summary

Fields inherited from interface Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
DescriptionList	add(DescriptionListGroup item)	Adds an item to the component.
DescriptionList	autoColumnWidths()	Same as autoColumnWidths(true)
DescriptionList	autoColumnWidths(boolean autoColumnWidths)	Sets the description list to format automatically.
DescriptionList	autoFit()	Same as autoFit(true)
DescriptionList	autoFit(boolean autoFit)	Sets the description list to auto-fit.
DescriptionList	autoFitMin(String autoFitMin)	Same as autoFitMin(breakpoints(default_, autoFitMin))
DescriptionList	autoFitMin(Breakpoints<String> autoFitMin)	Sets the minimum column size for the auto-fit layout at various breakpoints.
void	clear()	Clears all items from the component.
DescriptionList	columns(Integer columns)	Same as columns(breakpoints(default_, columns))
DescriptionList	columns(Breakpoints<Integer> columns)	Sets the number of columns on the description list at various breakpoints.
Comparator<DescriptionListGroup>	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.
static DescriptionList	descriptionList()
DescriptionList	displaySize(Size size)	Sets the display size of the descriptions in the description list.
DescriptionList	fillColumns()	Same as fillColumns(true)
DescriptionList	fillColumns(boolean fillColumns)	Sets the default placement of description list groups to fill from top to bottom.
DescriptionList	fluid()	Same as fluid(true)
DescriptionList	fluid(boolean fluid)	Sets a horizontal description list to have fluid styling.
DescriptionList	horizontalTermWidth(String horizontalTermWidth)	Same as horizontalTermWidth(breakpoints(default_, horizontalTermWidth))
DescriptionList	horizontalTermWidth(Breakpoints<String> horizontalTermWidth)	Sets the horizontal description list's term column width at various breakpoints.
DescriptionList	inlineGrid()	Same as inlineGrid(true)
DescriptionList	inlineGrid(boolean inlineGrid)	Modifies the description list display to inline-grid.
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
DescriptionListGroup	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<DescriptionListGroup>	iterator()
DescriptionList	onAdd(AddItemHandler<DescriptionList, DescriptionListGroup> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
DescriptionList	onRemove(RemoveItemHandler<DescriptionList, DescriptionListGroup> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
DescriptionList	onUpdate(UpdateItemHandler<DescriptionList, DescriptionListGroup> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
DescriptionList	ordered(Comparator<DescriptionListGroup> comparator)	Orders the elements contained in the component using the specified comparator.
DescriptionList	orientation(Breakpoints<Orientation> orientation)	Indicates how the menu will align at various breakpoints.
DescriptionList	orientation(Orientation orientation)	Same as orientation(breakpoints(default_, orientation))
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.
DescriptionList	termWidth(String width)
DescriptionList	that()
void	updateItem(DescriptionListGroup item)	Updates an existing item in the component.

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, 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.Compact

compact, compact

Methods inherited from interface Modifiers.Horizontal

horizontal, horizontal

Methods inherited from interface Ordered

addOrdered, defaultOrder, ordered

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

descriptionList

public static DescriptionList descriptionList()

add

public DescriptionList add(DescriptionListGroup item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

autoColumnWidths

public DescriptionList autoColumnWidths()

Same as autoColumnWidths(true)

autoColumnWidths

public DescriptionList autoColumnWidths(boolean autoColumnWidths)

Sets the description list to format automatically.

autoFit

public DescriptionList autoFit()

Same as autoFit(true)

autoFit

public DescriptionList autoFit(boolean autoFit)

Sets the description list to auto-fit.

autoFitMin

public DescriptionList autoFitMin(String autoFitMin)

Same as autoFitMin(breakpoints(default_, autoFitMin))

autoFitMin

public DescriptionList autoFitMin(Breakpoints<String> autoFitMin)

Sets the minimum column size for the auto-fit layout at various breakpoints.

columns

public DescriptionList columns(Integer columns)

Same as columns(breakpoints(default_, columns))

columns

public DescriptionList columns(Breakpoints<Integer> columns)

Sets the number of columns on the description list at various breakpoints.

displaySize

public DescriptionList displaySize(Size size)

Sets the display size of the descriptions in the description list.

fillColumns

public DescriptionList fillColumns()

Same as fillColumns(true)

fillColumns

public DescriptionList fillColumns(boolean fillColumns)

Sets the default placement of description list groups to fill from top to bottom.

fluid

public DescriptionList fluid()

Same as fluid(true)

fluid

public DescriptionList fluid(boolean fluid)

Sets a horizontal description list to have fluid styling.

horizontalTermWidth

public DescriptionList horizontalTermWidth(String horizontalTermWidth)

Same as horizontalTermWidth(breakpoints(default_, horizontalTermWidth))

horizontalTermWidth

public DescriptionList horizontalTermWidth(Breakpoints<String> horizontalTermWidth)

Sets the horizontal description list's term column width at various breakpoints.

inlineGrid

public DescriptionList inlineGrid()

Same as inlineGrid(true)

inlineGrid

public DescriptionList inlineGrid(boolean inlineGrid)

Modifies the description list display to inline-grid.

ordered

public DescriptionList ordered(Comparator<DescriptionListGroup> 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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

Parameters:

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

Returns:

the builder instance with the elements ordered

orientation

public DescriptionList orientation(Orientation orientation)

Same as orientation(breakpoints(default_, orientation))

orientation

public DescriptionList orientation(Breakpoints<Orientation> orientation)

Indicates how the menu will align at various breakpoints.

termWidth

public DescriptionList termWidth(String width)

that

public DescriptionList that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLElement, DescriptionList>

onAdd

public DescriptionList onAdd(AddItemHandler<DescriptionList, DescriptionListGroup> 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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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 DescriptionList onUpdate(UpdateItemHandler<DescriptionList, DescriptionListGroup> 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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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 DescriptionList onRemove(RemoveItemHandler<DescriptionList, DescriptionListGroup> 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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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

Description copied from interface: Ordered

Retrieves the comparator used for ordering elements in a component.

Specified by:

comparator in interface Ordered<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

Returns:

the comparator that determines the order of elements

iterator

public Iterator<DescriptionListGroup> iterator()

Specified by:

iterator in interface Iterable<DescriptionListGroup>

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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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 DescriptionListGroup 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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>

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<elemental2.dom.HTMLElement, DescriptionList, DescriptionListGroup>