Package io.jmix.ui.component

Interface HasInputPrompt

All Known Subinterfaces:
ComboBox<V>, EntityComboBox<V>, EntityPicker<V>, EntitySuggestionField<V>, PasswordField, ResizableTextArea<V>, SuggestionField<V>, SuggestionFieldComponent<V,I>, TagField<V>, TagPicker<V>, TextArea<V>, TextField<V>, ValuePicker<V>, ValuesPicker<V>
All Known Implementing Classes:
AbstractSuggestionField, AbstractTextArea, ComboBoxImpl, EntityComboBoxImpl, EntityPickerImpl, EntitySuggestionFieldImpl, PasswordFieldImpl, ResizableTextAreaImpl, SearchFieldImpl, SuggestionFieldImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl, ValuePickerImpl, ValuesPickerImpl
public interface HasInputPrompt
Interface for UI components that support a textual input prompt.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInputPrompt()
     
    void
    setInputPrompt(String inputPrompt)
    Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

  • Method Details

    • getInputPrompt

      @Nullable String getInputPrompt()
      Returns:
      current input prompt.

    • setInputPrompt

      @StudioProperty(type=LOCALIZED_STRING) void setInputPrompt(@Nullable String inputPrompt)
      Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
      Parameters:
      inputPrompt - input prompt