Class FormGroup

java.lang.Object

org.patternfly.component.SubComponent<HTMLElement, FormGroup>

org.patternfly.component.form.FormGroup

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement, FormGroup>, ElementClassListMethods<HTMLElement, FormGroup>, ElementConsumerMethods<HTMLElement, FormGroup>, ElementContainerMethods<HTMLElement, FormGroup>, ElementEventMethods<HTMLElement, FormGroup>, ElementIdMethods<HTMLElement, FormGroup>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, FormGroup>, HTMLElementDataMethods<HTMLElement, FormGroup>, HTMLElementStyleMethods<HTMLElement, FormGroup>, HTMLElementVisibilityMethods<HTMLElement, FormGroup>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, FormGroup>, HasIdentifier<HTMLElement, FormGroup>, ComponentContext<HTMLElement, FormGroup>

public class FormGroup
extends SubComponent<HTMLElement, FormGroup>
implements HasIdentifier<HTMLElement, FormGroup>, ComponentContext<HTMLElement, FormGroup>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
FormGroup	addControl(FormGroupControl control)
FormGroup	addLabel(FormGroupLabel label)
static FormGroup	formGroup()
static FormGroup	formGroup(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.
FormGroup	required()
FormGroup	required(boolean required)
FormGroup	role(FormGroupRole role)	Sets the role of the form group.
<T> FormGroup	store(String key, T value)	Stores a value associated with a key.
FormGroup	that()

Methods inherited from class SubComponent

element, 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

Field Details

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

formGroup

public static FormGroup formGroup()

formGroup

public static FormGroup formGroup(String identifier)

addLabel

public FormGroup addLabel(FormGroupLabel label)

addControl

public FormGroup addControl(FormGroupControl control)

required

public FormGroup required()

required

public FormGroup required(boolean required)

role

public FormGroup role(FormGroupRole role)

Sets the role of the form group. Pass in FormGroupRole.radiogroup when the form group contains multiple radio inputs, or pass in FormGroupRole.group when the form group contains multiple of any other input type (e.g. checkboxes).

Please note that if you set a role, the internal structure of the FormGroupLabel changes. Without a role the label contains a <label> element. With a role the <label> element is replaced by a <span> element. In this case it is expected that the FormGroupControl contains label elements.

store

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

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<HTMLElement, FormGroup>

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

Specified by:

that in interface TypedBuilder<HTMLElement, FormGroup>

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<HTMLElement, FormGroup>

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

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

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