io.jmix.ui.component

Interface CompositeWithHtmlDescription

All Superinterfaces:

Component.HasDescription, CompositeWithDescription, HasHtmlDescription

All Known Subinterfaces:

GroupFilter

All Known Implementing Classes:

AbstractSingleFilterComponent, FilterImpl, GroupFilterImpl, JpqlFilterImpl, PropertyFilterImpl

public interface CompositeWithHtmlDescription
extends CompositeWithDescription, HasHtmlDescription

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

Method Summary

Modifier and Type	Method and Description
default boolean	isDescriptionAsHtml()
default void	setDescriptionAsHtml(boolean descriptionAsHtml) Sets whether the description is rendered as HTML.

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

getDescription, setDescription

Method Detail

isDescriptionAsHtml

default boolean isDescriptionAsHtml()

Specified by:

isDescriptionAsHtml in interface HasHtmlDescription

Returns:

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

setDescriptionAsHtml

default void setDescriptionAsHtml(boolean descriptionAsHtml)

Description copied from interface: HasHtmlDescription

Sets whether the description is rendered as HTML.

Specified by:

setDescriptionAsHtml in interface HasHtmlDescription

Parameters:

descriptionAsHtml - true if the description is rendered as HTML, false if rendered as plain text

See Also:

Component.HasDescription.setDescription(String)