EntityFieldGroup
This page provides generated reference documentation for the EntityFieldGroup data model.
A Field Group is an ADITO model used for combining EntityFields, along with an additional configuration for editing.
Overview
| Property | Summary |
|---|---|
| title | Singular title of the model, e.g. Surname |
| titleProcess | Process to determine the title dynamically. This will overwrite the value of the title property and is for example displayed in the views within the client. |
| description | Short technical description of the model in plain text. |
| documentation | Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different… |
| fields | — |
| customProperties | — |
| defaultAction | When this process is set, a button is set to the respective GUI component, which executes the process stored here when clicked. |
| state | Determines the state of an element, for example: element can be edited, element is not visible, element is inactive, etc. |
| stateProcess | A process that can determine the state dynamically. You have to return the corresponding state in the process with result.string(...) This will overwrite the… |
| valueProcess | Formula. |
| tooltip | Tooltip. Text that is displayed when the mouse is driven over a component. |
| tooltipProcess | Process of tooltip labeling. |
title
Type: String
Constraints: Verification: TITLE_LENGTH
Singular title of the model, e.g. Surname
titleProcess
Type: String
Process to determine the title dynamically. This will overwrite the value of the title property and is for example displayed in the views within the client.
description
Type: String
Short technical description of the model in plain text.
documentation
Type: String
Contains the documentation of the data model in the popular AsciiDoc format (.adoc).
The documentation should be set by the developer to explain different aspects
(like purpose, concept, etc.) of the data model that he designed.
You may want to add the plugin "AsciidoctorJ" to your ADITO Designer in order
to modify AsciiDoc files.
fields
Type: Fields
customProperties
Type: CustomProperties
defaultAction
Type: String
When this process is set, a button is set to the respective GUI component, which executes the process stored here when clicked.
state
Type: EComponentState
Determines the state of an element, for example: element can be edited, element is not visible, element is inactive, etc.
Be aware that the concrete impact depends on the element where this property is set:
If you take a look at the read-only-value for example:
In a recordField this will affect only the field where the state property has been set.
In a consumerField all the recordFields within there will be readOnly, and you're not able to add, modify or delete records.
Note when the value "AUTO" is set, that the state does depend on different factors like "In which operatingstate is the record?".
stateProcess
Type: String
A process that can determine the state dynamically. You have to return the corresponding state in the process with result.string(...)
This will overwrite the value set in the state property.
Example:
result.string(count > 0 ? neon.COMPONENTSTATE_DISABLED : neon.COMPONENTSTATE_AUTO);
Note that this property may be internally overwritten (for example if the user has no grants).
valueProcess
Type: String
Formula.
Errors that occur in this process are not passed to the client. These can only be found in the server log / log files.
Error messages from this process do not arrive at the client, they are only visible in the server log.
tooltip
Type: String
Tooltip. Text that is displayed when the mouse is driven over a component.
tooltipProcess
Type: String
Process of tooltip labeling.
Here, each string can be returned by result.string(). control characters (e.g. \n) are evaluated to display new rows, for example.
HTML is not possible here.
If the component's content goes beyond the component, the first line of the ToolTip always displays the entire contents of the component.
This process overrides the toolTip property.
Error messages from this process do not arrive at the client, they are only visible in the server log.