|
|
| Line 1: |
Line 1: |
| − | {{ScoutPage|cat=Shared}}
| + | The Scout documentation has been moved to https://eclipsescout.github.io/. |
| − | | + | |
| − | FormData is the standard data transfer object for {{ScoutLink|Concepts|Form|forms}} between the {{ScoutLink|Concepts|Client Plug-In|client Plug-In}} and the {{ScoutLink|Concepts|Server Plug-In|server}}.
| + | |
| − | | + | |
| − | * extends: {{ScoutJavadoc|AbstractFormData|C}}
| + | |
| − | | + | |
| − | == Description ==
| + | |
| − | {{note|TODO|Add a description}}
| + | |
| − | Contains a transfer object for each {{ScoutLink|Concepts|Field|field}} and each {{ScoutLink|Concepts|Variable|variable}} of a {{ScoutLink|Concepts|Form|form}}.
| + | |
| − | | + | |
| − | === Usage ===
| + | |
| − | * Used as parameter of the <code>prepareCreate(..)</code>, <code>create(..)</code>, <code>load(..)</code>, <code>store(..)</code> functions in the {{ScoutLink|Concepts|Process Service|process service}}.
| + | |
| − | | + | |
| − | * Importation in {{ScoutLink|Concepts|Form|Form}}: {{ScoutEvent|Load}} and {{ScoutEvent|Store}} events of {{ScoutLink|Concepts|Form Handler|FormHandler}}:
| + | |
| − | ** <code>exportFormData()</code>
| + | |
| − | ** service call (depending of the action exectuted with the {{ScoutLink|Concepts|Process Service|ProcessService}})
| + | |
| − | ** <code>importFormData()</code>
| + | |
| − | | + | |
| − | === Access ===
| + | |
| − | {{note|TODO|Add a description and example of how to access to a value, how to know if a value was set}}
| + | |
| − | | + | |
| − | == Generation ==
| + | |
| − | === SDK Support ===
| + | |
| − | * Generation of FormData with the {{ScoutLink|SDK|Explorer_View|Explorer View}}
| + | |
| − | | + | |
| − | {{note|TODO|Add a screenshot}}
| + | |
| − | | + | |
| − | === FormData anotation ===
| + | |
| − | * {{ScoutJavadoc|FormData|A}} FormData annotation
| + | |
| − | ** Is needed on the form Class
| + | |
| − | <!-- old: ** "CREATE EXTERNAL" parameter is needed on fiels (a GroupBoxField for example) defined in an external Class that contains other fields. -->
| + | |
| − | | + | |
| − | == Structure of a FormData ==
| + | |
| − | The FormData depends from the {{ScoutLink|Concepts|Form}} it contains the data. The SDK generate:
| + | |
| − | * For each {{ScoutLink|Concepts|ValueField}} a <tt>AbstractValueFieldData<T></tt> is generated.
| + | |
| − | * For each {{ScoutLink|Concepts|TableField}} a {{ScoutLink|Concepts|TableData}} is generated.
| + | |
| − | * For each form-variable an <tt>AbstractPropertyData<T></tt>
| + | |
| − | | + | |
| − | The inner-class structure from the composite field (like groupboxes) get lost, unless Group-Box templates are used.
| + | |
| − | | + | |
| − | The value fields properties (<tt>getConfiguredMandatory()</tt>, <tt>getConfiguredMaxValue()</tt>, <tt>getConfiguredMaxLength()</tt>...) are mapped to <tt>ValidationRules</tt> conatained in the formData. Those rules are used to redo the basic UI client-side validations on the server.
| + | |
| − | | + | |
| − | == See Also ==
| + | |
| − | * {{ScoutLink|Concepts|Form|Form}}
| + | |
| − | * {{ScoutLink|Concepts|Form Handler|Form Handler}}
| + | |
| − | * {{ScoutLink|Concepts|Process Service|Process Service}}
| + | |
| − | * {{ScoutLink|Concepts|Shared Plug-In|Shared Plug-In}}
| + | |
