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

m (Events)
(Replaced content with "The Scout documentation has been moved to https://eclipsescout.github.io/.")
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{ScoutPage|cat=Client}}
+
The Scout documentation has been moved to https://eclipsescout.github.io/.
 
+
Pages are elements allowing the user to browse through the content of the application.
+
 
+
* implements: {{ScoutJavadoc|IPage|I}}
+
* extends: {{ScoutJavadoc|AbstractPage|C}}
+
 
+
'''Note:''' Typically when you want to create a Page, choose the type of page you want ({{ScoutLink|Concepts|TablePage|Table Page}} or {{ScoutLink|Concepts|NodePage|Node Page}}) and extend one of these pages.
+
 
+
== Description ==
+
A page allows the user to browse to a specific point of an application. Pages have a hierarchical organisation: Each page can contains other pages. On the top of the hierarchy is an {{ScoutLink|Concepts|Outline|Outline}} that create the first root pages.
+
 
+
In {{ScoutLink|Concepts|Outline based application|outline based applications}}, pages are represented as node of a tree on the left. It is possible to drill down the page to access the child pages (unless the page is configured as leaf). On the right the content of the page is displayed. Instead of the page content, it is possible to display a {{ScoutLink|Concepts|Page Detail Form|detail form}} in this area.
+
 
+
It is possible to reference them with a {{ScoutLink|Concepts|NodePage|Bookmark}}.
+
 
+
There are two types of pages, depending on the type of content you want to represent, you will probably consider one of the two types:
+
 
+
[[Image:HG_Page.png]]
+
 
+
=== {{ScoutLink|Concepts|TablePage|Table Page}} ===
+
[[Image:ScoutTablePage.png]]
+
 
+
A table page is suitable if you want to represent many elements as rows of a {{ScoutLink|Concepts|Table|Table}} (displayed on the right). The table is loaded on event {{ScoutEvent|LoadTableData}}. It is possible to create a child for each row with the event {{ScoutEvent|CreateChildPage}}.
+
 
+
=== {{ScoutLink|Concepts|NodePage|Node Page}} ===
+
[[Image:ScoutNodePage.png]]
+
 
+
A node page is suitable to represent a single element. The content is a list of child pages created on event {{ScoutEvent|CreateChildPages}}. The child pages are represented on the left in the tree representation of the page hierarchy. The {{ScoutLink|Concepts|Table|Table}} on the right contains also the list of child pages.
+
 
+
== Properties ==
+
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
+
 
+
{{note|TODO|Add a description of the more important properties (ore the properties specific to this element)}}
+
 
+
 
+
== Events ==
+
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
+
 
+
{{note|TODO|
+
* {{ScoutEvent|InitPage}}
+
* {{ScoutEvent|DisposePage}}
+
* {{ScoutEvent|DataChanged}}
+
* {{ScoutEvent|PageDataLoaded}}
+
}}
+
 
+
With {{ScoutEvent|PageActivated}} and {{ScoutEvent|PageDeactivated}} you are notified when the page is selected and de-selected in the outline tree. This can be usefull to handle the {{ScoutLink|Concepts|Page_Detail_Form|lifecycle of a detail form}}.
+
 
+
== See also ==
+
* {{ScoutLink|Concepts|NodePage|Node Page}}
+
* {{ScoutLink|Concepts|TablePage|Table Page}}
+
* {{ScoutLink|Concepts|Outline|Outline}}
+

Latest revision as of 04:28, 14 March 2024

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

Back to the top