com.haulmont.cuba.gui.components

Interface HasOptionsStyleProvider<I>

Type Parameters:

I - option item type

All Superinterfaces:

Component

All Known Subinterfaces:

LookupField<V>, LookupPickerField<V>, SearchField<V>, SearchPickerField<V>, SuggestionField<V>, SuggestionPickerField<V>

public interface HasOptionsStyleProvider<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 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

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
default Component.OptionsStyleProvider	getOptionsStyleProvider() Deprecated. Use getOptionStyleProvider() instead.
java.util.function.Function<? super I,java.lang.String>	getOptionStyleProvider()
default void	setOptionsStyleProvider(Component.OptionsStyleProvider optionsStyleProvider) Deprecated. Use setOptionStyleProvider(Function) instead.
void	setOptionStyleProvider(java.util.function.Function<? super I,java.lang.String> optionStyleProvider) Sets the style provider that is used to produce custom class names for option items.

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

Method Detail

setOptionsStyleProvider

@Deprecated
default void setOptionsStyleProvider(Component.OptionsStyleProvider optionsStyleProvider)

Deprecated. Use setOptionStyleProvider(Function) instead.

Sets the given optionsStyleProvider to the component.

Parameters:

optionsStyleProvider - OptionsStyleProvider instance that will be used by this component

getOptionsStyleProvider

@Deprecated
default Component.OptionsStyleProvider getOptionsStyleProvider()

Deprecated. Use getOptionStyleProvider() instead.

Returns:

OptionsStyleProvider instance that is used by this component

setOptionStyleProvider

void setOptionStyleProvider(java.util.function.Function<? super I,java.lang.String> optionStyleProvider)

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

Parameters:

optionStyleProvider - style provider

getOptionStyleProvider

java.util.function.Function<? super I,java.lang.String> getOptionStyleProvider()

Returns:

the currently used item style provider