Package io.jmix.ui.component

Interface SingleSelectList<V>

Type Parameters:

V - value and options type

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<V>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasOptionCaptionProvider<V>, HasValidator<V>, HasValue<V>, HasValueSource<V>, OptionsField<V,V>, Requirable, SelectList<V,V>, Validatable

All Known Implementing Classes:

SingleSelectListImpl

@StudioComponent(caption="SingleSelectList",
                 category="Components",
                 xmlElement="singleSelectList",
                 icon="io/jmix/ui/icon/component/singleSelectList.svg",
                 canvasBehaviour=SELECT_LIST,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/single-select-list.html")
public interface SingleSelectList<V>
extends SelectList<V,V>

List select component. Allows select only one item.

Nested Class Summary

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

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.SelectList

SelectList.DoubleClickEvent<I>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
boolean	isNullOptionVisible()
void	setNullOptionVisible(boolean nullOptionVisible)	Sets visibility for first null element in list.

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

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasOptionCaptionProvider

getOptionCaptionProvider, setOptionCaptionProvider

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.OptionsField

getOptions, setOptions, setOptionsEnum, setOptionsList, setOptionsMap

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.SelectList

addDoubleClickListener

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

setNullOptionVisible

@StudioProperty(defaultValue="true")
void setNullOptionVisible(boolean nullOptionVisible)

Sets visibility for first null element in list.

Parameters:

nullOptionVisible - whether null element should be visible

isNullOptionVisible

boolean isNullOptionVisible()

Returns:

whether null element is currently visible