Page History
Columns define what content is displayed in tree and list views in the browser subapp.
Info |
---|
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. |
Table of Contents |
---|
Example column definition
Code Block | ||
---|---|---|
| ||
columns: &columns - name: jcrName label: name $type: jcrNameColumn editable: truejcrTitleColumn 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: nodesnodeTypes: false properties: truemgnl:contact - name: jcrPath label: path $type: jcrPathColumn - name: status label: status $type: jcrStatusColumn - name: mgnl:created $type: dateColumn label: date editable: falsetrue editor: availability: *onlyContacts: nodeTypes: - mgnl:contact nodes: true properties: false field: $type: textField converterClass: com.vaadin.data.converter.StringToDateConverter |
Column properties
class | required (unless The column definition class reads the column configuration and displays the column accordingly. The class must implement the
If the definition class is annotated with | ||||||||||||||||||||||||||||||
$type | You can use this as a shortcut for
To use the | ||||||||||||||||||||||||||||||
type | required, default is Model 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 (for example, with | ||||||||||||||||||||||||||||||
name | optional, default is parent node name Name of the column. | ||||||||||||||||||||||||||||||
descriptionGenerator | optional Generates a description for the column. | ||||||||||||||||||||||||||||||
editable | optional, default is When set to You cannot define a default action and | ||||||||||||||||||||||||||||||
editor | 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. Availability is resolved against the selected row, not the selected column or property. | ||||||||||||||||||||||||||||||
expandRatio | optional Defines the ratio with which the column expands. By default, all columns expand equally. | ||||||||||||||||||||||||||||||
filterComponent | optional Adds a filter field to the column. In theory, all field types are supported. See List of fields for more information. Currently, column filtering is not supported in REST-based elements of the UI. | ||||||||||||||||||||||||||||||
label | optional, default is column name Text displayed to use in the column heading. Can be the text itself or an 18n key. 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. | ||||||||||||||||||||||||||||||
maximumWidth | optional Defines the maximum allowed pixel width of the column when it is set to expand. | ||||||||||||||||||||||||||||||
minimumWidth | optional Defines the minimum guaranteed pixel width of the column when it is set to expand. | ||||||||||||||||||||||||||||||
minimumWidthFromContent name | optional, default is parent node nameName of the column. Sets whether the width of the content in the column is the minimum width of the column. When | ||||||||||||||||||||||||||||||
renderer | optional, default is Class extending Vaadin | ||||||||||||||||||||||||||||||
valueProvider | optional Class extending Vaadin | ||||||||||||||||||||||||||||||
width | optional Defines the width (in pixels). When set, overrides any configuration from |
Column types
$type | class |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|