com.haulmont.cuba.gui.components

Interface ListEditor<V>

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<java.util.List<V>>, Field<java.util.List<V>>, HasCaptionMode, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasOptionCaptionProvider<V>, HasValue<java.util.List<V>>, HasValueSource<java.util.List<V>>, OptionsField<java.util.List<V>,V>, Validatable

public interface ListEditor<V>
extends OptionsField<java.util.List<V>,V>, 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 class	ListEditor.ItemType

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<ListEditor.EditorCloseEvent> listener) Adds a listener that invoked after editor window closing.
void	addListItemValidator(java.util.function.Consumer<? super V> validator)
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() Deprecated. if you want to use enums as options for field, use OptionsField.setOptions(Options)
ListEditor.ItemType	getItemType()
java.util.Collection<java.util.function.Consumer<? super V>>	getListItemValidators()
java.lang.String	getLookupScreen()
java.util.TimeZone	getTimeZone()
boolean	isClearButtonVisible()
boolean	isDisplayValuesFieldEditable()
boolean	isUseLookupField()
void	removeEditorCloseListener(java.util.function.Consumer<ListEditor.EditorCloseEvent> listener) Deprecated.
void	setClearButtonVisible(boolean visible)
void	setDisplayValuesFieldEditable(boolean displayValuesFieldEditable) Makes the field that displays the value editable.
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) Deprecated. use OptionsField.setOptions(Options)
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	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.OptionsField

getOptions, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setOptions, setOptionsDatasource, setOptionsEnum, setOptionsList, setOptionsMap

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, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

getOptionCaptionProvider, setOptionCaptionProvider

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

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

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

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

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

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

Deprecated. if you want to use enums as options for field, use OptionsField.setOptions(Options)

Returns:

enum class if it's set

See Also:

EnumOptions

setEnumClass

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

Deprecated. use OptionsField.setOptions(Options)

See Also:

EnumOptions

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

Subscription addEditorCloseListener(java.util.function.Consumer<ListEditor.EditorCloseEvent> listener)

Adds a listener that invoked after editor window closing.

Parameters:

listener - listener instance

removeEditorCloseListener

@Deprecated
void removeEditorCloseListener(java.util.function.Consumer<ListEditor.EditorCloseEvent> listener)

Deprecated.

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()

isDisplayValuesFieldEditable

boolean isDisplayValuesFieldEditable()

setDisplayValuesFieldEditable

void setDisplayValuesFieldEditable(boolean displayValuesFieldEditable)

Makes the field that displays the value editable. This allows to enter values not only using the ListEditorPopupWindow where values are added one by one, but directly entering the comma-separated values list.

addListItemValidator

void addListItemValidator(java.util.function.Consumer<? super V> validator)

Parameters:

validator - validator for the child component

getListItemValidators

java.util.Collection<java.util.function.Consumer<? super V>> getListItemValidators()

setItemType

void setItemType(ListEditor.ItemType itemType)

Sets the type of elements of editable collection

getItemType

ListEditor.ItemType getItemType()