io.jmix.ui.component

Interface EntityPicker<V>

All Superinterfaces:

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

All Known Subinterfaces:

EntityComboBox<V>, EntitySuggestionField<V>

All Known Implementing Classes:

EntityComboBoxImpl, EntityPickerImpl, EntitySuggestionFieldImpl

@StudioComponent(caption="EntityPicker",
                 category="Components",
                 xmlElement="entityPicker",
                 icon="io/jmix/ui/icon/component/entityPicker.svg",
                 canvasBehaviour=VALUE_PICKER,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/entity-picker.html")
public interface EntityPicker<V>
extends ValuePicker<V>, LookupComponent<V>

Generic UI component designed to select and display an entity instance. Consists of the text field and the set of buttons defined by actions.

See Also:

EntityComboBox

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	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.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
io.jmix.core.metamodel.model.MetaClass	getMetaClass()
static <T> org.springframework.core.ParameterizedTypeReference<EntityPicker<T>>	of(java.lang.Class<T> valueClass)
void	setMetaClass(io.jmix.core.metamodel.model.MetaClass metaClass)

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.Component.HasCaption

getCaption, setCaption

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

getDescription, setDescription

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<EntityPicker<T>> of(java.lang.Class<T> valueClass)

Specified by:

of in interface ValuePicker<V>

getMetaClass

@Nullable
io.jmix.core.metamodel.model.MetaClass getMetaClass()

setMetaClass

@StudioProperty(name="metaClass",
                type=ENTITY_NAME,
                typeParameter="V")
void setMetaClass(@Nullable
                                                                                                                         io.jmix.core.metamodel.model.MetaClass metaClass)