Class DescriptionListGroup

java.lang.Object

org.patternfly.component.SubComponent<elemental2.dom.HTMLDivElement, DescriptionListGroup>

org.patternfly.component.list.DescriptionListGroup

All Implemented Interfaces:

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

public class DescriptionListGroup
extends SubComponent<elemental2.dom.HTMLDivElement, DescriptionListGroup>
implements ComponentContext<elemental2.dom.HTMLDivElement, DescriptionListGroup>, HasIdentifier<elemental2.dom.HTMLDivElement, DescriptionListGroup>

A description list group within a DescriptionList 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
DescriptionListGroup	addDescription(DescriptionListDescription description)
DescriptionListGroup	addTerm(DescriptionListTerm term)
static DescriptionListGroup	descriptionListGroup()
static DescriptionListGroup	descriptionListGroup(String identifier)
<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> DescriptionListGroup	store(String key, T value)	Stores a value associated with a key.
DescriptionListGroup	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 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

descriptionListGroup

public static DescriptionListGroup descriptionListGroup()

descriptionListGroup

public static DescriptionListGroup descriptionListGroup(String identifier)

addTerm

public DescriptionListGroup addTerm(DescriptionListTerm term)

addDescription

public DescriptionListGroup addDescription(DescriptionListDescription description)

store

public <T> DescriptionListGroup 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.HTMLDivElement, DescriptionListGroup>

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

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLDivElement, DescriptionListGroup>

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLDivElement, DescriptionListGroup>

Returns:

the identifier of the component

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.HTMLDivElement, DescriptionListGroup>

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.HTMLDivElement, DescriptionListGroup>

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