Forms define fields and similar components as well as their layout. Form definition is used in dialogs and the detail subapps of content apps.
This form definition is part of the Magnolia 6 UI framework. The fully qualified class name is
If you work with the Magnolia 5 UI framework, see Form definition for Magnolia 5 UI instead.
Example form definition
properties list here is defined with the YAML list syntax.
When a property type is defined as a list in the corresponding Java class, you can use the YAML map syntax or list syntax. Map2BeanTransformer converts YAML in both cases correctly.
A list of editor property definition items (typically, a list of fields).
See Field definition for more information.
optional, default is
Defines the form layout. The value must be a subtype of
See Layout types for more information.
With the default layout, it is not possible to configure anything. Use this layout when there is no need for customization.
From Magnolia 6.2.1,
FormLayoutDefinition has replaced the deprecated
PlainFormLayoutDefinition as the default layout.
With the tabbed layout, you can add or remove tabs and fields. It is not possible to change how any tabs and fields are rendered.
With the horizontal layout, you can order components horizontally. To disable spacing between components, set the
spacing property to
HorizontalLayoutDefinition has been introduced since Magnolia 6.2.1.
With the declarative layout, you can create form entries in an arbitrary Vaadin component container using the Vaadin declarative syntax. Use this layout for full customization.
To render the layout, a
template property is required. Because the Vaadin declarative syntax is used to design custom layouts, the declarative template has to be an HTML document.
In the template, the tag of a component element can have one of the following prefixes:
vaadin-: Vaadin core component.
mgnl-: Magnolia predefined or user-defined component. To define a mapping between a tag prefix and the Java package of the component, see the "Component Prefix to Package Mapping" section of Designing UIs Declaratively. The following Magnolia predefined components are available:
<mgnl-separator/>: horizontal line to separate content.
<mgnl-group caption="">: group header with a
captionattribute to separate content.
form-: Magnolia property as defined in YAML.
You can always use Magnolia predefined or user-defined components and Magnolia properties with Vaadin core components.
It is recommended that Magnolia properties be nested inside a
<vaadin-form-layout> tag. If you insert a Magnolia property inside a
<vaadin-vertical-layout> tag, the component will not be rendered as nicely.
VerticalLayout.java is stored in
my-style.css should be added to