GroupBoxLayout
is a container that enables framing the embedded components and setting a universal header for them. Additionally, it can collapse content.
Component XML-name: groupBox
.
An example container description in a screen XML-descriptor:
link:../../../../../../source/gui_vcl/groupboxlayout_1.xml[role=include]
groupBox
attributes:
-
caption
– group header.
-
orientation
– defines components placement direction − horizontal or vertical. The default value isvertical
.
-
collapsed
– if set totrue
, component’s content will be collapsed initially. It is used withcollapsable="true"
.An example of a collapsed
GroupBox
:The expanded state change events of the
groupBox
component can be intercepted with the help of theExpandedStateChangeListener
interface.
-
outerMargin
- sets the outer margins outside the border ofgroupBox
. If set totrue
, the outer margins will be added on all sides of the component. To set the outer margins for all sides individually, settrue
orfalse
for each side ofgroupBox
:<groupBox outerMargin="true, false, true, false">
If the
showAsPanel
attribute is set to true,outerMargin
is ignored.
-
showAsPanel
– if set totrue
, the component will look like Vaadin Panel. The default value isfalse
.
By default, the groupBox
container is 100% wide, similar to vbox.
In Web Client with a Halo-based theme, you can set predefined styles to the groupBox
component using the stylename
attribute either in the XML descriptor or in the screen controller. When setting a style programmatically, select one of the HaloTheme class constants with the LAYOUT_
or GROUPBOX_
prefix. The following styles should be used combined with showAsPanel
attribute set to true
:
-
borderless
style removes borders and the background color of thegroupBox
:link:../../../../../../source/gui_vcl/groupboxlayout_3.java[role=include]
-
card
style name makes a layout look like a card.
-
well
style makes container look "sunken" with shaded background:link:../../../../../../source/gui_vcl/groupboxlayout_2.xml[role=include]
You can use keyboard shortcuts in Groupbox
. Set the shortcut and the action to be performed using the addShortcutAction()
method:
link:../../../../../../source/gui_vcl/groupboxlayout.java[role=include]
- Attributes of groupBox
-
align - caption - captionAsHtml - collapsable - collapsed - contextHelpText - contextHelpTextHtmlEnabled - css - description - descriptionAsHtml - expand - box.expandRatio - height - id - orientation - outerMargin - settingsEnabled - showAsPanel - spacing - stylename - width
- Predefined styles of groupBox
-
borderless - card - well
- API
-
add - addExpandedStateChangeListener - addShortcutAction - applySettings - getComponent - getComponentNN - getComponents - getOwnComponent - getOwnComponents - indexOf - remove - removeAll - saveSettings - setOuterMargin - setSpacing