Versions Compared

Old Version 98

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version 99

changes.mady.by.user Ashraf Khamis

Saved on

Key

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

...

class

required (unless $type is used)

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.JcrTitleColumnDefinition
    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

    See Column types for possible values.

    $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.

    type

    required, default is String.class

    Model type of the column. 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.

    name

    optional, default is parent node name

    Name of the column.

    descriptionGenerator

    optional

    Generates a description for the column.

    editable

    optional, default is false

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

    (warning) You cannot define defaultAction 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. In theory, all field types are supported. For properties, see field-specific and common field properties.

    label

    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.

    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

    optional, default is true

    Sets whether the width of the content in the column is the minimum width of the column. When false, the column shrinks down to the width defined in minimumWidth if necessary.

    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.

    ...