io.jmix.ui.component

Interface EntitySuggestionField<V>

Type Parameters:

V - type of value

All Superinterfaces:

ActionsHolder, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, EntityPicker<V>, Field<V>, HasContextHelp, HasEnterPressHandler, HasFormatter<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasOptionStyleProvider<V>, HasSubParts, HasValidator<V>, HasValue<V>, HasValueSource<V>, LookupComponent<V>, Requirable, SuggestionField<V>, SuggestionFieldComponent<V,V>, SupportsUserAction<V>, Validatable, ValuePicker<V>

All Known Implementing Classes:

EntitySuggestionFieldImpl

@StudioComponent(caption="EntitySuggestionField",
                 category="Components",
                 xmlElement="entitySuggestionField",
                 icon="io/jmix/ui/icon/component/entitySuggestionField.svg",
                 canvasBehaviour=VALUE_PICKER,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/entity-suggestion-field.html",
                 unsupportedProperties={"buffered","fieldEditable"})
public interface EntitySuggestionField<V>
extends SuggestionField<V>, EntityPicker<V>

EntitySuggestionField adds to EntityPicker the ability to search an entity by user input.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.SuggestionFieldComponent

SuggestionFieldComponent.ArrowDownEvent, SuggestionFieldComponent.ParametrizedSearchExecutor<E>, SuggestionFieldComponent.SearchExecutor<E>

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasEnterPressHandler

HasEnterPressHandler.EnterPressEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.EntityPicker

EntityPicker.EntityPickerAction

Nested classes/interfaces inherited from interface io.jmix.ui.component.ValuePicker

ValuePicker.FieldValueChangeEvent<V>, ValuePicker.ValuePickerAction

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent

LookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.SuggestionFieldComponent

POPUP_AUTO_WIDTH, POPUP_PARENT_WIDTH

Fields inherited from interface io.jmix.ui.component.ValuePicker

TYPE_STRING

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
static <T> org.springframework.core.ParameterizedTypeReference<EntitySuggestionField<T>>	of(java.lang.Class<T> valueClass)
void	setSearchExecutor(SuggestionFieldComponent.SearchExecutor<V> searchExecutor) Sets SuggestionFieldComponent.SearchExecutor which performs search.

Methods inherited from interface io.jmix.ui.component.SuggestionFieldComponent

getArrowDownHandler, getAsyncSearchDelayMs, getMinSearchStringLength, getPopupWidth, getSearchExecutor, getSuggestionsLimit, setArrowDownHandler, setAsyncSearchDelayMs, setMinSearchStringLength, setPopupWidth, setSuggestionsLimit, showSuggestions

Methods inherited from interface io.jmix.ui.component.HasInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface io.jmix.ui.component.HasOptionStyleProvider

getOptionStyleProvider, setOptionStyleProvider

Methods inherited from interface io.jmix.ui.component.HasEnterPressHandler

getEnterPressHandler, setEnterPressHandler

Methods inherited from interface io.jmix.ui.component.EntityPicker

getMetaClass, setMetaClass

Methods inherited from interface io.jmix.ui.component.ValuePicker

addFieldValueChangeListener, getFieldIconProvider, isFieldEditable, setFieldEditable, setFieldIconProvider

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.HasFormatter

getFormatter, setFormatter

Methods inherited from interface io.jmix.ui.component.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

Methods inherited from interface io.jmix.ui.component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.SupportsUserAction

setValueFromUser

Methods inherited from interface io.jmix.ui.component.LookupComponent

getLookupSelectedItems, setLookupSelectHandler

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

of

static <T> org.springframework.core.ParameterizedTypeReference<EntitySuggestionField<T>> of(java.lang.Class<T> valueClass)

Specified by:

of in interface EntityPicker<V>

Specified by:

of in interface SuggestionField<V>

Specified by:

of in interface ValuePicker<V>

setSearchExecutor

void setSearchExecutor(@Nullable
                       SuggestionFieldComponent.SearchExecutor<V> searchExecutor)

Description copied from interface: SuggestionFieldComponent

Sets SuggestionFieldComponent.SearchExecutor which performs search.

Specified by:

setSearchExecutor in interface SuggestionFieldComponent<V,V>

Parameters:

searchExecutor - SearchExecutor instance