Package org.patternfly.component.list
Class DescriptionList
java.lang.Object
org.patternfly.component.BaseComponent<HTMLElement,DescriptionList>
org.patternfly.component.list.DescriptionList
- All Implemented Interfaces:
Iterable<DescriptionListGroup>
,Container<HTMLElement,
,DescriptionList> Finder<HTMLElement>
,HasElement<HTMLElement,
,DescriptionList> HasHTMLElement<HTMLElement,
,DescriptionList> IsElement<HTMLElement>
,TypedBuilder<HTMLElement,
,DescriptionList> Component
,HasItems<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>, HasItems<HTMLElement,DescriptionList,DescriptionListGroup>
A description list contains terms and their corresponding descriptions.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionadd
(DescriptionListGroup item) Same as autoColumnWidths(true)autoColumnWidths
(boolean autoColumnWidths) Sets the description list to format automatically.autoFit()
Same as autoFit(true)autoFit
(boolean autoFit) Sets the description list to auto fit.autoFitMin
(String autoFitMin) Same asautoFitMin(breakpoints(default_, autoFitMin))
autoFitMin
(Breakpoints<String> autoFitMin) Sets the minimum column size for the auto-fit layout at various breakpoints.void
clear()
Same ascolumns(breakpoints(default_, columns))
columns
(Breakpoints<Integer> columns) Sets the number of columns on the description list at various breakpoints.static DescriptionList
displaySize
(Size size) Sets the display size of the descriptions in the description list.Same as fillColumns(true)fillColumns
(boolean fillColumns) Sets the default placement of description list groups to fill from top to bottom.fluid()
Same as fluid(true)fluid
(boolean fluid) Sets a horizontal description list to have fluid styling.horizontalTermWidth
(String horizontalTermWidth) Same ashorizontalTermWidth(breakpoints(default_, horizontalTermWidth))
horizontalTermWidth
(Breakpoints<String> horizontalTermWidth) Sets the horizontal description list's term column width at various breakpoints.Same as inlineGrid(true)inlineGrid
(boolean inlineGrid) Modifies the description list display to inline-grid.boolean
isEmpty()
iterator()
orientation
(Breakpoints<Orientation> orientation) Indicates how the menu will align at various breakpoints.orientation
(Orientation orientation) Same asorientation(breakpoints(default_, orientation))
int
size()
that()
Methods inherited from class org.patternfly.component.BaseComponent
componentType, element
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jboss.elemento.Container
add, add, add, addAll, addAll, addAll, addAll, addAll, addAll
Methods inherited from interface org.jboss.elemento.HasElement
add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, innerHtml, on, on, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId
Methods inherited from interface org.jboss.elemento.HasHTMLElement
data, hidden, style, style, style, style, style, style, title
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
-
Method Details
-
descriptionList
-
add
- Specified by:
add
in interfaceHasItems<HTMLElement,
DescriptionList, DescriptionListGroup>
-
autoColumnWidths
Same as autoColumnWidths(true) -
autoColumnWidths
Sets the description list to format automatically. -
autoFit
Same as autoFit(true) -
autoFit
Sets the description list to auto fit. -
autoFitMin
Same asautoFitMin(breakpoints(default_, autoFitMin))
-
autoFitMin
Sets the minimum column size for the auto-fit layout at various breakpoints. -
columns
Same ascolumns(breakpoints(default_, columns))
-
columns
Sets the number of columns on the description list at various breakpoints. -
displaySize
Sets the display size of the descriptions in the description list. -
fillColumns
Same as fillColumns(true) -
fillColumns
Sets the default placement of description list groups to fill from top to bottom. -
fluid
Same as fluid(true) -
fluid
Sets a horizontal description list to have fluid styling. -
horizontalTermWidth
Same ashorizontalTermWidth(breakpoints(default_, horizontalTermWidth))
-
horizontalTermWidth
Sets the horizontal description list's term column width at various breakpoints. -
inlineGrid
Same as inlineGrid(true) -
inlineGrid
Modifies the description list display to inline-grid. -
orientation
Same asorientation(breakpoints(default_, orientation))
-
orientation
Indicates how the menu will align at various breakpoints. -
termWidth
-
that
- Specified by:
that
in interfaceTypedBuilder<HTMLElement,
DescriptionList>
-
iterator
- Specified by:
iterator
in interfaceIterable<DescriptionListGroup>
-
size
public int size()- Specified by:
size
in interfaceHasItems<HTMLElement,
DescriptionList, DescriptionListGroup>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceHasItems<HTMLElement,
DescriptionList, DescriptionListGroup>
-
clear
public void clear()- Specified by:
clear
in interfaceHasItems<HTMLElement,
DescriptionList, DescriptionListGroup>
-