Package com.vaadin.flow.component

Interface HasPlaceholder

All Superinterfaces:
HasElement, Serializable
All Known Implementing Classes:
AbstractNumberField, BigDecimalField, ComboBox, ComboBoxBase, DatePicker, EmailField, Input, IntegerField, MultiSelectComboBox, NumberField, PasswordField, Select, TextArea, TextField, TextFieldBase, TimePicker
public interface HasPlaceholder extends HasElement
A component which supports a placeholder.

A placeholder is a text that should be displayed in the input element, when the user has not entered a value.

The default implementations sets the placeholder property for this element. Override all methods in this interface if the placeholder should be set in some other way.

  • Method Summary

    Modifier and Type
    Method
    Description
    default SignalBinding<String>
    bindPlaceholder(Signal<String> placeholderSignal)
    Binds a signal's value to the component's placeholder.
    default String
    getPlaceholder()
    The placeholder text that should be displayed in the input element, when the user has not entered a value
    default void
    setPlaceholder(String placeholder)
    Sets the placeholder text that should be displayed in the input element, when the user has not entered a value

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

  • Method Details

    • setPlaceholder

      default void setPlaceholder(String placeholder)
      Sets the placeholder text that should be displayed in the input element, when the user has not entered a value
      Parameters:
      placeholder - the placeholder text, may be null.

    • getPlaceholder

      default String getPlaceholder()
      The placeholder text that should be displayed in the input element, when the user has not entered a value
      Returns:
      the placeholder property from the web component. May be null if not yet set.

    • bindPlaceholder

      default SignalBinding<String> bindPlaceholder(Signal<String> placeholderSignal)
      Binds a signal's value to the component's placeholder. The placeholder is set immediately with the current signal value when the binding is created, and is kept synchronized with any subsequent signal value changes while the component is in attached state.

      Passing null as the signal removes any existing binding for the given placeholder. When unbinding, the current placeholder is left unchanged.

      While a binding for the placeholder is active, any attempt to set the placeholder manually throws BindingActiveException. The same happens when trying to bind a new signal while one is already bound.

      When the component is in the detached state, signal value changes have no effect.

      Parameters:
      placeholderSignal - the signal to bind, not null
      Throws:
      BindingActiveException - thrown when there is already an existing binding
      Since:
      25.1
      See Also: