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

(New page: {{ScoutPage|cat=Concepts}} Desktop is the root component of Scout Client applications. * implements: {{ScoutJavadoc|IDesktop|I}} * extends: {{ScoutJavadoc|AbstractDesktop|C}} == Descri...)
 
(Stub version of the page)
Line 1: Line 1:
 
{{ScoutPage|cat=Concepts}}
 
{{ScoutPage|cat=Concepts}}
  
Desktop is the root component of Scout Client applications.
+
The client session is the main entry point for client-server communication.
 
+
* implements: {{ScoutJavadoc|IDesktop|I}}
+
* extends: {{ScoutJavadoc|AbstractDesktop|C}}
+
  
 +
* implements: {{ScoutJavadoc|<TODO:NameOfTheInterface>|I}}
 +
* extends: {{ScoutJavadoc|<TODO:NameOfTheAbstractClass>|C}}
  
 
== Description ==
 
== Description ==
The desktop is the entry point of every Scout client application. It can (may) consist of:
+
{{note|TODO|Add a description}}
  
* Top-level {{ScoutLink|Concepts|Menu|menus}}
 
* {{ScoutLink|Concepts|Tool|Tools}}
 
* Set of available {{ScoutLink|Concepts|Outline|outlines}} and an active {{ScoutLink|Concepts|Outline|outline}}
 
  
* active message box stack
+
== Screenshot ==
* active tableview
+
{{note|TODO|Add a screenshot (or remove this section, if there is no screenshot to make)}}
* active detail form
+
* active search form
+
* form stack (swing: dialogs on desktop as JInternalFrames; eclipse: editors or views)
+
* dialog stack of modal and non-modal dialogs (swing: dialogs as JDialog, JFrame; eclipse: dialogs in a new Shell)
+
  
  
Line 25: Line 17:
 
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
 
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
  
* {{ScoutProp|Title}}: title of the application.
+
{{note|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.}}
* {{ScoutProp|Outlines}}: provide a list of the Outlines defined in the application.
+
  
  
Line 32: Line 23:
 
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
 
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
  
* {{ScoutEvent|Init}}
+
{{note|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.}}
 
+
Events of the application:
+
* {{ScoutEvent|Open}}: used to start the Form responsible to represent pages in the main windows.
+
* {{ScoutEvent|Closed}}: occures before the application quit.
+
* {{ScoutEvent|OutlineChanged}}: the active {{ScoutLink|Concepts|Outline|outline}} changed.
+
 
+
Events to handle GUI:
+
* {{ScoutEvent|GUIAttached}}
+
* {{ScoutEvent|GUIDetached}}
+
  
  
 
== See Also ==
 
== See Also ==
* {{ScoutLink|Concepts|Outline|Outline}}  
+
* {{ScoutLink|Concepts|Client Plug-In|ServerSession}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}

Revision as of 16:30, 30 October 2010

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

The client session is the main entry point for client-server communication.

Description

Note.png
TODO
Add a description


Screenshot

Note.png
TODO
Add a screenshot (or remove this section, if there is no screenshot to make)


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