Twin-column field

TwinColSelectFieldDefinition renders two boxes side by side. Available items are in the left box and selected items in the right box. To select an item, move it from left to right.

This control is useful for selecting large sets of items such as group and role memberships. You can find an example in the Security app.

class: info.magnolia.ui.form.field.definition.TwinColSelectFieldDefinition

Twin-column field properties

Simple twin-column field definition.

form:
 tabs:
    - name: tabTags
      label: Tags
      fields:
        - name: tags
          class: info.magnolia.ui.form.field.definition.TwinColSelectFieldDefinition
          type: String
          label: Tags
          options:
            - name: news
              label: News
              selected: true
            - name: sports
              label: Sports
              value: sports
            - name: celebrities
              label: Celebrities
              value: celebrities

Node name	Value
form
tabs
tabTags
fields
tags
options
news
label	News
selected	true
value	News
sports
label	Sports
value	sports
celebrities
label	Celebrities
value	celebrities
class	info.magnolia.ui.form.field.definition.TwinColSelectFieldDefinition
label	Tags

You can use all common field properties and the following:

`<field‑name>`	required Name of field
`options`	required Parent node for the selectable options.
`<option‑name>`	Name of the option.
`name`	optional, default is the parent node name Name of the node where the selected value is stored. If not set, the name of the parent node is used.
`value`	required Value saved to the repository when selected.
`label`	optional Option label displayed to the user.
`selected`	optional Pre-selects the option.
`path`	optional Path to an existing option set as opposed to defining options in the current definition.
`repository`	optional, default is `config` When using a `path` to an existing option set, workspace to look in.
`valueProperty`	optional, default is `value` Read option values from a different property. Set to the name of your custom value node.
`labelProperty`	optional, default is `label` Read option labels from a different property. Set to the name of your custom label node.
`textInputAllowed`	optional, default is `false` When `true`, the user can type into the select field to filter the available options. The `filteringMode` property defines how the options are filtered: contains or starts with. When `false`, the field behaves like a standard select field where the user can not enter text. Clicking the field opens the dropdown with options. This property does not make it possible to enter new values into the field. The user can only choose from existing options.
`filteringMode`	optional, default is `off` Vaadin `FilteringMode`. Default is `off` . Available values are: `contains` and `startswith` . To enable filtering, you must also: Set the `pageLength` property to a value greater than `0` . Set the `textInputAllowed` property to `true` .
`sortOptions`	optional, default is `true` By default, option labels are sorted alphabetically. When set to `false` sorts the options per JCR node order.
`pageLength`	optional, default is `0` To enable paging and filtering, value must be an integer > `0`. `0` disables paging and filtering.

All fields that allow users to make a selection (select, option group, twin-column, checkbox) follow this pattern but some have additional properties.

Properties specific to the twin-column field.

<field name> Name of field.

leftColumnCaption

optional, default is From

Text displayed above the left column. Typically retrieved from a message bundle.

rightColumnCaption

optional, default is To

Text displayed above the right column. Typically retrieved from a message bundle.

Page tree

Twin-column field

Twin-column field properties