com.haulmont.cuba.gui.components

Interface OptionsField<V,I>

Type Parameters:

V - type of value

I - type of option items

All Superinterfaces:

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

All Known Subinterfaces:

CheckBoxGroup<I>, ListEditor<V>, LookupField<V>, LookupPickerField<V>, OptionsGroup<V,I>, OptionsList<V,I>, RadioButtonGroup<I>, SearchField<V>, SearchPickerField<V>, TwinColumn<V>

public interface OptionsField<V,I>
extends Field<V>, HasOptionCaptionProvider<I>, HasCaptionMode

UI component having options.

Nested Class Summary

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 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
Options<I>	getOptions()
default CollectionDatasource	getOptionsDatasource() Deprecated. Use getOptions() instead.
default java.lang.Class<? extends EnumClass>	getOptionsEnum() Deprecated. Use getOptions() instead.
default java.util.List	getOptionsList() Deprecated. Use getOptions() instead.
default java.util.Map<java.lang.String,?>	getOptionsMap() Deprecated. Use getOptions() instead.
void	setOptions(Options<I> options) Sets options for UI component.
default void	setOptionsDatasource(CollectionDatasource datasource) Deprecated. set options using setOptions(Options) with DatasourceOptions.
default void	setOptionsEnum(java.lang.Class<I> optionsEnum) Sets options from the passed enum class.
default void	setOptionsList(java.util.List<I> optionsList) Sets options from the passed list.
default void	setOptionsMap(java.util.Map<java.lang.String,I> map) Sets options from the passed map and automatically applies option caption provider based on map keys.

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

getOptionCaptionProvider, setOptionCaptionProvider

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

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

Method Detail

setOptions

void setOptions(Options<I> options)

Sets options for UI component.

Parameters:

options - options

See Also:

ListOptions

getOptions

Options<I> getOptions()

Returns:

options object

setOptionsList

default void setOptionsList(java.util.List<I> optionsList)

Sets options from the passed list.

Parameters:

optionsList - options

See Also:

ListOptions.of(Object, Object[])

setOptionsMap

default void setOptionsMap(java.util.Map<java.lang.String,I> map)

Sets options from the passed map and automatically applies option caption provider based on map keys.

Parameters:

map - options

See Also:

ListOptions.of(Object, Object[])

setOptionsEnum

default void setOptionsEnum(java.lang.Class<I> optionsEnum)

Sets options from the passed enum class. Enum class must be Java enumeration and implement EnumClass.

Parameters:

optionsEnum - enum class

getOptionsDatasource

@Deprecated
default CollectionDatasource getOptionsDatasource()

Deprecated. Use getOptions() instead.

Returns:

options datasource

setOptionsDatasource

@Deprecated
default void setOptionsDatasource(CollectionDatasource datasource)

Deprecated. set options using setOptions(Options) with DatasourceOptions.

Parameters:

datasource - datasource

getOptionsList

@Deprecated
default java.util.List getOptionsList()

Deprecated. Use getOptions() instead.

Returns:

options list

getOptionsMap

@Deprecated
default java.util.Map<java.lang.String,?> getOptionsMap()

Deprecated. Use getOptions() instead.

Returns:

options map

getOptionsEnum

@Deprecated
default java.lang.Class<? extends EnumClass> getOptionsEnum()

Deprecated. Use getOptions() instead.

Returns:

enumclass