Method Details

• 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

• setRequired

  public void setRequired(boolean required)

  Specifies that the user must fill in a value.

  NOTE: The required indicator will not be visible, if there is no label property set for the textfield.

  Overrides:

  setRequired in class TextFieldBase<TextArea,String>

  Parameters:

  required - 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 pattern

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

• 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 when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(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 own setRequired method which should be called in case the client-side validation is required.

  Specified by:

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

  Specified by:

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

  Parameters:

  requiredIndicatorVisible - true to make the required indicator visible, false if not

• 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()

  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.

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

  Overrides:

  onAttach in class Component

  Parameters:

  attachEvent - the attach event