Package io.jmix.ui.component

Interface HasItemCaptionProvider<I>

Type Parameters:

I - component value type

All Superinterfaces:

Component

All Known Subinterfaces:

Tree<E>

All Known Implementing Classes:

TreeImpl

public interface HasItemCaptionProvider<I>
extends Component

A component that is marked with this interface allows to manage caption for component 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

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>	getItemCaptionProvider()
void	setItemCaptionProvider(Function<? super I,String> itemCaptionProvider)	Sets function that provides caption for component item.

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

setItemCaptionProvider

void setItemCaptionProvider(@Nullable
 Function<? super I,String> itemCaptionProvider)

Sets function that provides caption for component item.

Parameters:

itemCaptionProvider - caption provider for item

getItemCaptionProvider

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

Returns:

caption provider for item