Package io.jmix.ui.component.impl

Class EntityLinkFieldImpl<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<JmixButtonField<V>,V,V>

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

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<V>, EntityLinkField<V>, Field<V>, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<V>, HasValue<V>, Requirable, Validatable, org.springframework.beans.factory.InitializingBean

public class EntityLinkFieldImpl<V>
extends AbstractField<JmixButtonField<V>,V,V>
implements EntityLinkField<V>, org.springframework.beans.factory.InitializingBean

Nested Class Summary

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

EntityLinkField.EditorCloseEvent<V>

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>

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<EntityLinkField>	clickHandler
protected Subscription	closeListenerSubscription
protected DatatypeRegistry	datatypeRegistry
protected static final String	EMPTY_VALUE_STYLENAME
protected Messages	messages
protected MetaClass	metaClass
protected Metadata	metadata
protected MetadataTools	metadataTools
protected ListComponent	owner
protected String	screen
protected ScreenBuilders	screenBuilders
protected OpenMode	screenOpenMode
protected Map<String,Object>	screenParams
protected WindowConfig	windowConfig

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

NAME

Constructor Summary

Constructors

Constructor	Description
EntityLinkFieldImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addEditorCloseListener(Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener)	Adds editor close listener.
protected void	afterCommitOpenedEntity(Object item)
void	afterPropertiesSet()
protected JmixButtonField<V>	createComponent()
protected void	fireEditorCloseEvent(EditorScreen editorScreen, String closeActionId)
void	focus()	Sets focus to this component
protected CollectionContainer	getCollectionContainerFromOwner()
Consumer<EntityLinkField>	getCustomClickHandler()
MetaClass	getMetaClass()
protected MetaProperty	getMetaPropertyForEditedValue()
OpenMode	getOpenMode()
ListComponent	getOwner()
String	getScreen()
Map<String,Object>	getScreenParams()
String	getStyleName()	Styles implementation is client-type-specific.
int	getTabIndex()	Gets the tabulator index of the HasTabIndex component.
protected void	initComponent()
protected void	openEntityEditor()
void	setCustomClickHandler(Consumer<EntityLinkField> clickHandler)	Sets a custom click handler to the field.
void	setDatatypeRegistry(DatatypeRegistry datatypeRegistry)
void	setMessages(Messages messages)
void	setMetaClass(MetaClass metaClass)	Sets field meta class.
void	setMetadata(Metadata metadata)
void	setMetadataTools(MetadataTools metadataTools)
void	setOpenMode(OpenMode openMode)	Sets open mode for editor screen.
void	setOwner(ListComponent owner)	Sets an owner list component ListComponent to the field.
void	setScreen(String screen)	Sets an editor screen id.
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setScreenParams(Map<String,Object> screenParams)
void	setTabIndex(int tabIndex)	Sets the tabulator index of the Focusable component.
void	setValue(V value)
protected void	setValueSilently(V item)	Sets value to the component without triggering change listeners for ContainerValueSource.
void	setWindowConfig(WindowConfig windowConfig)

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

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

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

addValueChangeListener, commit, componentValueChanged, convertToModel, convertToPresentation, discard, fieldValueEquals, getValue, getValueSource, isBuffered, isModified, setBuffered, 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, 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, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, 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.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, 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

isFocusable, setFocusable

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

Field Details

EMPTY_VALUE_STYLENAME

protected static final String EMPTY_VALUE_STYLENAME

See Also:

• Constant Field Values

clickHandler

protected Consumer<EntityLinkField> clickHandler

screen

protected String screen

screenOpenMode

protected OpenMode screenOpenMode

screenParams

protected Map<String,Object> screenParams

metaClass

protected MetaClass metaClass

owner

protected ListComponent owner

closeListenerSubscription

protected Subscription closeListenerSubscription

metadata

protected Metadata metadata

metadataTools

protected MetadataTools metadataTools

screenBuilders

protected ScreenBuilders screenBuilders

datatypeRegistry

protected DatatypeRegistry datatypeRegistry

messages

protected Messages messages

windowConfig

protected WindowConfig windowConfig

Constructor Details

EntityLinkFieldImpl

