Class TextInput

java.lang.Object

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

org.patternfly.component.form.FormControl<HTMLElement, TextInput>

org.patternfly.component.form.TextInput

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement, TextInput>, ElementClassListMethods<HTMLElement, TextInput>, ElementConsumerMethods<HTMLElement, TextInput>, ElementContainerMethods<HTMLElement, TextInput>, ElementEventMethods<HTMLElement, TextInput>, ElementIdMethods<HTMLElement, TextInput>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, TextInput>, HTMLElementDataMethods<HTMLElement, TextInput>, HTMLElementStyleMethods<HTMLElement, TextInput>, HTMLElementVisibilityMethods<HTMLElement, TextInput>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, TextInput>, Component, ComponentIcon<HTMLElement, TextInput>, HasValue<String>, Validatable<HTMLElement, TextInput>, org.patternfly.core.OuiaSupport<HTMLElement, TextInput>, org.patternfly.style.Modifiers.Disabled<HTMLElement, TextInput>, org.patternfly.style.Modifiers.Plain<HTMLElement, TextInput>, org.patternfly.style.Modifiers.Readonly<HTMLElement, TextInput>, org.patternfly.style.Modifiers.Required<HTMLElement, TextInput>

public class TextInput
extends FormControl<HTMLElement, TextInput>
implements ComponentIcon<HTMLElement, TextInput>, HasValue<String>, org.patternfly.style.Modifiers.Plain<HTMLElement, TextInput>, org.patternfly.style.Modifiers.Readonly<HTMLElement, TextInput>

A text input is used to gather free-form text from a user.

See Also:

• https://www.patternfly.org/components/forms/text-input

Method Summary

Modifier and Type	Method	Description
TextInput	applyTo(Consumer<HTMLInputElementBuilder<HTMLInputElement>> input)	Provides access to the underlying input element using a fluent API style
TextInput	expanded()	Same as expanded(true)
TextInput	expanded(boolean expanded)	Adds/removes modifier(expanded)
TextInput	icon(Element icon)
HTMLInputElementBuilder<HTMLInputElement>	input()	Returns the underlying input element
TextInput	onChange(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)	Defines a change handler that listens for EventType.change events.
TextInput	onInput(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)	Defines a change handler that listens for EventType.input events.
TextInput	onKeydown(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)	Defines a change handler that listens for EventType.keydown events.
TextInput	onKeyup(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)	Defines a change handler that listens for EventType.keyup events.
TextInput	placeholder(String placeholder)
TextInput	plain(boolean plain)
TextInput	readonly(boolean readonly)
TextInput	removeIcon()
TextInput	required(boolean required)
static TextInput	textInput(String id)
static TextInput	textInput(String id, String value)
static TextInput	textInput(TextInputType type, String id)
static TextInput	textInput(TextInputType type, String id, String value)
TextInput	that()
String	value()
TextInput	value(String value)	Same as value(value, false)
TextInput	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 ComponentIcon

icon

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 org.patternfly.style.Modifiers.Disabled

disabled, isDisabled

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

plain

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

readonly

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

required

Methods inherited from interface org.patternfly.core.OuiaSupport

initOuia, initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

textInput

public static TextInput textInput(String id)

textInput

public static TextInput textInput(String id,
 String value)

textInput

public static TextInput textInput(TextInputType type,
 String id)

textInput

public static TextInput textInput(TextInputType type,
 String id,
 String value)

applyTo

public TextInput applyTo(Consumer<HTMLInputElementBuilder<HTMLInputElement>> input)

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

expanded

public TextInput expanded()

Same as expanded(true)

expanded

public TextInput expanded(boolean expanded)

Adds/removes modifier(expanded)

icon

public TextInput icon(Element icon)

Specified by:

icon in interface ComponentIcon<HTMLElement, TextInput>

placeholder

public TextInput placeholder(String placeholder)

plain

public TextInput plain(boolean plain)

Specified by:

plain in interface org.patternfly.style.Modifiers.Plain<HTMLElement, TextInput>

readonly

public TextInput readonly(boolean readonly)

Specified by:

readonly in interface org.patternfly.style.Modifiers.Readonly<HTMLElement, TextInput>

removeIcon

public TextInput removeIcon()

Specified by:

removeIcon in interface ComponentIcon<HTMLElement, TextInput>

required

public TextInput required(boolean required)

Specified by:

required in interface org.patternfly.style.Modifiers.Required<HTMLElement, TextInput>

value

public TextInput value(String value)

Same as value(value, false)

value

public TextInput value(String value,
 boolean fireEvent)

that

public TextInput that()

Specified by:

that in interface TypedBuilder<HTMLElement, TextInput>

onKeydown

public TextInput onKeydown(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)

Defines a change handler that listens for EventType.keydown events.

onKeyup

public TextInput onKeyup(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)

Defines a change handler that listens for EventType.keyup events.

onInput

public TextInput onInput(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)

Defines a change handler that listens for EventType.input events.

onChange

public TextInput onChange(org.patternfly.handler.ChangeHandler<TextInput, String> changeHandler)

Defines a change handler that listens for EventType.change events.

value

public String value()

Specified by:

value in interface HasValue<String>

input

public HTMLInputElementBuilder<HTMLInputElement> input()

Returns the underlying input element