Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Scout/Concepts/FormData"

(struturation of the article, some idea on the content)
(Replaced content with "The Scout documentation has been moved to https://eclipsescout.github.io/.")
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{ScoutPage|cat=Concepts}}
+
The Scout documentation has been moved to https://eclipsescout.github.io/.
 
+
FormData is the standard data transfert 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 transfert 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
+
** "CREATE EXTERNAL" parameter is needed on fiels (a GroupBoxField for example) defined in an external Class that contains other fields.
+
 
+
== Structure of a FormData ==
+
{{note|TODO|Describe the structure of a FormData. Help to understand what the SDK does}}
+
 
+
 
+
== 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}}
+

Latest revision as of 05:22, 14 March 2024

The Scout documentation has been moved to https://eclipsescout.github.io/.

Back to the top