Class FormSelect

java.lang.Object

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

org.patternfly.component.form.FormControl<elemental2.dom.HTMLElement, FormSelect>

org.patternfly.component.form.FormSelect

All Implemented Interfaces:

Attachable, ElementAttributeMethods<elemental2.dom.HTMLElement, FormSelect>, ElementClassListMethods<elemental2.dom.HTMLElement, FormSelect>, ElementConsumerMethods<elemental2.dom.HTMLElement, FormSelect>, ElementContainerMethods<elemental2.dom.HTMLElement, FormSelect>, ElementEventMethods<elemental2.dom.HTMLElement, FormSelect>, ElementIdMethods<elemental2.dom.HTMLElement, FormSelect>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, FormSelect>, HTMLElementDataMethods<elemental2.dom.HTMLElement, FormSelect>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, FormSelect>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, FormSelect>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, FormSelect>, Component, Validatable<elemental2.dom.HTMLElement, FormSelect>, HasValue<String>, OuiaSupport<elemental2.dom.HTMLElement, FormSelect>, Modifiers.Disabled<elemental2.dom.HTMLElement, FormSelect>, Modifiers.Required<elemental2.dom.HTMLElement, FormSelect>

public class FormSelect
extends FormControl<elemental2.dom.HTMLElement, FormSelect>
implements HasValue<String>, Attachable

A form select embeds browser native select lists into a form.

See Also:

• https://www.patternfly.org/components/forms/form-select

Method Summary

Modifier and Type	Method	Description
FormSelect	add(FormSelectOption option)
FormSelect	add(FormSelectOptionGroup group)
FormSelect	addGroup(FormSelectOptionGroup group)
<T> FormSelect	addGroups(Iterable<T> items, Function<T, FormSelectOptionGroup> display)
FormSelect	addOption(FormSelectOption option)
<T> FormSelect	addOptions(Iterable<T> items, Function<T, FormSelectOption> display)
FormSelect	applyTo(Consumer<HTMLSelectElementBuilder<elemental2.dom.HTMLSelectElement>> select)	Provides access to the underlying select element using a fluent API style
void	attach(elemental2.dom.MutationRecord mutationRecord)
boolean	containsValue(String value)
static FormSelect	formSelect(String id)
static FormSelect	formSelect(String id, String value)
FormSelect	onChange(ChangeHandler<FormSelect, String> changeHandler)	Defines a change handler that is called when the value() of this select changes.
FormSelect	required(boolean required)	Adds/removes modifier(required)
HTMLSelectElementBuilder<elemental2.dom.HTMLSelectElement>	selectElement()	Returns the underlying input element
void	selectFirstValue()
void	selectFirstValue(boolean fireEvent)
FormSelect	that()
String	value()
FormSelect	value(String value)	Same as value(String, false)
FormSelect	value(String value, boolean fireEvent)

Methods inherited from class FormControl

disabled, resetValidation, validated

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 Attachable

detach

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 Modifiers.Disabled

disabled, isDisabled

Methods inherited from interface Modifiers.Required

required

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

formSelect

public static FormSelect formSelect(String id)

formSelect

public static FormSelect formSelect(String id,
 String value)

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

applyTo

public FormSelect applyTo(Consumer<HTMLSelectElementBuilder<elemental2.dom.HTMLSelectElement>> select)

Provides access to the underlying select element using a fluent API style

addGroups

public <T> FormSelect addGroups(Iterable<T> items,
 Function<T, FormSelectOptionGroup> display)

addGroup

public FormSelect addGroup(FormSelectOptionGroup group)

add

public FormSelect add(FormSelectOptionGroup group)

addOptions

public <T> FormSelect addOptions(Iterable<T> items,
 Function<T, FormSelectOption> display)

addOption

public FormSelect addOption(FormSelectOption option)

add

public FormSelect add(FormSelectOption option)

required

public FormSelect required(boolean required)

Description copied from interface: Modifiers.Required

Adds/removes modifier(required)

Specified by:

required in interface Modifiers.Required<elemental2.dom.HTMLElement, FormSelect>

value

public FormSelect value(String value)

Same as value(String, false)

value

public FormSelect value(String value,
 boolean fireEvent)

selectFirstValue

public void selectFirstValue()

selectFirstValue

public void selectFirstValue(boolean fireEvent)

that

public FormSelect that()

Specified by:

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

onChange

public FormSelect onChange(ChangeHandler<FormSelect, String> changeHandler)

Defines a change handler that is called when the value() of this select changes. Changes are detected by adding an event listener for input event to the select element.

value

public String value()

Specified by:

value in interface HasValue<String>

containsValue

public boolean containsValue(String value)

selectElement

public HTMLSelectElementBuilder<elemental2.dom.HTMLSelectElement> selectElement()

Returns the underlying input element