TitledListViewTemplate
This page provides generated reference documentation for the TitledListViewTemplate data model.
Used to display and enter data of the "n" part in a 1:n data relation: Displays one or multiple entity fields of n data sets, ordered in a comma-separated list (property "columns"). One field appears as preceding title, one further field can be highlighted.
Overview
| Property | Summary |
|---|---|
| title | Title of the component |
| devices | Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices… |
| children | — |
| entityField | This property is mandatory. Its value must be set to |
| columns | Contains all defined columns for this component. |
| titleField | Field, that hold the title information |
| highlightingField | Has to contain the information, that should be highlighted |
| informationField | Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only… |
| isCreatable | Creatable yes/no. |
| isEditable | Editable yes/no. |
| titleFieldFullWidth | Determines, if the title field can utilize the full width or is restricted |
| fixedDrawer | Determines, if the drawer can be minimized or not |
| rowLimit | Limit the amount of rows displayed and then show a show more button |
| isDeletable | Deletable yes/no. |
| autoNewRow | Determines if a new row should be added automatically, if the record state is NEW |
| maxDBRow | Sets the maximum number of data rows to be gathered from the database |
| viewRendererMapping | Mapping that specifies how an entity field should be rendered in view mode. If no custom mapping is defined the default renderers are used. |
| editRendererMapping | Mapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used. |
| isLabelPositionTop | Defines if the label position of a FormItem is on top or to the side. Mobile devices will always use the top position and ignore this option. |
| textAlignment | Specifies the text alignment for the values of the viewtemplate (default = left). The text alignment is the same for all of the value elements within the… |
| colspan | The colspan of the element. |
| rowspan | The rowspan of the element. |
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title of the component
devices
Type: EDeviceType[]
Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.
children
Type: Children
entityField
Type: String
This property is mandatory. Its value must be set to\
- #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View (default).\
- a single EntityField, if the ViewTemplate uses only this one single EntityField (example: WebContentViewTemplate).
The second option will result in a performance optimization.
columns
Type: Column
Contains all defined columns for this component.
titleField
Type: String
Field, that hold the title information
highlightingField
Type: String
Has to contain the information, that should be highlighted
informationField
Type: String
Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only shown once per ViewTemplate.
isCreatable
Type: Boolean
Default: true
Creatable yes/no.
isEditable
Type: Boolean
Default: true
Editable yes/no.
titleFieldFullWidth
Type: Boolean
Determines, if the title field can utilize the full width or is restricted
fixedDrawer
Type: Boolean
Determines, if the drawer can be minimized or not
rowLimit
Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Limit the amount of rows displayed and then show a show more button
isDeletable
Type: Boolean
Default: true
Deletable yes/no.
autoNewRow
Type: Boolean
Determines if a new row should be added automatically, if the record state is NEW
maxDBRow
Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Sets the maximum number of data rows to be gathered from the database
viewRendererMapping
Type: RendererMappingDataModel
Mapping that specifies how an entity field should be rendered in view mode. If no custom mapping is defined the default renderers are used.
editRendererMapping
Type: RendererMappingDataModel
Mapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used.
isLabelPositionTop
Type: Boolean
Default: false
Defines if the label position of a FormItem is on top or to the side. Mobile devices will always use the top position and ignore this option.
textAlignment
Type: ETextAlignment
Requires: isLabelPositionTop property group
Specifies the text alignment for the values of the viewtemplate (default = left). The text alignment is the same for all of the value elements within the viewtemplate regardless of their content type. When isLabelPositonTop = true is set then the textAlignment property will be ignored.
colspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The colspan of the element.
rowspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The rowspan of the element.