Package org.patternfly.component.form

Class TextArea

java.lang.Object

org.patternfly.component.BaseComponent<E,B>

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

org.patternfly.component.form.TextArea

All Implemented Interfaces:

Attachable, Container<elemental2.dom.HTMLElement,TextArea>, Finder<elemental2.dom.HTMLElement>, HasElement<elemental2.dom.HTMLElement,TextArea>, HasHTMLElement<elemental2.dom.HTMLElement,TextArea>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement,TextArea>, Component, HasValue<String>, WithText<elemental2.dom.HTMLElement,TextArea>, Modifiers.Disabled<elemental2.dom.HTMLElement,TextArea>, Modifiers.Plain<elemental2.dom.HTMLElement,TextArea>, Modifiers.Readonly<elemental2.dom.HTMLElement,TextArea>, Modifiers.Required<elemental2.dom.HTMLElement,TextArea>

public class TextArea
extends FormControl<elemental2.dom.HTMLElement,TextArea>
implements HasValue<String>, Modifiers.Plain<elemental2.dom.HTMLElement,TextArea>, Modifiers.Readonly<elemental2.dom.HTMLElement,TextArea>, WithText<elemental2.dom.HTMLElement,TextArea>, Attachable

A text area component is used for entering a paragraph of text that is longer than one line.

See Also:

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

Method Summary

Modifier and Type	Method	Description
TextArea	applyTo(Consumer<HTMLElementBuilder<elemental2.dom.HTMLTextAreaElement>> consumer)	Provides access to the underlying text area element using a fluent API style
void	attach(elemental2.dom.MutationRecord mutationRecord)
TextArea	autoResize()
TextArea	onChange(ChangeHandler<TextArea,String> changeHandler)	Defines a change handler that is called when the value() of this text area changes.
TextArea	onKeyup(ChangeHandler<TextArea,String> changeHandler)	Defines a change handler that is called when the value() of this text area changes.
TextArea	placeholder(String placeholder)
TextArea	plain(boolean plain)
TextArea	readonly(boolean readonly)
TextArea	required(boolean required)
TextArea	resize(TextAreaResize resize)
String	text()
TextArea	text(String text)	Same as value(String)
static TextArea	textArea(String id)
static TextArea	textArea(String id, String value)
HTMLElementBuilder<elemental2.dom.HTMLTextAreaElement>	textAreaElement()	Returns the underlying input element
TextArea	that()
String	value()
TextArea	value(String value)	Same as value(value, false)
TextArea	value(String value, boolean fireEvent)

Methods inherited from class org.patternfly.component.form.FormControl

disabled, resetValidation, validated

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.Attachable

detach

Methods inherited from interface org.jboss.elemento.Container

add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

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 org.jboss.elemento.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

Method Details

textArea

public static TextArea textArea(String id)

textArea

public static TextArea textArea(String id,
 String value)

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

autoResize

public TextArea autoResize()

readonly

public TextArea readonly(boolean readonly)

Specified by:

readonly in interface Modifiers.Readonly<elemental2.dom.HTMLElement,TextArea>

plain

public TextArea plain(boolean plain)

Specified by:

plain in interface Modifiers.Plain<elemental2.dom.HTMLElement,TextArea>

placeholder

public TextArea placeholder(String placeholder)

resize

public TextArea resize(TextAreaResize resize)

required

public TextArea required(boolean required)

Specified by:

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

text

public TextArea text(String text)

Same as value(String)

Specified by:

text in interface WithText<elemental2.dom.HTMLElement,TextArea>

value

public TextArea value(String value)

Same as value(value, false)

value

public TextArea value(String value,
 boolean fireEvent)

applyTo

public TextArea applyTo(Consumer<HTMLElementBuilder<elemental2.dom.HTMLTextAreaElement>> consumer)

Provides access to the underlying text area element using a fluent API style

that

public TextArea that()

Specified by:

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

onKeyup

public TextArea onKeyup(ChangeHandler<TextArea,String> changeHandler)

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

onChange

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

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

value

public String value()

Specified by:

value in interface HasValue<String>

textAreaElement

public HTMLElementBuilder<elemental2.dom.HTMLTextAreaElement> textAreaElement()

Returns the underlying input element

text

public String text()

Specified by:

text in interface WithText<elemental2.dom.HTMLElement,TextArea>