StepperViewTemplate
This page provides generated reference documentation for the StepperViewTemplate data model.
Displays steps of a process, represented by circles, ordered in a horizonal line. Each step has an icon (property "iconField"), a title ("titleField"), and a state ("stateField").
Overview
| Property | Summary |
|---|---|
| children | List of children in this container |
| colspan | The colspan of the element. |
| devices | Determines on wich devices the component should be available. |
| entityField | This property is mandatory. Its value must be set to 1. #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View… |
| iconField | Defines the field which provides the icon for the current step. |
| maxDBRow | Sets the maximum number of data rows to be gathered from the database |
| rowspan | The rowspan of the element. |
| stateField | Defines the field which provides the state of the current step. Possible values: INVISIBLE, DISABLED, ACTIVE, EDITABLE. |
| title | Title of the component |
| titleField | Defines the field which provides the title for the current step. |
children
Type: Children
List of children in this container
colspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The colspan of the element.
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.
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.
iconField
Type: String
Defines the field which provides the icon for the current step.
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
rowspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The rowspan of the element.
stateField
Type: String
Defines the field which provides the state of the current step. Possible values: INVISIBLE, DISABLED, ACTIVE, EDITABLE.
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title of the component
titleField
Type: String
Defines the field which provides the title for the current step.