io.jmix.ui.component

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, Field<V>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasOptionCaptionProvider<I>, HasValidator<V>, HasValue<V>, HasValueSource<V>, Requirable, Validatable

All Known Subinterfaces:

CheckBoxGroup<I>, ComboBox<V>, EntityComboBox<V>, MultiSelectList<V>, RadioButtonGroup<I>, SelectList<V,I>, SingleSelectList<V>, TagPicker<V>, TwinColumn<V>

All Known Implementing Classes:

AbstractSelectList, CheckBoxGroupImpl, ComboBoxImpl, EntityComboBoxImpl, MultiSelectListImpl, RadioButtonGroupImpl, SingleSelectListImpl, TagPickerImpl, TwinColumnImpl

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

UI component having options.

Nested Class Summary

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 inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
Options<I>	getOptions()
void	setOptions(Options<I> options) Sets options for UI component.
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 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.HasOptionCaptionProvider

getOptionCaptionProvider, setOptionCaptionProvider

Method Detail

setOptions

void setOptions(@Nullable
                Options<I> options)

Sets options for UI component.

Parameters:

options - options

See Also:

ListOptions

getOptions

@Nullable
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

@StudioProperty(name="optionsEnum",
                type=ENUM_CLASS)
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