Difference between revisions of "Scout/Concepts/Form"

From Eclipsepedia

Jump to: navigation, search
(Description)
m (Category changed)
 
(4 intermediate revisions by one user 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 ==
Line 10: Line 10:
 
TODO:  
 
TODO:  
 
* Contains {{ScoutLink|Concepts|Field|fields}} and {{ScoutLink|Concepts|Variable|variables}}.
 
* Contains {{ScoutLink|Concepts|Field|fields}} and {{ScoutLink|Concepts|Variable|variables}}.
* Main Box Field
+
* 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. startNew and startModify)
+
* {{ScoutLink|Concepts|Form Handler|Handlers}}: start the form with different behaviors (e.g. <code>startNew()</code> and <code>startModify()</code>)
* {{ScoutLink|Concepts|Form/Example|Example of a form}} code of a simple form
+
* 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 34: 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}}

Latest revision as of 11:44, 3 November 2011


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitter
Bugzilla
Bugzilla


A form is both a model structure of a ui concept known as dialog or view and also a model of a wizard page. Wizard buttons are added automatically to the main box if missing.

  • implements: I obj.pngIForm
  • extends: C obj.pngAbstractForm

Contents

[edit] Description

Note.png
TODO
Add a description

TODO:

Java code of a simple form as example.

See also SearchForm

[edit] Screenshot

[edit] Properties

Defined with getConfiguredXxxxxx() 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.


[edit] Events

Defined with execXxxxxx() 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.


[edit] See Also