Package io.jmix.flowui.component.combobox

Class JmixComboBox<V>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<TComponent,TValue>
com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<T>,T,T>
com.vaadin.flow.component.combobox.ComboBox<V>
io.jmix.flowui.component.combobox.JmixComboBox<V>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.combobox.ComboBox<V>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.combobox.ComboBox<V>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.combobox.ComboBox<V>>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>,V>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>,V>, com.vaadin.flow.component.shared.HasAllowedCharPattern, com.vaadin.flow.component.shared.HasAutoOpen, com.vaadin.flow.component.shared.HasClearButton, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasOverlayClassName, com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.combobox.ComboBoxVariant>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>,V>, com.vaadin.flow.data.binder.HasValidator<V>, com.vaadin.flow.data.provider.HasDataView<V,String,com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V>>, com.vaadin.flow.data.provider.HasLazyDataView<V,String,com.vaadin.flow.component.combobox.dataview.ComboBoxLazyDataView<V>>, com.vaadin.flow.data.provider.HasListDataView<V,com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<V>>, HasRequired, SupportsDatatype<V>, SupportsItemsFetchCallback<V,String>, SupportsStatusChangeHandler<JmixComboBox<V>>, SupportsValidation<V>, SupportsDataProvider<V>, SupportsItemsEnum<V>, SupportsValueSource<V>, HasTitle, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class JmixComboBox<V> extends com.vaadin.flow.component.combobox.ComboBox<V> implements SupportsValueSource<V>, SupportsValidation<V>, SupportsStatusChangeHandler<JmixComboBox<V>>, SupportsDataProvider<V>, SupportsItemsEnum<V>, HasRequired, HasTitle, SupportsItemsFetchCallback<V,String>, SupportsDatatype<V>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.ComboBox

    com.vaadin.flow.component.combobox.ComboBox.FetchItemsCallback<T extends Object>, com.vaadin.flow.component.combobox.ComboBox.ItemFilter<T extends Object>

    Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.ComboBoxBase

    com.vaadin.flow.component.combobox.ComboBoxBase.CustomValueSetEvent<TComponent extends com.vaadin.flow.component.combobox.ComboBoxBase<TComponent,?,?>>

    Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

    com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V extends Object>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

    com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

    Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsItemsFetchCallback

    SupportsItemsFetchCallback.FetchCallback<T,F>

    Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsStatusChangeHandler

    SupportsStatusChangeHandler.StatusContext<C extends com.vaadin.flow.component.Component>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
    applicationContext
     
    protected DataViewDelegate<JmixComboBox<V>,V>
    dataViewDelegate
     
    protected FieldDelegate<JmixComboBox<V>,V,V>
    fieldDelegate
     

    Fields inherited from interface io.jmix.flowui.component.HasRequired

    PROPERTY_REQUIRED

    Fields inherited from interface io.jmix.flowui.component.SupportsValidation

    PROPERTY_ERROR_MESSAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixComboBox()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addValidator(Validator<? super V> validator)
     
    void
    afterPropertiesSet()
     
    protected void
    bindDataProvider(com.vaadin.flow.data.provider.DataProvider<V,?> dataProvider)
     
    protected DataViewDelegate<JmixComboBox<V>,V>
    createDataViewDelegate()
     
    protected FieldDelegate<JmixComboBox<V>,V,V>
    createFieldDelegate()
     
    void
    executeValidators()
     
    Datatype<V>
    getDatatype()
     
    String
    getErrorMessage()
     
    String
    getRequiredMessage()
     
    ValueSource<V>
    getValueSource()
     
    protected void
    initComponent()
     
    boolean
    isInvalid()
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setDatatype(Datatype<V> datatype)
     
    void
    setErrorMessage(String errorMessage)
     
    void
    setInvalid(boolean invalid)
    Sets invalid state to the field considering result of field validation.
    com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<V>
    setItems(com.vaadin.flow.component.combobox.ComboBox.ItemFilter<V> itemFilter, com.vaadin.flow.data.provider.ListDataProvider<V> listDataProvider)
     
    com.vaadin.flow.component.combobox.dataview.ComboBoxLazyDataView<V>
    setItems(com.vaadin.flow.data.provider.BackEndDataProvider<V,String> dataProvider)
     
    com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V>
    setItems(com.vaadin.flow.data.provider.DataProvider<V,String> dataProvider)
     
    com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V>
    setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<V> inMemoryDataProvider, com.vaadin.flow.function.SerializableFunction<String,com.vaadin.flow.function.SerializablePredicate<V>> filterConverter)
     
    com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<V>
    setItems(com.vaadin.flow.data.provider.ListDataProvider<V> dataProvider)
     
    void
    setItems(Class<V> itemsEnum)
    Sets items from the passed EnumClass.
    void
    setItemsFetchCallback(SupportsItemsFetchCallback.FetchCallback<V,String> fetchCallback)
    Supply items lazily with a callback from a backend.
    void
    setRequired(boolean required)
     
    void
    setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
     
    void
    setRequiredMessage(String requiredMessage)
     
    void
    setStatusChangeHandler(Consumer<SupportsStatusChangeHandler.StatusContext<JmixComboBox<V>>> handler)
    Sets a callback to be used to handle component status changes, e.g.
    void
    setValueSource(ValueSource<V> valueSource)
     
    protected void
    validate()
     

    Methods inherited from class com.vaadin.flow.component.combobox.ComboBox

    getEmptyValue, getPattern, isSelected, refreshValue, setPattern

    Methods inherited from class com.vaadin.flow.component.combobox.ComboBoxBase

    addCustomValueSetListener, generateLabel, getAriaLabel, getAriaLabelledBy, getDataCommunicator, getDataController, getDataGenerator, getDataProvider, getFilter, getGenericDataView, getItemLabelGenerator, getKeyMapper, getLazyDataView, getListDataView, getPageSize, getRenderManager, isAllowCustomValue, isAutofocus, isOpened, isRequired, onAttach, onDetach, runBeforeClientResponse, setAllowCustomValue, setAriaLabel, setAriaLabelledBy, setAutofocus, setDataProvider, setDataProvider, setFilter, setItemLabelGenerator, setItems, setItems, setItems, setItems, setItems, setItems, setItemsWithFilterConverter, setItemsWithFilterConverter, setManualValidation, setOpened, setPageSize, setRenderer, setValue

    Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

    getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

    Methods inherited from class com.vaadin.flow.component.AbstractField

    addValueChangeListener, getValue, isEmpty, setModelValue, valueEquals

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

    addAttachListener

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

    addBlurListener

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

    addDetachListener

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

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

    addFocusListener

    Methods inherited from interface com.vaadin.flow.component.shared.HasAllowedCharPattern

    getAllowedCharPattern, setAllowedCharPattern

    Methods inherited from interface com.vaadin.flow.component.shared.HasAutoOpen

    isAutoOpen, setAutoOpen

    Methods inherited from interface com.vaadin.flow.component.shared.HasClearButton

    isClearButtonVisible, setClearButtonVisible

    Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    addClientValidatedEventListener

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

    getElement

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

    isEnabled, setEnabled

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

    getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

    getLabel, setLabel

    Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

    setItems

    Methods inherited from interface com.vaadin.flow.component.shared.HasOverlayClassName

    getOverlayClassName, setOverlayClassName

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

    getPlaceholder, setPlaceholder

    Methods inherited from interface com.vaadin.flow.component.shared.HasPrefix

    getPrefixComponent, setPrefixComponent

    Methods inherited from interface io.jmix.flowui.component.HasRequired

    isRequired

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

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

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

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

    addThemeVariants, removeThemeVariants

    Methods inherited from interface io.jmix.flowui.kit.component.HasTitle

    getTitle, setTitle

    Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

    getTooltip, setTooltipText

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

    setManualValidation

    Methods inherited from interface com.vaadin.flow.data.binder.HasValidator

    addValidationStatusChangeListener, getDefaultValidator

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

    addValueChangeListener, clear, getOptionalValue, getValue, isEmpty

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

    isReadOnly, isRequiredIndicatorVisible, setReadOnly

    Methods inherited from interface io.jmix.flowui.data.SupportsDataProvider

    getDataProvider

  • Field Details

  • Constructor Details

    • JmixComboBox

      public JmixComboBox()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware

    • afterPropertiesSet

      public void afterPropertiesSet()
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

    • initComponent

      protected void initComponent()

    • addValidator

      public com.vaadin.flow.shared.Registration addValidator(Validator<? super V> validator)
      Specified by:
      addValidator in interface SupportsValidation<V>

    • executeValidators

      public void executeValidators() throws ValidationException
      Specified by:
      executeValidators in interface SupportsValidation<V>
      Throws:
      ValidationException

    • setItems

      public void setItems(Class<V> itemsEnum)
      Description copied from interface: SupportsItemsEnum
      Sets items from the passed EnumClass.
      Specified by:
      setItems in interface SupportsItemsEnum<V>
      Parameters:
      itemsEnum - a EnumClass to be used as items source
      See Also:

    • setItems

      public com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<V> setItems(com.vaadin.flow.component.combobox.ComboBox.ItemFilter<V> itemFilter, com.vaadin.flow.data.provider.ListDataProvider<V> listDataProvider)
      Overrides:
      setItems in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • setItems

      public com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<V> setItems(com.vaadin.flow.data.provider.ListDataProvider<V> dataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasListDataView<V,com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<V>>
      Overrides:
      setItems in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • setItems

      public com.vaadin.flow.component.combobox.dataview.ComboBoxLazyDataView<V> setItems(com.vaadin.flow.data.provider.BackEndDataProvider<V,String> dataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasLazyDataView<V,String,com.vaadin.flow.component.combobox.dataview.ComboBoxLazyDataView<V>>
      Overrides:
      setItems in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • setItems

      public com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V> setItems(com.vaadin.flow.data.provider.DataProvider<V,String> dataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasDataView<V,String,com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V>>
      Overrides:
      setItems in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • setItems

      public com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V> setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<V> inMemoryDataProvider, com.vaadin.flow.function.SerializableFunction<String,com.vaadin.flow.function.SerializablePredicate<V>> filterConverter)
      Overrides:
      setItems in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • bindDataProvider

      protected void bindDataProvider(com.vaadin.flow.data.provider.DataProvider<V,?> dataProvider)

    • setItemsFetchCallback

      public void setItemsFetchCallback(SupportsItemsFetchCallback.FetchCallback<V,String> fetchCallback)
      Description copied from interface: SupportsItemsFetchCallback
      Supply items lazily with a callback from a backend.
      Specified by:
      setItemsFetchCallback in interface SupportsItemsFetchCallback<V,String>
      Parameters:
      fetchCallback - function that returns a stream of items from the backend based on the offset, limit and an optional filter provided by the query object

    • getValueSource

      @Nullable public ValueSource<V> getValueSource()
      Specified by:
      getValueSource in interface SupportsValueSource<V>

    • setValueSource

      public void setValueSource(@Nullable ValueSource<V> valueSource)
      Specified by:
      setValueSource in interface SupportsValueSource<V>

    • getDatatype

      @Nullable public Datatype<V> getDatatype()
      Specified by:
      getDatatype in interface SupportsDatatype<V>

    • setDatatype

      public void setDatatype(@Nullable Datatype<V> datatype)
      Specified by:
      setDatatype in interface SupportsDatatype<V>

    • setRequired

      public void setRequired(boolean required)
      Specified by:
      setRequired in interface HasRequired
      Overrides:
      setRequired in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>,V>
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>,V>

    • validate

      protected void validate()
      Overrides:
      validate in class com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V,V>

    • getRequiredMessage

      @Nullable public String getRequiredMessage()
      Specified by:
      getRequiredMessage in interface HasRequired

    • setRequiredMessage

      public void setRequiredMessage(@Nullable String requiredMessage)
      Specified by:
      setRequiredMessage in interface HasRequired

    • isInvalid

      public boolean isInvalid()
      Specified by:
      isInvalid in interface com.vaadin.flow.component.HasValidation
      Specified by:
      isInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties

    • setInvalid

      public void setInvalid(boolean invalid)
      Description copied from interface: SupportsValidation
      Sets invalid state to the field considering result of field validation.
      • Invalid - false and validation passed - false = field is invalid
      • Invalid - false and validation passed - true = field is valid
      • Invalid - true and validation passed - false = field is invalid
      • Invalid - true and validation passed - true = field is invalid
      Specified by:
      setInvalid in interface com.vaadin.flow.component.HasValidation
      Specified by:
      setInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      setInvalid in interface SupportsValidation<V>
      Parameters:
      invalid - whether field should be invalid

    • getErrorMessage

      @Nullable public String getErrorMessage()
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.HasValidation
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      getErrorMessage in interface SupportsValidation<V>

    • setErrorMessage

      public void setErrorMessage(@Nullable String errorMessage)
      Specified by:
      setErrorMessage in interface com.vaadin.flow.component.HasValidation
      Specified by:
      setErrorMessage in interface com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      setErrorMessage in interface SupportsValidation<V>

    • setStatusChangeHandler

      public void setStatusChangeHandler(@Nullable Consumer<SupportsStatusChangeHandler.StatusContext<JmixComboBox<V>>> handler)
      Description copied from interface: SupportsStatusChangeHandler
      Sets a callback to be used to handle component status changes, e.g. validation messages set by HasValidation.setErrorMessage(String).
      Specified by:
      setStatusChangeHandler in interface SupportsStatusChangeHandler<V>
      Parameters:
      handler - a handler to set

    • createFieldDelegate

      protected FieldDelegate<JmixComboBox<V>,V,V> createFieldDelegate()

    • createDataViewDelegate

      protected DataViewDelegate<JmixComboBox<V>,V> createDataViewDelegate()