Method Details

• scrollToStart

  public void scrollToStart()

  Scrolls the textarea to the start if it has a vertical scrollbar.

• scrollToEnd

  public void scrollToEnd()

  Scrolls the textarea to the end if it has a vertical scrollbar.

• setErrorMessage

  public void setErrorMessage(String errorMessage)

  Sets a single error message to display for all constraint violations. The error message will only appear when the component is flagged as invalid, either as a result of constraint validation or by the developer through HasValidationProperties.setInvalid(boolean) if manual validation mode is enabled.

  Distinct error messages for different constraints can be configured with the TextArea.TextAreaI18n object, using the respective properties. However, note that the error message set with setErrorMessage(String) will take priority and override any i18n error messages if both are set.

  Specified by:

  setErrorMessage in interface HasValidation

  Specified by:

  setErrorMessage in interface HasValidationProperties

  Parameters:

  errorMessage - the error message to set, or null to clear

• setRequiredIndicatorVisible

  public void setRequiredIndicatorVisible(boolean required)

  Description copied from class: TextFieldBase

  Sets whether the user is required to provide a value. When required, an indicator appears next to the label and the field invalidates if the value is cleared.

  NOTE: The required indicator is only visible when the field has a label, see TextFieldBase.setLabel(String).

  Specified by:

  setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>

  Specified by:

  setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>

  Overrides:

  setRequiredIndicatorVisible in class TextFieldBase<TextArea,String>

  Parameters:

  required - true to make the field required, false otherwise

  See Also:

  • TextArea.TextAreaI18n.setRequiredErrorMessage(String)

• setMaxLength

  public void setMaxLength(int maxLength)

  Sets the maximum number of characters (in Unicode code points) that the user can enter. Values with a length exceeding this limit will cause the component to invalidate.

  The maximum length is inclusive.

  Parameters:

  maxLength - the maximum length

  See Also:

  • TextArea.TextAreaI18n.setMaxLengthErrorMessage(String)

• getMaxLength

  public int getMaxLength()

  Gets the maximum number of characters (in Unicode code points) that the user can enter.

  Returns:

  the maximum length

  See Also:

  • setMaxLength(int)

• setMinLength

  public void setMinLength(int minLength)

  Sets the minimum number of characters (in Unicode code points) that the user can enter. Values with a length shorter than this limit will cause the component to invalidate.

  The minimum length is inclusive.

  Parameters:

  minLength - the minimum length

  See Also:

  • TextArea.TextAreaI18n.setMinLengthErrorMessage(String)

• getMinLength

  public int getMinLength()

  Gets the minimum number of characters (in Unicode code points) that the user can enter.

  Returns:

  the minimum length

  See Also:

  • setMinLength(int)

• setPattern

  public void setPattern(String pattern)

  Sets a regular expression for the value to pass during validation. Values that do not match the pattern will cause the component to invalidate.

  The pattern must be a valid JavaScript Regular Expression that matches the entire value, not just some subset.

  Parameters:

  pattern - the new String pattern or null to clear it

  See Also:

  • TextArea.TextAreaI18n.setPatternErrorMessage(String)
  • 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 during validation.

  Returns:

  the pattern or null if not set

  See Also:

  • setPattern(String)

• getMinRows

  public int getMinRows()

  The minimum number of rows to show.

  Returns:

  the minimum number of rows

• setMinRows

  public void setMinRows(int minRows)

  Sets the minimum number of rows to show. Default is two rows.

  Parameters:

  minRows - the minimum number of rows to show

• getMaxRows

  public Integer getMaxRows()

  Maximum number of rows to expand to before the component starts scrolling.

  Returns:

  the maximum number of rows, or null if the maximum has not been set

• setMaxRows

  public void setMaxRows(Integer maxRows)

  Sets the maximum number of rows to expand to before the component starts scrolling. This effectively sets a max-height on the input-field part. By default, the value is null, which means the component grows with the content without constraints.

  Parameters:

  maxRows - the maximum number of rows, or null to remove the maximum

• getEmptyValue

  public String getEmptyValue()

  Description copied from interface: HasValue

  Returns the value that represents an empty value.

  By default HasValue is expected to support null as empty values. Specific implementations might not support this.

  Specified by:

  getEmptyValue in interface HasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>

  Overrides:

  getEmptyValue in class AbstractField<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. Throws NullPointerException, if the value is null.

  Note: Binder will take care of the null conversion when integrates with text area, as long as no new converter is defined.

  Specified by:

  setValue in interface HasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>

  Overrides:

  setValue in class AbstractField<TextArea,String>

  Parameters:

  value - the new value, not null

• 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 interface HasValue<AbstractField.ComponentValueChangeEvent<TextArea,String>,String>

  Overrides:

  getValue in class AbstractField<TextArea,String>

  Returns:

  the current value.

• getDefaultValidator

  public Validator<String> getDefaultValidator()

  Description copied from interface: HasValidator

  Returns a validator that checks the state of the Value. This should be overridden for components with internal value conversion or validation, e.g. when the user is providing a string that has to be parsed into a date. An invalid input from user will be exposed to a Binder and can be seen as a validation failure.

  Specified by:

  getDefaultValidator in interface HasValidator<String>

  Returns:

  state validator

• setManualValidation

  public void setManualValidation(boolean enabled)

  Description copied from interface: HasValidation

  Sets whether manual validation mode is enabled for the component.

  When enabled, the component doesn't perform its built-in constraint validation on value change, blur, and other events. This allows manually controlling the invalid state and error messages using the HasValidation.setInvalid(boolean) and HasValidation.setErrorMessage(String) methods. Manual mode is helpful when there is a need for a totally custom validation logic that cannot be achieved with Binder.

  Example:

   Field field = new Field();
   field.setManualValidation(true);
   field.addValueChangeListener(event -> {
       if (Objects.equal(event.getValue(), "")) {
           field.setInvalid(true);
           field.setErrorMessage("The field is required.");
       } else {
           field.setInvalid(false);
       }
   });
   

  For components that don't have built-in validation, the method has no effect.

  Specified by:

  setManualValidation in interface HasValidation

  Parameters:

  enabled - whether to enable manual validation mode.

• validate

  protected void validate()

  Validates the current value against the constraints and sets the invalid property and the errorMessage property based on the result. If a custom error message is provided with setErrorMessage(String), it is used. Otherwise, the error message defined in the i18n object is used.

  The method does nothing if the manual validation mode is enabled.

• onAttach

  protected void onAttach(AttachEvent attachEvent)

  Description copied from class: Component

  Called when the component is attached to a UI.

  This method is invoked before the AttachEvent is fired for the component.

  Make sure to call super.onAttach when overriding this method.

  Overrides:

  onAttach in class Component

  Parameters:

  attachEvent - the attach event

• getI18n

  public TextArea.TextAreaI18n getI18n()

  Gets the internationalization object previously set for this component.

  NOTE: Updating the instance that is returned from this method will not update the component if not set again using setI18n(TextAreaI18n)

  Returns:

  the i18n object or null if no i18n object has been set

• setI18n

  public void setI18n(TextArea.TextAreaI18n i18n)

  Sets the internationalization object for this component.

  Parameters:

  i18n - the i18n object, not null