com.haulmont.cuba.gui.components

Interface HtmlBoxLayout

All Superinterfaces:

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

public interface HtmlBoxLayout
extends ComponentContainer, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasRequiredIndicator

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 com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

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

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasRequiredIndicator

isRequiredIndicatorVisible, setRequiredIndicatorVisible

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getTemplateName

java.lang.String getTemplateName()

Return filename of the related HTML template.

setTemplateName

void setTemplateName(java.lang.String templateName)

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

getTemplateContents

java.lang.String getTemplateContents()

Returns:

the contents of the template

setTemplateContents

void setTemplateContents(java.lang.String templateContents)

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