Package io.jmix.ui.component

Interface GroupBoxLayout

All Superinterfaces:

Collapsable, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, ExpandingLayout, HasBorder, HasComponents, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasOrientation, HasOuterMargin, HasRequiredIndicator, HasSpacing, OrderedContainer, ShortcutNotifier, SupportsExpandRatio

All Known Implementing Classes:

GroupBoxImpl

@StudioComponent(caption="VerticalGroupBox",
                 category="Containers",
                 xmlElement="groupBox",
                 icon="io/jmix/ui/icon/container/verticalGroupBox.svg",
                 canvasBehaviour=CONTAINER,
                 containerType=GROUP_BOX,
                 unsupportedProperties="orientation",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/containers/group-box-layout.html")
public interface GroupBoxLayout
extends ExpandingLayout, OrderedContainer, Component.HasIcon, Component.HasCaption, HasBorder, HasSpacing, HasOuterMargin, HasOrientation, Collapsable, Component.BelongToFrame, ShortcutNotifier, HasContextHelp, HasHtmlCaption, HasHtmlDescription, SupportsExpandRatio, HasRequiredIndicator, HasHtmlSanitizer

Nested Class Summary

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

Collapsable.ExpandedStateChangeEvent

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.ExpandingLayout

ExpandingLayout.ExpandDirection

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

HasContextHelp.ContextHelpIconClickEvent

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

HasOrientation.Orientation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
boolean	isShowAsPanel()
void	setShowAsPanel(boolean showAsPanel)	Sets layout style as a Vaadin Panel

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

addExpandedStateChangeListener, isCollapsable, isExpanded, setCollapsable, setExpanded

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.BelongToFrame

getFrame, setFrame

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.Component.HasIcon

getIcon, setIcon, setIconFromSet

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

add, add, remove, remove, removeAll

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

expand, getExpandDirection, isExpanded, resetExpanded

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

isBorderVisible, setBorderVisible

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

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

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.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

getOrientation, setOrientation

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

getOuterMargin, setOuterMargin, setOuterMargin, setOuterMargin

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

getSpacing, setSpacing

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

add, getComponent, getComponentNN, indexOf

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

addShortcutAction, removeShortcutAction

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

getExpandRatio, setExpandRatio

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

setShowAsPanel

@StudioProperty(defaultValue="false")
void setShowAsPanel(boolean showAsPanel)

Sets layout style as a Vaadin Panel

Parameters:

showAsPanel - whether the layout should appear as a Vaadin Panel

isShowAsPanel

boolean isShowAsPanel()

Returns:

true if layout looks like Vaadin Panel