Package io.jmix.ui.component

Interface HasOptionStyleProvider<I>

Type Parameters:

I - option item type

All Superinterfaces:

Component

All Known Subinterfaces:

ComboBox<V>, EntityComboBox<V>, EntitySuggestionField<V>, SuggestionField<V>, SuggestionFieldComponent<V,I>, TagField<V>, TwinColumn<V>

All Known Implementing Classes:

AbstractSuggestionField, ComboBoxImpl, EntityComboBoxImpl, EntitySuggestionFieldImpl, SuggestionFieldImpl, TagFieldImpl, TwinColumnImpl

public interface HasOptionStyleProvider<I>
extends Component

A component that is marked with this interface allows to manage additional style names 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>	getOptionStyleProvider()
void	setOptionStyleProvider(Function<? super I,String> optionStyleProvider)	Sets the style provider that is used to produce custom class names 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

setOptionStyleProvider

void setOptionStyleProvider(@Nullable
 Function<? super I,String> optionStyleProvider)

Sets the style provider that is used to produce custom class names for option items.

Parameters:

optionStyleProvider - style provider

getOptionStyleProvider

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

Returns:

the currently used item style provider