Flavors
Flavors are used to address the individual areas within a layout controller.
Flavors can be assigned to the individual screen areas in a layout controller . However, it is not always necessary to specify a flavor for each screen area. In a simple layout controller (for example, the SimpleLayoutController), screen areas can also be defined without flavors. The names of the layout controller aliases are based on the aliases of the delivered flavors.
You use flavors to define which collection renderers are used in the individual screen areas.
For example, in the object type handler (OTH), you can use the following line to specify which collection renderer is used in the screen area with flavor Tree:
Tree.rndCollectionRenderer=CollectionTreeRenderer
In the OTH, the name of the flavor is prefixed to the parameter name and separated from it by a full stop. It is case-sensitive.
However, flavors also enable you to apply any parameter specifically to a certain screen area. To do this, assign a flavor to the individual collection renderer settings and resource renderer settings of a layout set.
Despite the similar names of flavors and collection renderers, there is nothing to stop you from used a collection renderer of the type CollectionListRenderer in a screen area with the flavor Grid, for example. Flavors only flag one screen area.
KM-Specific Flavors in the Standard System
| Flavor alias | Description |
|---|---|
|
Menu |
Indicates the upper, horizontal area of a layout controller |
|
Breadcrumb |
Horizontal screen area under the flavor menu |
|
Grid |
Screen area used in the layout controller GridListLayoutController |
|
List |
Screen area used in several layout controllers |
|
Table |
Not yet used in a layout controller |
|
Tab |
Upper, horizontal screen area used for the tabs of tab pages |
|
Tab_Content |
Used underneath the screen area with the flavor Tab for the content of tab pages |
|
Tree |
Left-hand screen area used in several layout controllers |
Flavors are also provided by other components such as by Collaboration. However, these are application-specific. Further use in own projects is not planned.
Parameters of a Flavor
| Parameters | Required | Description |
|---|---|---|
|
Alias |
Yes |
Alias of the flavor. This is used in the configuration in place of the technical name. |
|
Description |
No |
Description of the flavor. |
|
Flavor |
No |
Technical name of the flavor |
To call up a list of flavors used in the system, choose Content Management →User Interface → Mapping → Flavor.
If you use your own layout controllers with new flavors, create the aliases for the flavors in the configuration.