io.jmix.ui.component

Interface HasInputPrompt

All Known Subinterfaces:

ComboBox<V>, EntityComboBox<V>, EntitySuggestionField<V>, PasswordField, ResizableTextArea<V>, SuggestionField<V>, SuggestionFieldComponent<V,I>, TagField<V>, TagPicker<V>, TextArea<V>, TextField<V>

All Known Implementing Classes:

AbstractSuggestionField, AbstractTextArea, ComboBoxImpl, EntityComboBoxImpl, EntitySuggestionFieldImpl, PasswordFieldImpl, ResizableTextAreaImpl, SuggestionFieldImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl

public interface HasInputPrompt

Interface for UI components that support a textual input prompt.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInputPrompt()
void	setInputPrompt(java.lang.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 Detail

getInputPrompt

@Nullable
java.lang.String getInputPrompt()

Returns:

current input prompt.

setInputPrompt

@StudioProperty(type=LOCALIZED_STRING)
void setInputPrompt(@Nullable
                                                           java.lang.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