Page History

...

Code Block

language	yml

columns: &columns
  - name: jcrName
    label: name
    $type: jcrTitleColumn
    editable: true
    nodeTypeToIcon:
      mgnl:contact: icon-people
      mgnl:content: icon-folder
    filterComponent:
      $type: textField
    editor:
      availability:
        nodes: true
        properties: true
  - name: value
    label: value
    editable: true
    editor:
      availability:
        nodes: false
        properties: true
  - name: jcrPath
    label: path
    $type: jcrPathColumn
  - name: status
    label: status
    $type: jcrStatusColumn
  - name: mgnl:created
    $type: dateColumn
    label: date
    editable: false
    editor:
      availability:
        nodeTypes:
          - mgnl:contact
        nodes: true
        properties: false
      field:
        $type: textField
        converterClass: com.vaadin.data.converter.StringToDateConverter

Column properties

required (unless $type is used

type

required, default is String.class

Model type of the column. Must use the fully qualified class name.

class

optional (see also $type

class

)

The column definition class reads the column configuration and displays the column accordingly. The class must implement the

Javadoc resource link

className	info.magnolia.ui.contentapp.configuration.column.ColumnDefinition
renderType	asynchronous

interface. You can write your own class or use one of the ready-made classes. Set the value to the fully qualified class name. Examples:

Javadoc resource link
className info.magnolia.ui.contentapp.column.jcr.JcrTitleColumnDefinition
renderType asynchronous
displays the name of an item.
Javadoc resource link
className info.magnolia.ui.contentapp.column.jcr.JcrPathColumnDefinition
renderType asynchronous
displays the path of an item.
Javadoc resource link
className info.magnolia.ui.contentapp.column.jcr.JcrStatusColumnDefinition
renderType asynchronous
displays the activation status of an item.
Javadoc resource link
className info.magnolia.ui.contentapp.configuration.column.DateColumnDefinition
renderType asynchronous
displays the last modification date.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.contentapp.configuration.column.ColumnType. The proper value is defined by the annotation.

Code Block

language	java
title	Example class annotation
collapse	true

@ColumnType("dateColumn")
public class DateColumnDefinition extends ConfiguredColumnDefinition<Date> {
...
}

To use the $type property in YAML, see Example column definition.

type

required, default is String.class

Model type of the column. Must use the fully qualified class name

.

name

optional, default is parent node name

Name of the column.

descriptionGenerator

optional

Generates a description for the column.

editable

optional, default is false

Defines whether the column is editable inline. You can double-click a cell to edit its value.

You cannot define a default action and use inline editing at the same time.

editor

optional

Defines the inline editor component.

availability

required

Outlines when the column can be edited inline.

field

required, default is textField

Type of the field definition item. See Field types for possible values.

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.

label

optional, default is column name

Text displayed to use in the column heading.

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.

renderer

optional, default is com.vaadin.ui.renderers.TextRenderer

Class extending Vaadin AbstractRenderer.

valueProvider

optional

Class extending Vaadin ValueProvider.

width

optional

Defines the width (in pixels). When set, overrides any configuration from expandRatio, maximumWidth and minimumWidth.

Page tree

Versions Compared

Old Version 76

New Version 77

Key

Column properties