com.haulmont.cuba.gui.components

Interface ListEditor

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent, Field

public interface ListEditor
extends Field, Component.Focusable

The component is used for displaying and editing a collection of values. WARNING: for internal use only!

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListEditor.EditorCloseEvent
static interface	ListEditor.EditorCloseListener Listener that will be notified when editor window is closed.
static class	ListEditor.ItemType

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

Field.Validator

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addEditorCloseListener(ListEditor.EditorCloseListener listener) Adds ListEditor.EditorCloseListener that invoked after editor window closing.
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	getEditorParamsSupplier()
java.lang.String	getEditorWindowId()
java.lang.String	getEntityJoinClause()
java.lang.String	getEntityName()
java.lang.String	getEntityWhereClause()
java.lang.Class<? extends java.lang.Enum>	getEnumClass()
ListEditor.ItemType	getItemType()
java.lang.String	getLookupScreen()
java.util.List<?>	getOptionsList()
java.util.Map<java.lang.String,java.lang.Object>	getOptionsMap()
java.util.TimeZone	getTimeZone()
boolean	isClearButtonVisible()
boolean	isUseLookupField()
void	removeEditorCloseListener(ListEditor.EditorCloseListener listener)
void	setClearButtonVisible(boolean visible)
void	setEditorParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> paramsSupplier)
void	setEditorWindowId(java.lang.String windowId) Sets the window id of editor screen
void	setEntityJoinClause(java.lang.String entityJoinClause)
void	setEntityName(java.lang.String entityName) Sets the entity name.
void	setEntityWhereClause(java.lang.String entityWhereClause)
void	setEnumClass(java.lang.Class<? extends java.lang.Enum> enumClass)
void	setItemType(ListEditor.ItemType itemType) Sets the type of elements of editable collection
void	setLookupScreen(java.lang.String lookupScreen) Sets the entity lookup screen ID
void	setOptionsList(java.util.List<?> optionsList) Set the list of available collection items values
void	setOptionsMap(java.util.Map<java.lang.String,java.lang.Object> optionsMap)
void	setTimeZone(java.util.TimeZone timeZone)
void	setUseLookupField(boolean useLookupField) Sets whether a lookup field must be used for selecting an entity.

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

addValidator, 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.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

isUseLookupField

boolean isUseLookupField()

setUseLookupField

void setUseLookupField(boolean useLookupField)

Sets whether a lookup field must be used for selecting an entity. PickerField is used by default.

getLookupScreen

java.lang.String getLookupScreen()

setLookupScreen

void setLookupScreen(java.lang.String lookupScreen)

Sets the entity lookup screen ID

getEntityName

java.lang.String getEntityName()

setEntityName

void setEntityName(java.lang.String entityName)

Sets the entity name. Edited collection must be of this entity type

getOptionsList

java.util.List<?> getOptionsList()

setOptionsList

void setOptionsList(java.util.List<?> optionsList)

Set the list of available collection items values

getOptionsMap

java.util.Map<java.lang.String,java.lang.Object> getOptionsMap()

setOptionsMap

void setOptionsMap(java.util.Map<java.lang.String,java.lang.Object> optionsMap)

getEntityJoinClause

java.lang.String getEntityJoinClause()

setEntityJoinClause

void setEntityJoinClause(java.lang.String entityJoinClause)

getEntityWhereClause

java.lang.String getEntityWhereClause()

setEntityWhereClause

void setEntityWhereClause(java.lang.String entityWhereClause)

getEnumClass

java.lang.Class<? extends java.lang.Enum> getEnumClass()

setEnumClass

void setEnumClass(java.lang.Class<? extends java.lang.Enum> enumClass)

setClearButtonVisible

void setClearButtonVisible(boolean visible)

isClearButtonVisible

boolean isClearButtonVisible()

setEditorWindowId

void setEditorWindowId(java.lang.String windowId)

Sets the window id of editor screen

Parameters:

windowId - alias of screen in the app-screens.xml

getEditorWindowId

java.lang.String getEditorWindowId()

Returns:

window id of editor screen

addEditorCloseListener

void addEditorCloseListener(ListEditor.EditorCloseListener listener)

Adds ListEditor.EditorCloseListener that invoked after editor window closing.

Parameters:

listener - listener instance

removeEditorCloseListener

void removeEditorCloseListener(ListEditor.EditorCloseListener listener)

Parameters:

listener - listener to be removed

setEditorParamsSupplier

void setEditorParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> paramsSupplier)

Parameters:

paramsSupplier - additional params map for editor screen.

getEditorParamsSupplier

java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> getEditorParamsSupplier()

setTimeZone

void setTimeZone(java.util.TimeZone timeZone)

Parameters:

timeZone - - for DateTime fields and date formatting

getTimeZone

java.util.TimeZone getTimeZone()

setItemType

void setItemType(ListEditor.ItemType itemType)

Sets the type of elements of editable collection

getItemType

ListEditor.ItemType getItemType()