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 and Description
static class	EntityLinkField.EditorCloseEvent<V> Describes editor close event.

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

Field Summary

Fields

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

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.common.event.Subscription	addEditorCloseListener(java.util.function.Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener) Adds editor close listener.
java.util.function.Consumer<EntityLinkField>	getCustomClickHandler()
io.jmix.core.metamodel.model.MetaClass	getMetaClass()
OpenMode	getOpenMode()
ListComponent	getOwner()
java.lang.String	getScreen()
java.util.Map<java.lang.String,java.lang.Object>	getScreenParams()
void	setCustomClickHandler(java.util.function.Consumer<EntityLinkField> clickHandler) Sets a custom click handler to the field.
void	setMetaClass(io.jmix.core.metamodel.model.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(java.lang.String screen) Sets an editor screen id.
void	setScreenParams(java.util.Map<java.lang.String,java.lang.Object> params)

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getScreen

@Nullable
java.lang.String getScreen()

Returns:

an editor screen id

setScreen

void setScreen(@Nullable
               java.lang.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
java.util.Map<java.lang.String,java.lang.Object> getScreenParams()

setScreenParams

void setScreenParams(@Nullable
                     java.util.Map<java.lang.String,java.lang.Object> params)

addEditorCloseListener

io.jmix.core.common.event.Subscription addEditorCloseListener(java.util.function.Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener)

Adds editor close listener.

Parameters:

editorCloseListener - a listener to set

Returns:

subscription

getCustomClickHandler

@Nullable
java.util.function.Consumer<EntityLinkField> getCustomClickHandler()

Returns:

click handler

setCustomClickHandler

void setCustomClickHandler(@Nullable
                           java.util.function.Consumer<EntityLinkField> clickHandler)

Sets a custom click handler to the field.

Parameters:

clickHandler - click handler

getMetaClass

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

Returns:

a field meta class

setMetaClass

void setMetaClass(@Nullable
                  io.jmix.core.metamodel.model.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