Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languageyml
columns: &columns
  - name: jcrName
    label: name
    $type: jcrNameColumn
    editable: true
    nodeTypeToIcon:
      mgnl:contact: icon-people
      mgnl:content: icon-folder
    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: *onlyContacts
      field:
        $type: textField
        converterClass: com.vaadin.data.converter.StringToDateConverter

Column

...

properties

class

required

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

Javadoc resource link
classNameinfo.magnolia.ui.contentapp.configuration.column.ColumnDefinition
renderTypeasynchronous
 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
    classNameinfo.magnolia.ui.contentapp.column.jcr.JcrNameColumnDefinition
    renderTypeasynchronous
     displays the name of an item.
  • Javadoc resource link
    classNameinfo.magnolia.ui.contentapp.column.jcr.JcrPathColumnDefinition
    renderTypeasynchronous
     displays the path of an item.
  • Javadoc resource link
    classNameinfo.magnolia.ui.contentapp.column.jcr.JcrStatusColumnDefinition
    renderTypeasynchronous
     displays the activation status of an item.
  • Javadoc resource link
    classNameinfo.magnolia.ui.contentapp.configuration.column.DateColumnDefinition
    renderTypeasynchronous
     displays the last modification date.

If the definition class is annotated with info.magnolia.ui.contentapp.configuration.column.ColumnType, you can use the $type property instead.

$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
languagejava
titleExample class annotation
collapsetrue
@ColumnType("dateColumn")
public class DateColumnDefinition extends ConfiguredColumnDefinition<Date> {
...
}

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

editable

optional

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

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

label

optional, default is column name

Text displayed to use in the column heading. Can be the text itself or an 18n key.

name

optional, default is parent node name

Name of the column.