io.jmix.ui.component

Interface CompositeWithDescription

All Superinterfaces:

Component.HasDescription

All Known Subinterfaces:

CompositeWithCaption, CompositeWithHtmlCaption, CompositeWithHtmlDescription, GroupFilter

All Known Implementing Classes:

AbstractSingleFilterComponent, FilterImpl, GroupFilterImpl, JpqlFilterImpl, PropertyFilterImpl

public interface CompositeWithDescription
extends Component.HasDescription

CompositeComponent having a description. Default implementations delegate their execution to CompositeComponent.getComposition().

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getDescription()
default void	setDescription(java.lang.String description) Sets the component's description.

Method Detail

getDescription

@Nullable
default java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasDescription

Returns:

the components description, used in tooltips

setDescription

default void setDescription(@Nullable
                            java.lang.String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Parameters:

description - the new description to set