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/Form"

m (Description: TODO notes)
m (Category changed)
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{ScoutPage|cat=Concepts}}
+
{{ScoutPage|cat=Client}}
  
 
A form is both a model structure of a ui concept known as dialog or view and also a model of a {{ScoutLink|Concepts|Wizard|wizard}} page. Wizard {{ScoutLink|Concepts|Button|buttons}} are added automatically to the main box if missing.
 
A form is both a model structure of a ui concept known as dialog or view and also a model of a {{ScoutLink|Concepts|Wizard|wizard}} page. Wizard {{ScoutLink|Concepts|Button|buttons}} are added automatically to the main box if missing.
  
* implements: {{ScoutJavadoc|<TODO:NameOfTheInterface>|I}}
+
* implements: {{ScoutJavadoc|IForm|I}}
* extends: {{ScoutJavadoc|<TODO:NameOfTheAbstractClass>|C}}
+
* extends: {{ScoutJavadoc|AbstractForm|C}}
  
 
== Description ==
 
== Description ==
 
{{note|TODO|Add a description}}
 
{{note|TODO|Add a description}}
 
TODO:  
 
TODO:  
* Main Box Field
+
* Contains {{ScoutLink|Concepts|Field|fields}} and {{ScoutLink|Concepts|Variable|variables}}.
* {{ScoutLink|Concepts|Form Handler|Handlers}}: start the form with different behaviors (e.g. startNew and startModify)
+
* MainBox Field (the main {{ScoutLink|Concepts|GroupBox|GroupBox Field}} at the root of a Form)
 +
* {{ScoutLink|Concepts|Form Handler|Handlers}}: start the form with different behaviors (e.g. <code>startNew()</code> and <code>startModify()</code>)
 +
* A Form can be opened as a Dialog or as a View (see {{ScoutLink|HowTo|Open_a_Form_in_a_View|Open a form in a view}}).
  
== Screenshot ==
+
{{ScoutLink|Concepts|Form/Example|Java code of a simple form}} as example.
{{note|TODO|Add a screenshot (or remove this section, if there is no screenshot to make)}}
+
  
 +
See also {{ScoutLink|Concepts|Search_Form|SearchForm}}
  
 +
== Screenshot ==
 +
<gallery>
 +
Image:Scout Form.png|Form as Dialog
 +
Image:Scout Form View.png|Form as View
 +
</gallery>
 
== Properties ==
 
== Properties ==
 
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
 
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
Line 32: Line 39:
 
* {{ScoutLink|Concepts|FormData|FormData}}
 
* {{ScoutLink|Concepts|FormData|FormData}}
 
* {{ScoutLink|Concepts|Wizard|Wizard}}
 
* {{ScoutLink|Concepts|Wizard|Wizard}}
 +
* {{ScoutLink|HowTo|Open_a_Form_in_a_View|How to open a form in a view}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}

Revision as of 11:44, 3 November 2011

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

A form is both a model structure of a ui concept known as dialog or view and also a model of a The Scout documentation has been moved to https://eclipsescout.github.io/. page. Wizard The Scout documentation has been moved to https://eclipsescout.github.io/. are added automatically to the main box if missing.

Description

Note.png
TODO
Add a description

TODO:

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

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

Screenshot

Properties

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

Note.png
TODO
Add a description of important properties. The idea is not to recreate the JavaDoc of the getConfiguredXxxxxx() methods but to provide explanations, best practice, example... Group the properties by domain.


Events

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

Note.png
TODO
Add a description of important events. The idea is not to recreate the JavaDoc of the execXxxxxx() methods but to provide explanations, best practice, example... Group the events by domain.


See Also

Back to the top