Package io.jmix.ui.component

Interface Requirable

All Known Subinterfaces:
CheckBox, CheckBoxGroup<I>, ColorPicker, ComboBox<V>, CurrencyField<V>, DateField<V>, DatePicker<V>, EntityComboBox<V>, EntityLinkField<V>, EntityPicker<V>, EntitySuggestionField<V>, Field<V>, FileStorageUploadField, FileUploadField, FullTextFilter, JpqlFilter<V>, MaskedField<V>, MultiSelectList<V>, OptionsField<V,I>, PasswordField, PropertyFilter<V>, RadioButtonGroup<I>, ResizableTextArea<V>, RichTextArea, SelectList<V,I>, SingleFilterComponent<V>, SingleSelectList<V>, Slider<V>, SourceCodeEditor, SuggestionField<V>, SuggestionFieldComponent<V,I>, TagField<V>, TagPicker<V>, TextArea<V>, TextField<V>, TextInputField<V>, TimeField<V>, TwinColumn<V>, ValuePicker<V>, ValuesPicker<V>, WebdavDocumentUploadField
All Known Implementing Classes:
AbstractField, AbstractFileStorageUploadField, AbstractSelectList, AbstractSingleFileUploadField, AbstractSingleFilterComponent, AbstractSuggestionField, AbstractTextArea, CheckBoxGroupImpl, CheckBoxImpl, ColorPickerImpl, ComboBoxImpl, CurrencyFieldImpl, DateFieldImpl, DatePickerImpl, EntityComboBoxImpl, EntityLinkFieldImpl, EntityPickerImpl, EntitySuggestionFieldImpl, FileStorageUploadFieldImpl, FileUploadFieldImpl, FullTextFilterImpl, JpqlFilterImpl, MaskedFieldImpl, MultiSelectListImpl, PasswordFieldImpl, PropertyFilterImpl, RadioButtonGroupImpl, ResizableTextAreaImpl, RichTextAreaImpl, SearchFieldImpl, SingleSelectListImpl, SliderImpl, SourceCodeEditorImpl, SuggestionFieldImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl, TimeFieldImpl, TwinColumnImpl, ValuePickerImpl, ValuesPickerImpl, WebdavDocumentUploadFieldImpl
public interface Requirable
Interface to be implemented by a component that requires a value

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRequiredMessage()
     
    boolean
    isRequired()
     
    void
    setRequired(boolean required)
    Sets whether the component must contain a non-null value.
    void
    setRequiredMessage(String msg)
    Sets a message that will be displayed to user if the field is required but has null value.

  • Method Details

    • isRequired

      boolean isRequired()
      Returns:
      whether the component must contain a non-null value

    • setRequired

      @StudioProperty(defaultValue="false") void setRequired(boolean required)
      Sets whether the component must contain a non-null value.
      Parameters:
      required - required

    • getRequiredMessage

      @Nullable String getRequiredMessage()
      Returns:
      a message that will be displayed to user if the component is required but has null value

    • setRequiredMessage

      @StudioProperty(type=LOCALIZED_STRING) void setRequiredMessage(@Nullable String msg)
      Sets a message that will be displayed to user if the field is required but has null value.
      Parameters:
      msg - message