Package io.jmix.ui.component

Interface EntityLinkField<V>

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<V>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<V>, HasValue<V>, HasValueSource<V>, Requirable, Validatable

All Known Implementing Classes:

EntityLinkFieldImpl

public interface EntityLinkField<V>
extends Field<V>, Component.Focusable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EntityLinkField.EditorCloseEvent<V>	Describes editor close event.

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

HasValue.ValueChangeEvent<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
Subscription	addEditorCloseListener(Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener)	Adds editor close listener.
Consumer<EntityLinkField>	getCustomClickHandler()
MetaClass	getMetaClass()
OpenMode	getOpenMode()
ListComponent	getOwner()
String	getScreen()
Map<String,Object>	getScreenParams()
void	setCustomClickHandler(Consumer<EntityLinkField> clickHandler)	Sets a custom click handler to the field.
void	setMetaClass(MetaClass metaClass)	Sets field meta class.
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	setScreenParams(Map<String,Object> params)

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

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

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getScreen

@Nullable
String getScreen()

Returns:

an editor screen id

setScreen

void setScreen(@Nullable
 String screen)

Sets an editor screen id.

Parameters:

screen - an editor screen id

getOpenMode

OpenMode getOpenMode()

Returns:

open mode for editor screen

setOpenMode

void setOpenMode(OpenMode openMode)

Sets open mode for editor screen.

Parameters:

openMode - open mode

getScreenParams

@Nullable
Map<String,Object> getScreenParams()

setScreenParams

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

addEditorCloseListener

Subscription addEditorCloseListener(Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener)

Adds editor close listener.

Parameters:

editorCloseListener - a listener to set

Returns:

subscription

getCustomClickHandler

@Nullable
Consumer<EntityLinkField> getCustomClickHandler()

Returns:

click handler

setCustomClickHandler

void setCustomClickHandler(@Nullable
 Consumer<EntityLinkField> clickHandler)

Sets a custom click handler to the field.

Parameters:

clickHandler - click handler

getMetaClass

@Nullable
MetaClass getMetaClass()

Returns:

a field meta class

setMetaClass

void setMetaClass(@Nullable
 MetaClass metaClass)

Sets field meta class.

Parameters:

metaClass - a field meta class

getOwner

@Nullable
ListComponent getOwner()

Returns:

owner list component

setOwner

void setOwner(ListComponent owner)

Sets an owner list component ListComponent to the field.

Parameters:

owner - owner list component