io.jmix.ui.component

Interface CompositeWithHtmlCaption

All Superinterfaces:

Component.HasCaption, Component.HasDescription, CompositeWithCaption, CompositeWithDescription, HasHtmlCaption

All Known Subinterfaces:

GroupFilter

All Known Implementing Classes:

AbstractSingleFilterComponent, FilterImpl, GroupFilterImpl, JpqlFilterImpl, PropertyFilterImpl

public interface CompositeWithHtmlCaption
extends CompositeWithCaption, HasHtmlCaption

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

Method Summary

Modifier and Type	Method and Description
default boolean	isCaptionAsHtml()
default void	setCaptionAsHtml(boolean captionAsHtml) Sets whether the caption is rendered as HTML.

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

getCaption, setCaption

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

getDescription, setDescription

Method Detail

isCaptionAsHtml

default boolean isCaptionAsHtml()

Specified by:

isCaptionAsHtml in interface HasHtmlCaption

Returns:

true if the caption is rendered as HTML, false if rendered as plain text

setCaptionAsHtml

default void setCaptionAsHtml(boolean captionAsHtml)

Description copied from interface: HasHtmlCaption

Sets whether the caption is rendered as HTML.

Specified by:

setCaptionAsHtml in interface HasHtmlCaption

Parameters:

captionAsHtml - true if the caption is rendered as HTML, false if rendered as plain text

See Also:

Component.HasCaption.setCaption(String)