public EntityLinkFieldImpl()

Method Details

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

setMetadataTools

@Autowired
public void setMetadataTools(MetadataTools metadataTools)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setDatatypeRegistry

@Autowired
public void setDatatypeRegistry(DatatypeRegistry datatypeRegistry)

setMessages

@Autowired
public void setMessages(Messages messages)

setWindowConfig

@Autowired
public void setWindowConfig(WindowConfig windowConfig)

createComponent

protected JmixButtonField<V> createComponent()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

initComponent

protected void initComponent()

getMetaClass

@Nullable
public MetaClass getMetaClass()

Specified by:

getMetaClass in interface EntityLinkField<V>

Returns:

a field meta class

setMetaClass

public void setMetaClass(@Nullable
 MetaClass metaClass)

Description copied from interface: EntityLinkField

Sets field meta class.

Specified by:

setMetaClass in interface EntityLinkField<V>

Parameters:

metaClass - a field meta class

getOwner

@Nullable
public ListComponent getOwner()

Specified by:

getOwner in interface EntityLinkField<V>

Returns:

owner list component

setOwner

public void setOwner(ListComponent owner)

Description copied from interface: EntityLinkField

Sets an owner list component ListComponent to the field.

Specified by:

setOwner in interface EntityLinkField<V>

Parameters:

owner - owner list component

setValue

public void setValue(@Nullable
 V value)

Specified by:

setValue in interface HasValue<V>

Overrides:

setValue in class AbstractValueComponent<JmixButtonField<V>,V,V>

getStyleName

public String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Overrides:

getStyleName in class AbstractComponent<JmixButtonField<V>>

Returns:

current style name.

getScreen

public String getScreen()

Specified by:

getScreen in interface EntityLinkField<V>

Returns:

an editor screen id

setScreen

public void setScreen(String screen)

Description copied from interface: EntityLinkField

Sets an editor screen id.

Specified by:

setScreen in interface EntityLinkField<V>

Parameters:

screen - an editor screen id

getCustomClickHandler

@Nullable
public Consumer<EntityLinkField> getCustomClickHandler()

Specified by:

getCustomClickHandler in interface EntityLinkField<V>

Returns:

click handler

setCustomClickHandler

public void setCustomClickHandler(@Nullable
 Consumer<EntityLinkField> clickHandler)

Description copied from interface: EntityLinkField

Sets a custom click handler to the field.

Specified by:

setCustomClickHandler in interface EntityLinkField<V>

Parameters:

clickHandler - click handler

getOpenMode

public OpenMode getOpenMode()

Specified by:

getOpenMode in interface EntityLinkField<V>

Returns:

open mode for editor screen

setOpenMode

public void setOpenMode(OpenMode openMode)

Description copied from interface: EntityLinkField

Sets open mode for editor screen.

Specified by:

setOpenMode in interface EntityLinkField<V>

Parameters:

openMode - open mode

getScreenParams

@Nullable
public Map<String,Object> getScreenParams()

Specified by:

getScreenParams in interface EntityLinkField<V>

setScreenParams

public void setScreenParams(@Nullable
 Map<String,Object> screenParams)

Specified by:

setScreenParams in interface EntityLinkField<V>

addEditorCloseListener

public Subscription addEditorCloseListener(Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener)

Description copied from interface: EntityLinkField

Adds editor close listener.

Specified by:

addEditorCloseListener in interface EntityLinkField<V>

Parameters:

editorCloseListener - a listener to set

Returns:

subscription

openEntityEditor

protected void openEntityEditor()

fireEditorCloseEvent

protected void fireEditorCloseEvent(@Nullable
 EditorScreen editorScreen,
 String closeActionId)

afterCommitOpenedEntity

protected void afterCommitOpenedEntity(Object item)

getCollectionContainerFromOwner

@Nullable
protected CollectionContainer getCollectionContainerFromOwner()

getMetaPropertyForEditedValue

@Nullable
protected MetaProperty getMetaPropertyForEditedValue()

setValueSilently

protected void setValueSilently(@Nullable
 V item)

Sets value to the component without triggering change listeners for ContainerValueSource.

Parameters:

item - value

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index