Column definition
Columns define what content is displayed in tree and list views in the browser subapp.
This column 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 Column definition for Magnolia 5 UI instead. |
Example definition
columns: &columns
- name: jcrName
label: name
$type: jcrTitleColumn
nodeTypeToIcon:
mgnl:contact: icon-people
mgnl:content: icon-folder
filterComponent:
$type: textField
editable: true
editor:
availability:
nodes: true
properties: true
- name: value
label: value
editable: true
editor:
availability:
nodeTypes: mgnl:contact
- name: jcrPath
label: path
$type: jcrPathColumn
- name: status
label: status
$type: jcrStatusColumn
- name: mgnl:created
$type: dateColumn
label: date
editable: true
editor:
availability:
nodeTypes:
- mgnl:contact
nodes: true
properties: false
field:
$type: textField
converterClass: com.vaadin.data.converter.StringToDateConverter
Column properties
Property | Description | ||
---|---|---|---|
|
required (unless The column definition class reads the column configuration and displays the column accordingly. The class must implement the ColumnDefinition interface. You can write your own class or use one of the ready-made classes. See Column types for possible values. |
||
|
You can use this as a shortcut for Example class annotation
To use the |
||
|
required, default is Data type of the column. Use the fully qualified class name. See PropertyType for possible values. A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation.
|
||
|
optional, default is parent node name Name of the column. |
||
|
optional Generates a description for the column. |
||
|
optional, default is When set to
|
||
|
optional Defines the inline editor component. For this to work, you have to set
|
||
|
required, default is Type of the field definition item. See Field types for possible values. |
||
|
optional Outlines when inline editing is permitted. See Action availability for more information.
|
||
|
optional Defines the ratio with which the column expands. By default, all columns expand equally. |
||
|
optional Adds a filter field to the column. In theory, All field types are supported. See List of fields for more information.
|
||
|
optional Text displayed in the column heading. The value can be literal or a key of a message bundle. If you do not provide the property, Magnolia will fall back to a generated i18n key. |
||
|
optional Defines the maximum allowed pixel width of the column when it is set to expand. |
||
|
optional Defines the minimum guaranteed pixel width of the column when it is set to expand. |
||
|
optional, default is Sets whether the width of the content in the column is the minimum width
of the column. When |
||
|
optional, default is Class extending Vaadin
|
||
|
optional Class extending Vaadin
|
||
|
optional Defines the width (in pixels). When set, overrides any configuration
from |
Column types
$type | class |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|