io.jmix.ui.component

Interface HtmlBoxLayout

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, HasComponents, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasRequiredIndicator

All Known Implementing Classes:

HtmlBoxLayoutImpl

@StudioComponent(caption="HtmlBox",
                 category="Containers",
                 xmlElement="htmlBox",
                 icon="io/jmix/ui/icon/container/htmlBox.svg",
                 canvasBehaviour=CONTAINER,
                 containerType=VERTICAL,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/containers/html-box-layout.html")
public interface HtmlBoxLayout
extends ComponentContainer, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasRequiredIndicator, HasHtmlSanitizer

A container component with freely designed layout and style. The layout consists of items with textually represented locations. Each item contains one sub-component, which can be any component, such as a layout. The adapter and theme are responsible for rendering the layout with a given style by placing the items in the defined locations.

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

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTemplateContents()
java.lang.String	getTemplateName() Returns filename of the related HTML template.
void	setTemplateContents(java.lang.String templateContents) Sets the contents of the template used to draw the custom layout.
void	setTemplateName(java.lang.String templateName) Sets filename of the related HTML template inside theme/layouts directory.

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

add, add, remove, remove, removeAll

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

focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

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

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getTemplateName

@Nullable
java.lang.String getTemplateName()

Returns filename of the related HTML template.

setTemplateName

@StudioProperty(name="template",
                type=FILE_REF,
                options={"html","themes/${themeName}/layouts/"})
void setTemplateName(@Nullable
                                                                                                                                                      java.lang.String templateName)

Sets filename of the related HTML template inside theme/layouts directory.

getTemplateContents

@Nullable
java.lang.String getTemplateContents()

Returns:

the contents of the template

setTemplateContents

@StudioProperty(type=HTML)
void setTemplateContents(@Nullable
                                                    java.lang.String templateContents)

Sets the contents of the template used to draw the custom layout.