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 (Category changed)
(Description)
Line 7: Line 7:
  
 
== Description ==
 
== Description ==
{{note|TODO|Add a description}}
+
Each form contains:
TODO:  
+
* 0..n {{ScoutLink|Concepts|Variable|variables}}.
* Contains {{ScoutLink|Concepts|Field|fields}} and {{ScoutLink|Concepts|Variable|variables}}.
+
* 0..n Key Strokes (inner classes implementing IKeyStroke).
* MainBox Field (the main {{ScoutLink|Concepts|GroupBox|GroupBox Field}} at the root of a Form)
+
* exactly 1 Main Box field (inner class implementing IGroupBox): this is the root {{ScoutLink|Concepts|GroupBox|GroupBox field}} containing the other {{ScoutLink|Concepts|Field|fields}}
* {{ScoutLink|Concepts|Form Handler|Handlers}}: start the form with different behaviors (e.g. <code>startNew()</code> and <code>startModify()</code>)
+
* 0..n ToolButtons (inner classes implementing IToolButton),
* 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}}).
+
* 1..n Form Handler (usually defined as inner classes implementing IFormHandler, but since the handler is set as parameter of AbstractForm.startInternal(IFormHandler) the handler can be defined everywhere): 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|How to open a form in a view}}).
  
 
{{ScoutLink|Concepts|Form/Example|Java code of a simple form}} as example.
 
{{ScoutLink|Concepts|Form/Example|Java code of a simple form}} as example.
  
See also {{ScoutLink|Concepts|Search_Form|SearchForm}}
+
See also {{ScoutLink|Concepts|Search_Form|SearchForm}}.
  
 
== Screenshot ==
 
== Screenshot ==

Revision as of 13:01, 24 September 2014

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

Each form contains:

  • 0..n The Scout documentation has been moved to https://eclipsescout.github.io/..
  • 0..n Key Strokes (inner classes implementing IKeyStroke).
  • exactly 1 Main Box field (inner class implementing IGroupBox): this is the root The Scout documentation has been moved to https://eclipsescout.github.io/. containing the other The Scout documentation has been moved to https://eclipsescout.github.io/.
  • 0..n ToolButtons (inner classes implementing IToolButton),
  • 1..n Form Handler (usually defined as inner classes implementing IFormHandler, but since the handler is set as parameter of AbstractForm.startInternal(IFormHandler) the handler can be defined everywhere): start the form with different behaviors (e.g. startNew() and startModify())

A Form can be opened as a Dialog or as a View (see The Scout documentation has been moved to https://eclipsescout.github.io/.).

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