Method Details

• getValueChangeMode

  public ValueChangeMode getValueChangeMode()

  Gets current value change mode of the component.

  The default value is ValueChangeMode.ON_CHANGE.

  Specified by:

  getValueChangeMode in interface HasValueChangeMode

  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 interface HasValueChangeMode

  Parameters:

  valueChangeMode - new value change mode, or null to disable the value synchronization

• setValueChangeTimeout

  public void setValueChangeTimeout(int valueChangeTimeout)

  Description copied from interface: HasValueChangeMode

  Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.

  Implementations should use ValueChangeMode.applyChangeTimeout(ValueChangeMode, int, DomListenerRegistration).

  Specified by:

  setValueChangeTimeout in interface HasValueChangeMode

  Parameters:

  valueChangeTimeout - the timeout in milliseconds of how often HasValue.ValueChangeEvents are triggered.

• getValueChangeTimeout

  public int getValueChangeTimeout()

  Description copied from interface: HasValueChangeMode

  Returns the currently set timeout, for how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.

  Specified by:

  getValueChangeTimeout in interface HasValueChangeMode

  Returns:

  the timeout in milliseconds of how often HasValue.ValueChangeEvents are triggered.

• setAutofocus

  public void setAutofocus(boolean autofocus)

  Sets the whether the component should automatically receive focus when the page loads. Defaults to false.

  Parameters:

  autofocus - true component should automatically receive focus

• isAutofocus

  public boolean isAutofocus()

  Specify that this control should have input focus when the page loads.

  Returns:

  the autofocus property from the webcomponent

• getTitle

  public String getTitle()

  The text usually displayed in a tooltip popup when the mouse is over the field.

  Returns:

  the title property from the webcomponent

• setTitle

  public void setTitle(String title)

  The text usually displayed in a tooltip popup when the mouse is over the field.

  Parameters:

  title - the String value to set

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

  Parameters:

  autoselect - true to set auto select on, false otherwise

• setRequiredIndicatorVisible

  public void setRequiredIndicatorVisible(boolean required)

  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 setLabel(String).

  Specified by:

  setRequiredIndicatorVisible in interface HasValue<TComponent extends TextFieldBase<TComponent,TValue>,TValue>

  Specified by:

  setRequiredIndicatorVisible in interface HasValueAndElement<TComponent extends TextFieldBase<TComponent,TValue>,TValue>

  Parameters:

  required - true to make the field required, false otherwise

• isRequiredIndicatorVisible

  public boolean isRequiredIndicatorVisible()

  Gets whether the user is required to provide a value.

  Specified by:

  isRequiredIndicatorVisible in interface HasValue<TComponent extends TextFieldBase<TComponent,TValue>,TValue>

  Specified by:

  isRequiredIndicatorVisible in interface HasValueAndElement<TComponent extends TextFieldBase<TComponent,TValue>,TValue>

  Returns:

  true if the field is required, false otherwise

  See Also:

  • setRequiredIndicatorVisible(boolean)

• setRequired

  public void setRequired(boolean required)

  Alias for setRequiredIndicatorVisible(boolean).

  Parameters:

  required - true to make the field required, false otherwise

• isRequired

  public boolean isRequired()

  Alias for isRequiredIndicatorVisible()

  Returns:

  true if the field is required, false otherwise

• setLabel

  public void setLabel(String label)

  Description copied from interface: HasLabel

  Set the label of the component to the given text.

  Specified by:

  setLabel in interface HasLabel

  Parameters:

  label - the label text to set or null to clear

• setAriaLabel

  public void setAriaLabel(String ariaLabel)

  Description copied from interface: HasAriaLabel

  Set the aria-label of the component to the given text.

  This method should not be used if HasAriaLabel.setAriaLabelledBy(String) is also used. If both attributes are present, aria-labelledby will take precedence over aria-label.

  Specified by:

  setAriaLabel in interface HasAriaLabel

  Parameters:

  ariaLabel - the aria-label text to set or null to clear

• getAriaLabel

  public Optional<String> getAriaLabel()

  Description copied from interface: HasAriaLabel

  Gets the aria-label of the component.

  Specified by:

  getAriaLabel in interface HasAriaLabel

  Returns:

  an optional aria-label of the component if no aria-label has been set

• setAriaLabelledBy

  public void setAriaLabelledBy(String labelledBy)

  Description copied from interface: HasAriaLabel

  Set the aria-labelledby of the component. The value must be a valid id attribute of another element that labels the component. The label element must be in the same DOM scope of the component, otherwise screen readers may fail to announce the label content properly.

  This method should not be used if HasAriaLabel.setAriaLabel(String) is also used. If both attributes are present, aria-labelledby will take precedence over aria-label.

  Specified by:

  setAriaLabelledBy in interface HasAriaLabel

  Parameters:

  labelledBy - the string with the id of the element that will be used as label or null to clear

• getAriaLabelledBy

  public Optional<String> getAriaLabelledBy()

  Description copied from interface: HasAriaLabel

  Gets the aria-labelledby of the component

  Specified by:

  getAriaLabelledBy in interface HasAriaLabel

  Returns:

  an optional aria-labelledby of the component if no aria-labelledby has been set

• addToPrefix

  protected void addToPrefix(Component... components)

  Adds the given components as children of this component at the slot 'prefix'.

  Parameters:

  components - The components to add.

  See Also:

  • MDN page about slots
  • Spec website about slots

• addToInput

  protected void addToInput(Component... components)

  Adds the given components as children of this component at the slot 'input'.

  Parameters:

  components - The components to add.

  See Also:

  • MDN page about slots
  • Spec website about slots

• addToSuffix

  protected void addToSuffix(Component... components)

  Adds the given components as children of this component at the slot 'suffix'.

  Parameters:

  components - The components to add.

  See Also:

  • MDN page about slots
  • Spec website about slots