Class DescriptionList

java.lang.Object

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

org.patternfly.component.list.DescriptionList

All Implemented Interfaces:

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

public class DescriptionList
extends BaseComponent<HTMLElement, DescriptionList>
implements Modifiers.Compact<HTMLElement, DescriptionList>, Modifiers.Horizontal<HTMLElement, DescriptionList>, Ordered<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 org.patternfly.component.Ordered

DATA_ORDER

Method Summary

Modifier and Type	Method	Description
DescriptionList	add(DescriptionListGroup item)
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()
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)
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()
DescriptionListGroup	item(String identifier)
Iterator<DescriptionListGroup>	iterator()
DescriptionList	onAdd(BiConsumer<DescriptionList, DescriptionListGroup> onAdd)
DescriptionList	onRemove(BiConsumer<DescriptionList, DescriptionListGroup> onRemove)
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)
int	size()
DescriptionList	termWidth(String width)
DescriptionList	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.Compact

compact, compact

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

horizontal, horizontal

Methods inherited from interface org.patternfly.component.Ordered

addOrdered, defaultOrder, ordered

Method Details

descriptionList

public static DescriptionList descriptionList()

add

public DescriptionList add(DescriptionListGroup item)

Specified by:

add in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

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<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<HTMLElement, DescriptionList>

onAdd

public DescriptionList onAdd(BiConsumer<DescriptionList, DescriptionListGroup> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

onRemove

public DescriptionList onRemove(BiConsumer<DescriptionList, DescriptionListGroup> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

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

Specified by:

size in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

item

public DescriptionListGroup item(String identifier)

Specified by:

item in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement, DescriptionList, DescriptionListGroup>