com.haulmont.cuba.gui.components

Interface EntityLinkField<V>

All Superinterfaces:

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

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.
static interface	EntityLinkField.EntityLinkClickHandler
static interface	EntityLinkField.ScreenCloseListener Deprecated. Use addEditorCloseListener(Consumer).

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
Subscription	addEditorCloseListener(java.util.function.Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener) Adds editor close listener.
EntityLinkField.EntityLinkClickHandler	getCustomClickHandler()
MetaClass	getMetaClass()
OpenMode	getOpenMode()
ListComponent	getOwner()
java.lang.String	getScreen()
EntityLinkField.ScreenCloseListener	getScreenCloseListener() Deprecated. Use Subscription instead to unsubscribe.
WindowManager.OpenType	getScreenOpenType() Deprecated. Use getOpenMode() instead.
java.util.Map<java.lang.String,java.lang.Object>	getScreenParams()
void	setCustomClickHandler(EntityLinkField.EntityLinkClickHandler clickHandler)
void	setMetaClass(MetaClass metaClass)
void	setOpenMode(OpenMode openMode) Sets open mode for editor screen.
void	setOwner(ListComponent owner)
void	setScreen(java.lang.String screen)
void	setScreenCloseListener(EntityLinkField.ScreenCloseListener closeListener) Deprecated. Use addEditorCloseListener(Consumer) instead.
void	setScreenOpenType(WindowManager.OpenType openType) Deprecated. Use setOpenMode(OpenMode) instead.
void	setScreenParams(java.util.Map<java.lang.String,java.lang.Object> params)

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.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()

setScreen

void setScreen(@Nullable
               java.lang.String screen)

getScreenOpenType

@Deprecated
WindowManager.OpenType getScreenOpenType()

Deprecated. Use getOpenMode() instead.

Returns:

open type

setScreenOpenType

@Deprecated
void setScreenOpenType(WindowManager.OpenType openType)

Deprecated. Use setOpenMode(OpenMode) instead.

Parameters:

openType - open type

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)

getScreenCloseListener

@Deprecated
 @Nullable
EntityLinkField.ScreenCloseListener getScreenCloseListener()

Deprecated. Use Subscription instead to unsubscribe.

Returns:

ScreenCloseListener or null if not set

setScreenCloseListener

@Deprecated
void setScreenCloseListener(@Nullable
                                        EntityLinkField.ScreenCloseListener closeListener)

Deprecated. Use addEditorCloseListener(Consumer) instead.

Sets listener to handle close window event. Note, if screen extends Screen the window parameter will be null.

Parameters:

closeListener - a listener to set

addEditorCloseListener

Subscription addEditorCloseListener(java.util.function.Consumer<EntityLinkField.EditorCloseEvent> editorCloseListener)

Adds editor close listener.

Parameters:

editorCloseListener - a listener to set

Returns:

subscription

getCustomClickHandler

@Nullable
EntityLinkField.EntityLinkClickHandler getCustomClickHandler()

setCustomClickHandler

void setCustomClickHandler(@Nullable
                           EntityLinkField.EntityLinkClickHandler clickHandler)

getMetaClass

MetaClass getMetaClass()

setMetaClass

void setMetaClass(MetaClass metaClass)

getOwner

ListComponent getOwner()

setOwner

void setOwner(ListComponent owner)