Package io.jmix.ui.component

Interface HasOptionCaptionProvider<I>

Type Parameters:

I - option item type

All Superinterfaces:

Component

All Known Subinterfaces:

CheckBoxGroup<I>, ComboBox<V>, EntityComboBox<V>, MultiSelectList<V>, OptionsField<V,I>, 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 HasOptionCaptionProvider<I>
extends Component

A component that is marked with this interface allows to manage caption for options displayed by this component.

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

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
Function<? super I,String>	getOptionCaptionProvider()
void	setOptionCaptionProvider(Function<? super I,String> optionCaptionProvider)	Sets function that provides caption for option items.

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

Method Details

setOptionCaptionProvider

void setOptionCaptionProvider(@Nullable
 Function<? super I,String> optionCaptionProvider)

Sets function that provides caption for option items.

Parameters:

optionCaptionProvider - caption provider for options

getOptionCaptionProvider

@Nullable
Function<? super I,String> getOptionCaptionProvider()

Returns:

caption provider for options