Package io.jmix.ui.component.impl

Class EntityPickerImpl<V>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixPickerField<V>,V,V>

io.jmix.ui.component.impl.ValuePickerImpl<V>

io.jmix.ui.component.impl.EntityPickerImpl<V>

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<V>, EntityPicker<V>, Field<V>, HasContextHelp, HasDebugId, HasFormatter<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasSubParts, HasValidator<V>, HasValue<V>, LookupComponent<V>, Requirable, SecuredActionsHolder, SupportsUserAction<V>, Validatable, ValuePicker<V>, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

EntityComboBoxImpl, EntitySuggestionFieldImpl

public class EntityPickerImpl<V>
extends ValuePickerImpl<V>
implements EntityPicker<V>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.impl.ValuePickerImpl

ValuePickerImpl.WebValuePickerActionHandler

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.EntityPicker

EntityPicker.EntityPickerAction

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

HasContextHelp.ContextHelpIconClickEvent

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

HasValue.ValueChangeEvent<V>

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

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

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

ValuePicker.FieldValueChangeEvent<V>, ValuePicker.ValuePickerAction

Field Summary

Fields

Modifier and Type	Field	Description
protected MetaClass	metaClass
protected Metadata	metadata

Fields inherited from class io.jmix.ui.component.impl.ValuePickerImpl

actionButtons, actionHandler, actionPropertyChangeListener, actions, actionsPermissions, fieldIconProvider, fieldListenerRegistration, formatter, metadataTools

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

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

NAME, TYPE_STRING

Constructor Summary

Constructors

Constructor	Description
EntityPickerImpl()

Method Summary

Modifier and Type	Method	Description
protected void	checkValueType(V value)
protected JmixPickerField<V>	createComponent()
Collection<V>	getLookupSelectedItems()
MetaClass	getMetaClass()
void	setLookupSelectHandler(Consumer<Collection<V>> selectHandler)
void	setMetaClass(MetaClass metaClass)
void	setMetadata(Metadata metadata)
void	setValue(V value)
void	setValueFromUser(V value)	Sets the value of this component as if the user had set it.

Methods inherited from class io.jmix.ui.component.impl.ValuePickerImpl

actionPropertyChanged, addAction, addAction, addFieldValueChangeListener, afterPropertiesSet, applyDefaultValueFormat, commit, discard, focus, formatValue, generateOptionIcon, getAction, getActions, getActionsPermissions, getFieldIconProvider, getFormatter, getInputPrompt, getTabIndex, initComponent, isBuffered, isFieldEditable, isModified, onFieldValueChange, refreshActionsState, removeAction, removeAction, removeAllActions, setBuffered, setButtonIcon, setDebugId, setEditableToComponent, setFieldEditable, setFieldIconProvider, setFormatter, setFrame, setInputPrompt, setMetadataTools, setTabIndex, setUiComponentProperties, setupButtonAction

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getDefaultRequiredMessage, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, componentValueChanged, convertToModel, convertToPresentation, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

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

getFrame, setFrame

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

isEditable, isEditableWithParent, setEditable

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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.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.HasFormatter

getFormatter, setFormatter

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.HasInputPrompt

getInputPrompt, setInputPrompt

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

addValidator, addValidators, getValidators, removeValidator

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty

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

getValueSource, setValueSource

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

getRequiredMessage, isRequired, setRequired, setRequiredMessage

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

isValid, isValidateOnCommit, validate

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

addFieldValueChangeListener, getFieldIconProvider, isFieldEditable, setFieldEditable, setFieldIconProvider

Field Details

metadata

protected Metadata metadata

metaClass

protected MetaClass metaClass

Constructor Details

EntityPickerImpl

public EntityPickerImpl()

Method Details

createComponent

protected JmixPickerField<V> createComponent()

Overrides:

createComponent in class ValuePickerImpl<V>

setValue

public void setValue(@Nullable
 V value)

Specified by:

setValue in interface HasValue<V>

Overrides:

setValue in class ValuePickerImpl<V>

setValueFromUser

public void setValueFromUser(@Nullable
 V value)

Description copied from interface: SupportsUserAction

Sets the value of this component as if the user had set it. The user originated attribute is only used for the HasValue.ValueChangeEvent.

Specified by:

setValueFromUser in interface SupportsUserAction<V>

Overrides:

setValueFromUser in class ValuePickerImpl<V>

Parameters:

value - the new value

checkValueType

protected void checkValueType(@Nullable
 V value)

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

getMetaClass

@Nullable
public MetaClass getMetaClass()

Specified by:

getMetaClass in interface EntityPicker<V>

setMetaClass

public void setMetaClass(@Nullable
 MetaClass metaClass)

Specified by:

setMetaClass in interface EntityPicker<V>

setLookupSelectHandler

public void setLookupSelectHandler(Consumer<Collection<V>> selectHandler)

Specified by:

setLookupSelectHandler in interface LookupComponent<V>

Parameters:

selectHandler - handler that should be executed when a user select an item in the lookup screen

getLookupSelectedItems

public Collection<V> getLookupSelectedItems()

Specified by:

getLookupSelectedItems in interface LookupComponent<V>

Returns:

items selected in lookup component