com.vaadin.flow.component.textfield.
Class TextArea
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.AbstractField<C,T>
-
- com.vaadin.flow.component.AbstractSinglePropertyField<R,T>
-
- com.vaadin.flow.component.textfield.GeneratedVaadinTextArea<TextArea,String>
-
- com.vaadin.flow.component.textfield.TextArea
-
All Implemented Interfaces:
AttachNotifier
,BlurNotifier<TextArea>
,CompositionNotifier
,DetachNotifier
,Focusable<TextArea>
,FocusNotifier<TextArea>
,HasElement
,HasEnabled
,HasHelper
,HasLabel
,HasSize
,HasStyle
,HasTheme
,HasValidation
,HasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
,HasValueAndElement<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
,InputNotifier
,KeyNotifier
,HasClearButton
,HasAutocapitalize
,HasAutocomplete
,HasAutocorrect
,HasPrefixAndSuffix
,HasValueChangeMode
,Serializable
public class TextArea extends GeneratedVaadinTextArea<TextArea,String> implements HasSize, HasValidation, HasValueChangeMode, HasPrefixAndSuffix, InputNotifier, KeyNotifier, CompositionNotifier, HasAutocomplete, HasAutocapitalize, HasAutocorrect, HasHelper, HasLabel, HasClearButton
Text Area is an input field component for multi-line text input. Text Area is typically used for descriptions, comments, and other longer free-form content.
Author:
Vaadin Ltd.
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinTextArea
GeneratedVaadinTextArea.ChangeEvent<R extends GeneratedVaadinTextArea<R,?>>, GeneratedVaadinTextArea.InvalidChangeEvent<R extends GeneratedVaadinTextArea<R,?>>
-
Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
AbstractField.ComponentValueChangeEvent<C extends Component,V>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>
-
-
Field Summary
-
Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize
AUTOCAPITALIZE_ATTRIBUTE
-
Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete
AUTOCOMPLETE_ATTRIBUTE
-
Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect
AUTOCORRECT_ATTRIBUTE
-
Fields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode
DEFAULT_CHANGE_TIMEOUT
-
-
Constructor Summary
Constructors Constructor Description TextArea()
Constructs an empty
TextArea
.TextArea(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<TextArea,String>> listener)
Constructs an empty
TextArea
with a value change listener.TextArea(String label)
Constructs an empty
TextArea
with the given label.TextArea(String label, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<TextArea,String>> listener)
Constructs an empty
TextArea
with a label and a value change listener.TextArea(String label, String placeholder)
Constructs an empty
TextArea
with the given label and placeholder text.TextArea(String label, String initialValue, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<TextArea,String>> listener)
Constructs an empty
TextArea
with a label, a value change listener and an initial value.TextArea(String label, String initialValue, String placeholder)
Constructs a
TextArea
with the given label, an initial value and placeholder text.
-
Method Summary
All Methods Modifier and Type Method Description String
getEmptyValue()
Returns the value that represents an empty value.
String
getErrorMessage()
Gets current error message from the component.
String
getLabel()
String used for the label element.
int
getMaxLength()
Maximum number of characters (in Unicode code points) that the user can enter.
int
getMinLength()
Minimum number of characters (in Unicode code points) that the user can enter.
String
getPattern()
A regular expression that the value is checked against.
String
getPlaceholder()
A hint to the user of what can be entered in the component.
String
getValue()
Returns the current value of the text area.
ValueChangeMode
getValueChangeMode()
Gets current value change mode of the component.
int
getValueChangeTimeout()
Returns the currently set timeout, for how often
HasValue.ValueChangeEvent
s are triggered when the ValueChangeMode is set toValueChangeMode.LAZY
, orValueChangeMode.TIMEOUT
.boolean
isAutofocus()
Specify that this control should have input focus when the page loads.
boolean
isAutoselect()
Specifies if the field value gets automatically selected when the field gains focus.
boolean
isInvalid()
Returns
true
if component input is invalid,false
otherwise.boolean
isPreventInvalidInput()
When set to
true
, user is prevented from typing a value that conflicts with the givenpattern
.boolean
isRequired()
Specifies that the user must fill in a value.
protected void
onAttach(AttachEvent attachEvent)
Called when the component is attached to a UI.
void
setAutofocus(boolean autofocus)
Description copied from corresponding location in WebComponent:
void
setAutoselect(boolean autoselect)
Set to
true
to always have the field value automatically selected when the field gains focus,false
otherwise.void
setErrorMessage(String errorMessage)
Description copied from corresponding location in WebComponent:
void
setInvalid(boolean invalid)
Description copied from corresponding location in WebComponent:
void
setLabel(String label)
Description copied from corresponding location in WebComponent:
void
setMaxLength(int maxLength)
Maximum number of characters (in Unicode code points) that the user can enter.
void
setMinLength(int minLength)
Minimum number of characters (in Unicode code points) that the user can enter.
void
setPattern(String pattern)
Sets a regular expression for the value to pass on the client-side.
void
setPlaceholder(String placeholder)
Description copied from corresponding location in WebComponent:
void
setPreventInvalidInput(boolean preventInvalidInput)
Description copied from corresponding location in WebComponent:
void
setRequired(boolean required)
Description copied from corresponding location in WebComponent:
void
setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
Sets the required indicator visible or not.
void
setValue(String value)
Sets the value of this text area.
void
setValueChangeMode(ValueChangeMode valueChangeMode)
Sets new value change mode for the component.
void
setValueChangeTimeout(int valueChangeTimeout)
Sets how often
HasValue.ValueChangeEvent
s are triggered when the ValueChangeMode is set toValueChangeMode.LAZY
, orValueChangeMode.TIMEOUT
.protected void
validate()
Performs server-side validation of the current value.
-
Methods inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinTextArea
addChangeListener, addInvalidChangeListener, addThemeVariants, addToPrefix, addToSuffix, addToTextarea, checkValidity, getAutocapitalizeString, getAutocompleteString, getAutocorrectString, getErrorMessageString, getLabelString, getMaxlengthDouble, getMinlengthDouble, getNameString, getPlaceholderString, isAutofocusBoolean, isAutoselectBoolean, isDisabledBoolean, isInvalidBoolean, isPreventInvalidInputBoolean, isReadonlyBoolean, isRequiredBoolean, remove, removeAll, removeThemeVariants, setAutocapitalize, setAutocomplete, setAutocorrect, setDisabled, setMaxlength, setMinlength, setName, setReadonly
-
Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent
-
Methods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, isEmpty, setModelValue, valueEquals
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListener
-
Methods inherited from interface com.vaadin.flow.component.CompositionNotifier
addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndex
-
Methods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListener
-
Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize
getAutocapitalize, setAutocapitalize
-
Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete
getAutocomplete, setAutocomplete
-
Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect
isAutocorrect, setAutocorrect
-
Methods inherited from interface com.vaadin.flow.component.shared.HasClearButton
isClearButtonVisible, setClearButtonVisible
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
-
Methods inherited from interface com.vaadin.flow.component.HasHelper
getHelperComponent, getHelperText, setHelperComponent, setHelperText
-
Methods inherited from interface com.vaadin.flow.component.textfield.HasPrefixAndSuffix
getPrefixComponent, getSuffixComponent, setPrefixComponent, setSuffixComponent
-
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
Methods inherited from interface com.vaadin.flow.component.HasValue
clear, getOptionalValue
-
Methods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, isRequiredIndicatorVisible, setReadOnly
-
Methods inherited from interface com.vaadin.flow.component.InputNotifier
addInputListener
-
Methods inherited from interface com.vaadin.flow.component.KeyNotifier
addKeyDownListener, addKeyDownListener, addKeyPressListener, addKeyPressListener, addKeyUpListener, addKeyUpListener
-
-
-
-
Constructor Detail
-
TextArea
public TextArea()
Constructs an empty
TextArea
.
-
TextArea
public TextArea(String label)
Constructs an empty
TextArea
with the given label.Parameters:
label
- the text to set as the label
-
TextArea
public TextArea(String label, String placeholder)
Constructs an empty
TextArea
with the given label and placeholder text.Parameters:
label
- the text to set as the labelplaceholder
- the placeholder text to set
-
TextArea
public TextArea(String label, String initialValue, String placeholder)
Constructs a
TextArea
with the given label, an initial value and placeholder text.Parameters:
label
- the text to set as the labelinitialValue
- the initial valueplaceholder
- the placeholder text to setSee Also:
-
TextArea
public TextArea(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<TextArea,String>> listener)
Constructs an empty
TextArea
with a value change listener.Parameters:
listener
- the value change listenerSee Also:
AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)
-
TextArea
public TextArea(String label, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<TextArea,String>> listener)
Constructs an empty
TextArea
with a label and a value change listener.Parameters:
label
- the text to set as the labellistener
- the value change listenerSee Also:
setLabel(String)
,AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)
-
TextArea
public TextArea(String label, String initialValue, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<TextArea,String>> listener)
Constructs an empty
TextArea
with a label, a value change listener and an initial value.Parameters:
label
- the text to set as the labelinitialValue
- the initial valuelistener
- the value change listenerSee Also:
setLabel(String)
,AbstractField.setValue(Object)
,AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)
-
-
Method Detail
-
getValueChangeMode
public ValueChangeMode getValueChangeMode()
Gets current value change mode of the component.
The default value is
ValueChangeMode.ON_CHANGE
.Specified by:
getValueChangeMode
in interfaceHasValueChangeMode
Returns:
current value change mode of the component, or
null
if the value is not synchronized
-
setValueChangeMode
public void setValueChangeMode(ValueChangeMode valueChangeMode)
Description copied from interface:
HasValueChangeMode
Sets new value change mode for the component.
Specified by:
setValueChangeMode
in interfaceHasValueChangeMode
Parameters:
valueChangeMode
- new value change mode, ornull
to disable the value synchronization
-
setValueChangeTimeout
public void setValueChangeTimeout(int valueChangeTimeout)
Description copied from interface:
HasValueChangeMode
Sets how often
HasValue.ValueChangeEvent
s are triggered when the ValueChangeMode is set toValueChangeMode.LAZY
, orValueChangeMode.TIMEOUT
.Implementations should use
ValueChangeMode.applyChangeTimeout(ValueChangeMode, int, DomListenerRegistration)
.Specified by:
setValueChangeTimeout
in interfaceHasValueChangeMode
Parameters:
valueChangeTimeout
- the timeout in milliseconds of how oftenHasValue.ValueChangeEvent
s are triggered.
-
getValueChangeTimeout
public int getValueChangeTimeout()
Description copied from interface:
HasValueChangeMode
Returns the currently set timeout, for how often
HasValue.ValueChangeEvent
s are triggered when the ValueChangeMode is set toValueChangeMode.LAZY
, orValueChangeMode.TIMEOUT
.Specified by:
getValueChangeTimeout
in interfaceHasValueChangeMode
Returns:
the timeout in milliseconds of how often
HasValue.ValueChangeEvent
s are triggered.
-
getErrorMessage
public String getErrorMessage()
Description copied from interface:
HasValidation
Gets current error message from the component.
Specified by:
getErrorMessage
in interfaceHasValidation
Returns:
current error message
-
setErrorMessage
public void setErrorMessage(String errorMessage)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
Error to show when the input value is invalid.
Specified by:
setErrorMessage
in interfaceHasValidation
Overrides:
setErrorMessage
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
errorMessage
- the String value to set
-
isInvalid
public boolean isInvalid()
Description copied from interface:
HasValidation
Returns
true
if component input is invalid,false
otherwise.Specified by:
isInvalid
in interfaceHasValidation
Returns:
whether the component input is valid
-
setInvalid
public void setInvalid(boolean invalid)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
This property is set to true when the control value is invalid.
Specified by:
setInvalid
in interfaceHasValidation
Overrides:
setInvalid
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
invalid
- the boolean value to set
-
setLabel
public void setLabel(String label)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
String used for the label element.
-
getLabel
public String getLabel()
String used for the label element.
-
setPlaceholder
public void setPlaceholder(String placeholder)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
A hint to the user of what can be entered in the control.
Overrides:
setPlaceholder
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
placeholder
- the String value to set
-
getPlaceholder
public String getPlaceholder()
A hint to the user of what can be entered in the component.
Returns:
the
placeholder
property from the webcomponent
-
isAutoselect
public boolean isAutoselect()
Specifies if the field value gets automatically selected when the field gains focus.
Returns:
true
if autoselect is active,false
otherwise
-
setAutoselect
public void setAutoselect(boolean autoselect)
Set to
true
to always have the field value automatically selected when the field gains focus,false
otherwise.Overrides:
setAutoselect
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
autoselect
-true
to set auto select on,false
otherwise
-
setAutofocus
public void setAutofocus(boolean autofocus)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
Specify that this control should have input focus when the page loads.
Overrides:
setAutofocus
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
autofocus
- the boolean value to set
-
isAutofocus
public boolean isAutofocus()
Specify that this control should have input focus when the page loads.
Returns:
the
autofocus
property from the webcomponent
-
setMaxLength
public void setMaxLength(int maxLength)
Maximum number of characters (in Unicode code points) that the user can enter.
Parameters:
maxLength
- the maximum length
-
getMaxLength
public int getMaxLength()
Maximum number of characters (in Unicode code points) that the user can enter.
Returns:
the
maxlength
property from the webcomponent
-
setMinLength
public void setMinLength(int minLength)
Minimum number of characters (in Unicode code points) that the user can enter.
Parameters:
minLength
- the minimum length
-
getMinLength
public int getMinLength()
Minimum number of characters (in Unicode code points) that the user can enter.
Returns:
the
minlength
property from the webcomponent
-
isRequired
public boolean isRequired()
Specifies that the user must fill in a value.
Returns:
the
required
property from the webcomponent
-
setRequired
public void setRequired(boolean required)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
Specifies that the user must fill in a value.
Overrides:
setRequired
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
required
- the boolean value to set
-
isPreventInvalidInput
public boolean isPreventInvalidInput()
When set to
true
, user is prevented from typing a value that conflicts with the givenpattern
.Returns:
the
preventInvalidInput
property from the webcomponent
-
setPreventInvalidInput
public void setPreventInvalidInput(boolean preventInvalidInput)
Description copied from class:
GeneratedVaadinTextArea
Description copied from corresponding location in WebComponent:
When set to true, user is prevented from typing a value that conflicts with the given
maxlength
orminlength
properties.Overrides:
setPreventInvalidInput
in classGeneratedVaadinTextArea<TextArea,String>
Parameters:
preventInvalidInput
- the boolean value to set
-
setPattern
public void setPattern(String pattern)
Sets a regular expression for the value to pass on the client-side. The pattern must be a valid JavaScript Regular Expression that matches the entire value, not just some subset.
Parameters:
pattern
- the new String patternSee Also:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefpattern, https://html.spec.whatwg.org/multipage/input.html#attr-input-pattern
-
getPattern
public String getPattern()
A regular expression that the value is checked against. The pattern must match the entire value, not just some subset.
Returns:
the
pattern
property
-
getEmptyValue
public String getEmptyValue()
Description copied from interface:
HasValue
Returns the value that represents an empty value.
By default
HasValue
is expected to supportnull
as empty values. Specific implementations might not support this.Specified by:
getEmptyValue
in interfaceHasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
Overrides:
getEmptyValue
in classAbstractField<TextArea,String>
Returns:
empty value
-
setValue
public void setValue(String value)
Sets the value of this text area. If the new value is not equal to
getValue()
, fires a value change event. ThrowsNullPointerException
, if the value is null.Note:
Binder
will take care of thenull
conversion when integrates with text area, as long as no new converter is defined.Specified by:
setValue
in interfaceHasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
Overrides:
setValue
in classAbstractField<TextArea,String>
Parameters:
value
- the new value, notnull
-
getValue
public String getValue()
Returns the current value of the text area. By default, the empty text area will return an empty string.
Specified by:
getValue
in interfaceHasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
Overrides:
getValue
in classAbstractField<TextArea,String>
Returns:
the current value.
-
setRequiredIndicatorVisible
public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
Description copied from interface:
HasValue
Sets the required indicator visible or not.
If set visible, it is visually indicated in the user interface.
The method is intended to be used with
Binder
which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled whensetRequiredIndicatorVisible(true)
is called and re-enabled back onsetRequiredIndicatorVisible(false)
. It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their ownsetRequired
method which should be called in case the client-side validation is required.Specified by:
setRequiredIndicatorVisible
in interfaceHasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
Specified by:
setRequiredIndicatorVisible
in interfaceHasValueAndElement<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>
Parameters:
requiredIndicatorVisible
-true
to make the required indicator visible,false
if not
-
validate
protected void validate()
Performs server-side validation of the current value. This is needed because it is possible to circumvent the client-side validation constraints using browser development tools.
Overrides:
validate
in classGeneratedVaadinTextArea<TextArea,String>
-
onAttach
protected void onAttach(AttachEvent attachEvent)
Description copied from class:
Component
Called when the component is attached to a UI.
The default implementation does nothing.
This method is invoked before the
AttachEvent
is fired for the component.
-
-