Class EntityComboBox<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.kit.component.combobox.ComboBoxPicker<V>
io.jmix.flowui.component.combobox.EntityComboBox<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>> EntityPickerComponent<V>,HasRequired,LookupComponent<V>,PickerComponent<V>,SupportsItemsFetchCallback<V,,String> SupportsMetaClass,SupportsStatusChangeHandler<EntityComboBox<V>>,SupportsValidation<V>,SupportsDataProvider<V>,SupportsFilterableItemsContainer<V>,SupportsItemsContainer<V>,SupportsValueSource<V>,HasActions,HasTitle,SupportsUserAction<V>,Serializable,org.springframework.beans.factory.Aware,org.springframework.beans.factory.InitializingBean,org.springframework.context.ApplicationContextAware
public class EntityComboBox<V>
extends ComboBoxPicker<V>
implements EntityPickerComponent<V>, LookupComponent<V>, SupportsValidation<V>, SupportsDataProvider<V>, SupportsItemsContainer<V>, SupportsFilterableItemsContainer<V>, SupportsStatusChangeHandler<EntityComboBox<V>>, HasRequired, SupportsItemsFetchCallback<V,String>, 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.ComboBoxI18n, 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,?, ?>>, com.vaadin.flow.component.combobox.ComboBoxBase.SpringData 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.ClientValidatedEventNested 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.LookupComponent
LookupComponent.MultiSelectLookupComponent<T>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
FieldsModifier and TypeFieldDescriptionprotected org.springframework.context.ApplicationContextprotected DataViewDelegate<EntityComboBox<V>,V> protected EntityFieldDelegate<EntityComboBox<V>,V, V> protected MetaClassFields inherited from class io.jmix.flowui.kit.component.combobox.ComboBoxPicker
actionsSupportFields inherited from interface io.jmix.flowui.component.HasRequired
PROPERTY_REQUIREDFields inherited from interface io.jmix.flowui.component.SupportsValidation
PROPERTY_ERROR_MESSAGE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.vaadin.flow.shared.RegistrationaddValidator(Validator<? super V> validator) Adds a validator to the list of validators for the component.voidprotected voidbindDataProvider(com.vaadin.flow.data.provider.DataProvider<V, ?> dataProvider) protected voidcheckValueType(V value) protected ValuePickerActionSupportprotected DataViewDelegate<EntityComboBox<V>,V> protected EntityFieldDelegate<EntityComboBox<V>,V, V> voidExecutes all registered validators against the current value of the component.Returns theMetaClassassociated with this component or entity.Returns the custom validation message to be displayed if the component is marked as required and the validation fails due to a missing value.Returns the currentValueSourceassociated with this component.booleanprotected voidonDataProviderDataRefresh(com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent<V> event) voidsetApplicationContext(org.springframework.context.ApplicationContext applicationContext) voidsetErrorMessage(String errorMessage) voidsetInvalid(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>com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<V>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>voidsetItems(CollectionContainer<V> container) Sets items from the passedCollectionContainer.voidsetItems(CollectionContainer<V> container, com.vaadin.flow.function.SerializableBiPredicate<V, String> itemFilter) Sets items from the passedCollectionContainer.voidsetItemsFetchCallback(SupportsItemsFetchCallback.FetchCallback<V, String> fetchCallback) Supply items lazily with a callback from a backend.voidsetMetaClass(MetaClass metaClass) Sets theMetaClassfor this component or entity.voidsetRequired(boolean required) Sets the required property for the component.voidsetRequiredIndicatorVisible(boolean requiredIndicatorVisible) voidsetRequiredMessage(String requiredMessage) Sets a message that will be displayed or logged when a required field or input is not provided.voidsetStatusChangeHandler(Consumer<SupportsStatusChangeHandler.StatusContext<EntityComboBox<V>>> handler) Sets a callback to be used to handle component status changes, e.g.voidvoidsetValueFromClient(V value) Sets the value of this component as if the user had set it, i.e.voidsetValueSource(ValueSource<V> valueSource) Sets aValueSourcefor this component, allowing it to bind its value to a specified data source.protected voidvalidate()Methods inherited from class io.jmix.flowui.kit.component.combobox.ComboBoxPicker
addAction, getAction, getActions, getActionsSupport, removeActionMethods inherited from class com.vaadin.flow.component.combobox.ComboBox
getEmptyValue, getI18n, getPattern, isSelected, refreshValue, setI18n, setOverlayWidth, setOverlayWidth, setPatternMethods inherited from class com.vaadin.flow.component.combobox.ComboBoxBase
addCustomValueSetListener, generateClassName, generateLabel, getAriaLabel, getAriaLabelledBy, getDataCommunicator, getDataController, getDataGenerator, getDataProvider, getDefaultValidator, getFilter, getGenericDataView, getItemClassNameGenerator, getItemLabelGenerator, getKeyMapper, getLazyDataView, getListDataView, getPageSize, getRenderManager, isAllowCustomValue, isAutofocus, isOpened, isRequired, isRequiredIndicatorVisible, onAttach, onDetach, runBeforeClientResponse, setAllowCustomValue, setAriaLabel, setAriaLabelledBy, setAutofocus, setClassNameGenerator, setDataProvider, setDataProvider, setFilter, setI18n, setItemLabelGenerator, setItems, setItems, setItems, setItems, setItems, setItems, setItemsPageable, setItemsPageable, setItemsWithFilterConverter, setItemsWithFilterConverter, setManualValidation, setOpened, setPageSize, setRendererMethods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEventMethods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, getValue, isEmpty, setModelValue, valueEqualsMethods 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndexMethods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListenerMethods inherited from interface io.jmix.flowui.kit.component.HasActions
addAction, addAction, getAction, getActions, removeAction, removeAction, removeAllActionsMethods inherited from interface com.vaadin.flow.component.shared.HasAllowedCharPattern
getAllowedCharPattern, setAllowedCharPatternMethods inherited from interface com.vaadin.flow.component.shared.HasAutoOpen
isAutoOpen, setAutoOpenMethods inherited from interface com.vaadin.flow.component.shared.HasClearButton
isClearButtonVisible, setClearButtonVisibleMethods inherited from interface com.vaadin.flow.component.shared.HasClientValidation
addClientValidatedEventListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods inherited from interface com.vaadin.flow.component.HasHelper
getHelperComponent, getHelperText, setHelperComponent, setHelperTextMethods inherited from interface com.vaadin.flow.component.HasLabel
getLabel, setLabelMethods inherited from interface com.vaadin.flow.data.provider.HasListDataView
setItemsMethods inherited from interface com.vaadin.flow.component.shared.HasOverlayClassName
getOverlayClassName, setOverlayClassNameMethods inherited from interface com.vaadin.flow.component.HasPlaceholder
getPlaceholder, setPlaceholderMethods inherited from interface com.vaadin.flow.component.shared.HasPrefix
getPrefixComponent, setPrefixComponentMethods inherited from interface io.jmix.flowui.component.HasRequired
isRequiredMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeNameMethods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant
addThemeVariants, removeThemeVariantsMethods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipTextMethods inherited from interface com.vaadin.flow.component.HasValidation
setManualValidationMethods inherited from interface com.vaadin.flow.data.binder.HasValidator
addValidationStatusChangeListenerMethods inherited from interface com.vaadin.flow.component.HasValue
addValueChangeListener, clear, getOptionalValue, getValue, isEmptyMethods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, setReadOnlyMethods inherited from interface io.jmix.flowui.data.SupportsDataProvider
getDataProvider
-
Field Details
-
applicationContext
protected org.springframework.context.ApplicationContext applicationContext -
fieldDelegate
-
dataViewDelegate
-
metaClass
-
-
Constructor Details
-
EntityComboBox
public EntityComboBox()
-
-
Method Details
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) - Specified by:
setApplicationContextin interfaceorg.springframework.context.ApplicationContextAware
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean
-
setValue
- Specified by:
setValuein interfacecom.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>, V> - Overrides:
setValuein classcom.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V, V>
-
setValueFromClient
Description copied from interface:SupportsUserActionSets the value of this component as if the user had set it, i.e.HasValue.ValueChangeEvent.isFromClient()returnstrue.- Specified by:
setValueFromClientin interfaceSupportsUserAction<V>- Overrides:
setValueFromClientin classComboBoxPicker<V>- Parameters:
value- the new value
-
checkValueType
-
isInvalid
public boolean isInvalid()- Specified by:
isInvalidin interfacecom.vaadin.flow.component.HasValidation- Specified by:
isInvalidin interfacecom.vaadin.flow.component.shared.HasValidationProperties
-
setInvalid
public void setInvalid(boolean invalid) Description copied from interface:SupportsValidationSets 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:
setInvalidin interfacecom.vaadin.flow.component.HasValidation- Specified by:
setInvalidin interfacecom.vaadin.flow.component.shared.HasValidationProperties- Specified by:
setInvalidin interfaceSupportsValidation<V>- Parameters:
invalid- whether field should be invalid
-
getErrorMessage
- Specified by:
getErrorMessagein interfacecom.vaadin.flow.component.HasValidation- Specified by:
getErrorMessagein interfacecom.vaadin.flow.component.shared.HasValidationProperties- Specified by:
getErrorMessagein interfaceSupportsValidation<V>
-
setErrorMessage
- Specified by:
setErrorMessagein interfacecom.vaadin.flow.component.HasValidation- Specified by:
setErrorMessagein interfacecom.vaadin.flow.component.shared.HasValidationProperties- Specified by:
setErrorMessagein interfaceSupportsValidation<V>
-
setStatusChangeHandler
public void setStatusChangeHandler(@Nullable Consumer<SupportsStatusChangeHandler.StatusContext<EntityComboBox<V>>> handler) Description copied from interface:SupportsStatusChangeHandlerSets a callback to be used to handle component status changes, e.g. validation messages set byHasValidation.setErrorMessage(String).- Specified by:
setStatusChangeHandlerin interfaceSupportsStatusChangeHandler<V>- Parameters:
handler- a handler to set
-
getRequiredMessage
Description copied from interface:HasRequiredReturns the custom validation message to be displayed if the component is marked as required and the validation fails due to a missing value.- Specified by:
getRequiredMessagein interfaceHasRequired- Returns:
- the required message set for the component, or
nullif no message is defined
-
setRequiredMessage
Description copied from interface:HasRequiredSets a message that will be displayed or logged when a required field or input is not provided.- Specified by:
setRequiredMessagein interfaceHasRequired- Parameters:
requiredMessage- the message to be set for required fields. Ifnull, the default message or no message will be used.
-
setRequired
public void setRequired(boolean required) Description copied from interface:HasRequiredSets the required property for the component. When a component is marked as required, it indicates that a value must be provided for the component in order to pass validation.- Specified by:
setRequiredin interfaceHasRequired- Overrides:
setRequiredin classcom.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.ComboBox<V>,V, V> - Parameters:
required- a boolean value indicating whether the component is marked as required.trueto mark the component as required,falseotherwise.
-
setRequiredIndicatorVisible
public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible) - Specified by:
setRequiredIndicatorVisiblein interfacecom.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>, V> - Specified by:
setRequiredIndicatorVisiblein interfacecom.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<V>,V>, V> - Overrides:
setRequiredIndicatorVisiblein classcom.vaadin.flow.component.combobox.ComboBox<V>
-
addValidator
Description copied from interface:SupportsValidationAdds a validator to the list of validators for the component. The provided validator will be used to validate the value of the component during validation execution.- Specified by:
addValidatorin interfaceSupportsValidation<V>- Parameters:
validator- the validator to be added; should not benull- Returns:
- a
Registrationobject that allows removing the added validator
-
executeValidators
Description copied from interface:SupportsValidationExecutes all registered validators against the current value of the component. If any of the validators fail, aValidationExceptionis thrown to indicate the failure. The exact behavior and order of validation depend on the validators added.- Specified by:
executeValidatorsin interfaceSupportsValidation<V>- Throws:
ValidationException- if validation fails for one or more validators
-
validate
protected void validate() -
getValueSource
Description copied from interface:SupportsValueSourceReturns the currentValueSourceassociated with this component.- Specified by:
getValueSourcein interfaceSupportsValueSource<V>- Returns:
- the associated
ValueSource, ornullif no value source is set
-
setValueSource
Description copied from interface:SupportsValueSourceSets aValueSourcefor this component, allowing it to bind its value to a specified data source.- Specified by:
setValueSourcein interfaceSupportsValueSource<V>- Parameters:
valueSource- theValueSourceto be associated with this component, ornullto remove the current association
-
setItems
Description copied from interface:SupportsItemsContainerSets items from the passedCollectionContainer.- Specified by:
setItemsin interfaceSupportsItemsContainer<V>- Parameters:
container- aCollectionContainerto be used as items source- See Also:
-
setItems
public void setItems(CollectionContainer<V> container, com.vaadin.flow.function.SerializableBiPredicate<V, String> itemFilter) Description copied from interface:SupportsFilterableItemsContainerSets items from the passedCollectionContainer.- Specified by:
setItemsin interfaceSupportsFilterableItemsContainer<V>- Parameters:
container- aCollectionContainerto be used as items sourceitemFilter- a filter to check if an item is shown when user typed some text into the field- See Also:
-
setItems
-
setItems
-
setItems
-
setItems
-
setItems
-
bindDataProvider
protected void bindDataProvider(@Nullable com.vaadin.flow.data.provider.DataProvider<V, ?> dataProvider) -
setItemsFetchCallback
Description copied from interface:SupportsItemsFetchCallbackSupply items lazily with a callback from a backend.- Specified by:
setItemsFetchCallbackin interfaceSupportsItemsFetchCallback<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
-
getMetaClass
Description copied from interface:SupportsMetaClassReturns theMetaClassassociated with this component or entity.- Specified by:
getMetaClassin interfaceSupportsMetaClass- Returns:
- the
MetaClassobject, ornullif no MetaClass is associated
-
setMetaClass
Description copied from interface:SupportsMetaClassSets theMetaClassfor this component or entity.- Specified by:
setMetaClassin interfaceSupportsMetaClass- Parameters:
metaClass- theMetaClassto associate with this component or entity, ornullto disassociate any currently set MetaClass
-
getSelectedItems
- Specified by:
getSelectedItemsin interfaceLookupComponent<V>- Returns:
- items selected in this lookup component
-
createFieldDelegate
-
createDataViewDelegate
-
createActionsSupport
- Overrides:
createActionsSupportin classComboBoxPicker<V>
-
onDataProviderDataRefresh
protected void onDataProviderDataRefresh(com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent<V> event)
-