Package io.jmix.ui.component

Interface CompositeWithCaption

All Superinterfaces:

Component.HasCaption, Component.HasDescription, CompositeWithDescription

All Known Subinterfaces:

CompositeWithHtmlCaption, Dashboard, GroupFilter

All Known Implementing Classes:

AbstractSingleFilterComponent, DashboardImpl, FilterImpl, FullTextFilterImpl, GroupFilterImpl, JpqlFilterImpl, PropertyFilterImpl

public interface CompositeWithCaption
extends CompositeWithDescription, Component.HasCaption

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

Method Summary

Modifier and Type	Method	Description
default String	getCaption()
default void	setCaption(String caption)	Sets the component's caption.

Methods inherited from interface io.jmix.ui.component.CompositeWithDescription

getDescription, setDescription

Method Details

getCaption

@Nullable
default String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Returns:

the caption of the component

setCaption

default void setCaption(@Nullable
 String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Parameters:

caption - the new component's caption