HasOptionDescriptionProvider (Jmix-all 1.5 API)

Type Parameters:: T - option item type

All Superinterfaces:: Component

All Known Subinterfaces:: CheckBoxGroup<I>, RadioButtonGroup<I>

All Known Implementing Classes:: CheckBoxGroupImpl, RadioButtonGroupImpl

public interface HasOptionDescriptionProvider<T> extends Component

A component that is marked with this interface allows to manage a description for option 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 T,String>

getOptionDescriptionProvider()

void

setOptionDescriptionProvider(Function<? super T,String> optionDescriptionProvider)

Sets the option description provider.

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
- setOptionDescriptionProvider
  
  void setOptionDescriptionProvider(@Nullable Function<? super T,String> optionDescriptionProvider)
  
  Sets the option description provider.
  
  Parameters:
  
  optionDescriptionProvider - provider which provides descriptions for options
- getOptionDescriptionProvider
  
  @Nullable Function<? super T,String> getOptionDescriptionProvider()
  
  Returns:
  
  option description provider