Perspective DSL - Revision history

Kraeling: added description for keyword "synchronized"

2019-08-30T15:56:31Z

added description for keyword "synchronized"

Kraeling: Added example for event managers

2019-08-28T09:45:11Z

Added example for event managers

Kraeling at 12:20, 26 August 2019

2019-08-26T12:20:21Z

Kraeling: Changed keyword "IconURI" to "Icon"

2019-08-22T07:50:22Z

Changed keyword "IconURI" to "Icon"

Riegel: /* part */

2018-02-26T16:12:15Z

‎part

Riegel: /* part */

2018-02-26T16:11:32Z

‎part

Riegel: /* Introduction */

2018-02-26T16:11:08Z

‎Introduction

Cmollik: /* perspective */

2017-07-26T21:10:55Z

‎perspective

Cmollik: Created page with "==Introduction== Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model.

File:PerspectiveDSL..."

2017-06-27T11:18:39Z

Created page with "==Introduction== Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model. <br><br>File:PerspectiveDSL..."

New page

==Introduction==

Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model. <br><br>[[File:PerspectiveDSL_01.png|600px]]<br><br>

As you can recognize on the above graphics the main elements of theE4-Model are:

* Perspective. A perspective is a container for a set of UI graphic elements, like sash, part stack, part, area, etc. Perspectives can be used to store different arrangements of UI graphic elements. Each Workbench window contains one or more perspectives. A perspective defines the initial set and layout of views in the Workbench window. Each perspective provides a set of functionality aimed at accomplishing a specific type of task or works with specific types of resources.

* Sash. A sash is a UI graphic elements container, and it displays all its children at the same time either horizontally or vertically aligned. Default is vertically aligned.

* Part. A Part is a container for a view. Parts are user interface components which allow you to navigate and modify data.

* Part stack. A part stack contains a stack of parts showing the content of one part while displaying only the headers of the other parts.

* View. A view is used to work on a set of data, which might be a hierarchical structure. If data is changed via the view, this change is directly applied to the underlying data structure. A predefined view could be a bpmn(Business Process Model and Notation) view, a chart, a dialog, a grid, an organigram, a report, a select table, a table or a topology in OS.bee.

==Perspective DSL==

The PerspectiveDSL is used to build the ui for Os.bee Application.

You can find instances of these elements in Os.bee Applications as follows: <br><br>[[File:PerspectiveDSL_02.png|600px]]<br><br>

The main semantic elements of the PerspectiveDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “perspective” - define the perspective details, e.g. perspective name, the description…

* “sashContainer” - define the main element sash container for the perspective.

* “partStack” - define the main element part stack for the perspective.

* “part” - the main element part for the perspective.

* “view” - define the part view of the perspective, it can be report, dialog, table, chart …

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> [{
perspective <perspective name> . . .
. . .
}]
</syntaxhighlight>

One or more than one perspective could be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.perspectives {
perspective Employee . . .

perspective Supplier . . .

perspective Products . . .

. . .
}
</syntaxhighlight>

In this example <code>perspective</code> Employee, <code>perspective</code> Supplier, <code>perspective</code> Products and also other perspectives are defined in the same <code>package</code>.

====perspective====

This is the main part of this model. All the perspective details can be defined here.

► '''Syntax''':
<syntaxhighlight lang="java">
perspective <perspective name> [described by <description>]
[process <blip.blip name> usertask <blip.BlipUserTask name>]
([iconURI <iconURI>]
&
[accessibility <accessibilityPhrase>]
&
[toolbar <action.ActionToolbar>])
{
PerspectiveElement
. . .
}
</syntaxhighlight>

* Keyword <code>described by</code> is optional; you can use this keyword to define the description of this perspective.

* Keyword <code>process. . . usertask. . . </code> is optional, which define the blip process and blip usertask from predefined blipDSL for this perspective.

* Keyword <code>iconURI</code> is optional, it define the identifier for a resource, e.g. icon file.

* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

* Keyword <code>toolbar</code> is optional, which define the action tool bar from predefined ActionDSL. Graphical control elements are defined, on which on-screen buttons, icons, menus, or other input or output elements are placed.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
. . .
}

perspective ProductMaintenanceSelect process ProductMaintenance usertask SelectSomeProducts toolbar HandleTask iconURI "information" {
. . .
}
</syntaxhighlight>

In the next sections, the important elements and keywords of perspective will be introduced one by one.

====PerspectiveElement====

Keyword <code>PerspectiveElement</code> is used to define the main elements of the perspective.

The main elements are sash container, part stack and part.

=====sashContainer=====

Keyword <code>sashContainer</code> is used to define the main element sash container of perspective.

A sash container displays all its children at the same time either horizontally or vertically aligned.

► '''Syntax''':
<syntaxhighlight lang="java">
sashContainer <PerspectiveSashContainer ID>
[orientation horizontal|vertical]
&
[selectedElement <PerspectiveElement ID>]
&
[spaceVolume <containerData STRING>]
&
[accessibility <accessibilityPhrase STRING>]
{
PerspectiveElement
. . .
}
</syntaxhighlight>

* Keyword <code>orientation</code> is optional, it can be horizontal or vertical, and default value is vertical.
* Keyword <code>selectedElement</code> is optional; you can select one of the next level perspective element here and which is selected will be shown in the first place.
* Keyword <code>spaceVolume</code> is optional, it redefine the space volume of this sash container in screen. A number will be defined to representing the relative size of this container.
* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
sashContainer outer orientation vertical {
sashContainer top orientation horizontal {
. . .
}
sashContainer bottom orientation horizontal {
. . .
}
}
}
</syntaxhighlight>

In this example, in the first place, the <code>sash container</code> '''''outer''''' is defined, in this sash container, 2 second level <code>sash containers</code> are defined as horizontal, they are '''''top''''' and '''''bottom'''''.

=====partStack=====

Keyword <code>partStack</code> is used to define the main element part stack of perspective.

A part stack contains a stack of parts showing the contents of one part while displaying only the headers of the other parts.

► '''Syntax''':
<syntaxhighlight lang="java">
partStack <PerspectivePartStack ID>
[selectedElement <PerspectivePart ID>]
&
[spaceVolume <containerData STRING>]
&
[accessibility <accessibilityPhrase STRING>]
{
PerspectiveElement
. . .
}
</syntaxhighlight>

* Keyword <code>selectedElement</code> is optional; you can select the next level perspective element here and which is selected will be shown in the first place.
* Keyword <code>spaceVolume</code> is optional, it redefine the space volume of this part stack in screen. A number will be defined to representing the relative size of this part stack.
* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
sashContainer outer orientation vertical {
sashContainer top orientation horizontal {
. . .
}
sashContainer bottom orientation horizontal {
partStack EmployeeStack spaceVolume "70" {
. . .
}
partStack Payroll spaceVolume "30" {
. . .
}
}
}
}
</syntaxhighlight>

In this example, 2 <code>part stacks</code> are defined under <code>sash container</code> '''''bottom''''', they are '''''EmployeeStack''''' and '''''Payroll'''''. The sizes of them are redefined here, '''''EmployeeStack''''' takes 70% of the screen width and '''''payroll''''' takes the rest 30%.

=====part=====

Keyword part is used to define the main element part of perspective.

► '''Syntax''':
<syntaxhighlight lang="java">
part <PerspectivePart ID>
[described by <description String>]
&
[spaceVolume <containerData STRING>]
&
[accessibility <accessibilityPhrase STRING>]
&
[iconURI <iconURI string>]
&
[view select <table.Table> | table <table.Table>
| chart <chart.Chart> | report <report.Report>
| organigram <organization.Organization>
| topology <topology.Topology>
| dialog <dialog.Dialog> | bpmn | grid <table.Table>
]
&
[isClosable]
</syntaxhighlight>

* Keyword <code>described by</code> is optional; you can use this keyword to define the description of this part.
* Keyword <code>spaceVolume</code> is optional, it redefine the space volume of this part in screen. A number will be defined to representing the relative size of this part.
* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.
* Keyword <code>iconURI</code> is optional, it define the identifier for a resource, e.g. icon file
* Keyword <code>view</code> is optional, it defines the predefined view of this part, it can be report, dialog, table, chart, organigram, topology, bpmn.
* Keyword <code>isClosable</code> is optional; it will allow the user to close this part when this keyword is selected.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
sashContainer outer orientation vertical {
sashContainer top orientation horizontal {
part Orga spaceVolume "40" view organigram FoodMart
part Employees spaceVolume "20" view table Employees
part EmployeeDialog spaceVolume "40" view dialog Employee
}
. . .
}
}
</syntaxhighlight>

In this example, 3 <code>parts</code> are defined under <code>sash container</code> '''''top''''', they are '''''Orga''''', '''''Employees''''' and '''''EmployeeDialog'''''. The sizes of them are redefined here, '''''Orga''''' and '''''EmployeeDialog''''' take each 40% of the screen width and '''''Employees''''' takes the remaining 20%. The view of '''''Orga''''' is the predefined <code>organigram</code> '''''FoodMart'''''; the view of '''''Employees''''' is the predefined <code>table</code> '''''Employee'''''; and the view of '''''EmployeeDialog''''' is the predefined <code>dialog</code> '''''Employee'''''.

== Copyright Notice ==
{{Copyright Notice}}

@@ Line 252: / Line 252: @@
 ====PerspectiveEventManager====
-Keyword <code>eventManager</code> is used to describe an optional event manager for the perspective. By default (i.e. if no event manager is defined) a change of the data in one perspective part automatically changes the associated data in all other perspective parts (e.g. if one part is a table and another part a dialog to edit this table, then changes in the dialog automatically affect the table data). This behaviour can be restricted by using a PerspectiveEventManager
+Keyword <code>eventManager</code> is used to describe an optional event manager for the perspective. By default (i.e. if no event manager is defined) a change of the data in one perspective part automatically changes the associated data in all other perspective parts (e.g. if one part is a table and another part a dialog to edit this table, then clicking on a line in the table automatically affect the data shown in the dialog). This behaviour can be restricted by using a PerspectiveEventManager
 ► '''Syntax''':
@@ Line 271: / Line 271: @@
 * Keyword <code>targetPart</code> describes the perspective part for which we want to restrict the changes automatically being made by other parts.
 * Keyword <code>allowedSources</code> describes which parts are allowed to affect the target part.
 == Copyright Notice ==
 {{Copyright Notice}}

@@ Line 167: / Line 167: @@
 partStack <PerspectivePartStack ID>
 	[selectedElement <PerspectivePart ID>]
+     &
 	[spaceVolume <containerData STRING>]
@@ Line 178: / Line 180: @@
 * Keyword <code>selectedElement</code>  is optional; you can select the next level perspective element here and which is selected will be shown in the first place.
 * Keyword <code>spaceVolume</code>  is optional, it redefine the space volume of this part stack in screen. A number will be defined to representing the relative size of this part stack.
 * Keyword <code>accessibility</code>  is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

@@ Line 78: / Line 78: @@
 	 [toolbar <action.ActionToolbar>])
+	{
-PerspectiveElement
+        <PerspectiveElement>
 		. . .
+}
 </syntaxhighlight>
@@ Line 248: / Line 249: @@
 In this example, 3 <code>parts</code> are defined under <code>sash container</code> '''''top''''', they are '''''Orga''''', '''''Employees''''' and '''''EmployeeDialog'''''. The sizes of them are redefined here, '''''Orga''''' and '''''EmployeeDialog''''' take each 40% of the screen width and '''''Employees''''' takes the remaining 20%.  The view of '''''Orga''''' is the predefined <code>organigram</code> '''''FoodMart'''''; the view of '''''Employees''''' is the predefined <code>table</code> '''''Employee'''''; and the view of '''''EmployeeDialog''''' is the predefined <code>dialog</code> '''''Employee'''''.
 == Copyright Notice ==
 {{Copyright Notice}}

@@ Line 72: / Line 72: @@
 perspective <perspective name> [described by <description>]
 	[process <blip.blip name> usertask <blip.BlipUserTask name>]
-	([iconURI <iconURI>]
+	([icon <iconURI>]
+      &
 	 [accessibility <accessibilityPhrase>]
@@ Line 87: / Line 87: @@
 * Keyword <code>process. . . usertask. . . </code> is optional, which define the blip process and blip usertask from predefined blipDSL for this perspective.
-* Keyword <code>iconURI</code> is optional, it define the identifier for a resource, e.g. icon file.
+* Keyword <code>icon</code> is optional, it defines the identifier for a resource, e.g. icon file.
 * Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.
@@ Line 95: / Line 95: @@
 ► '''Example''':
 <syntaxhighlight lang="java">
-perspective Employee described by "Employee maintenance" iconURI "employee" {
+perspective Employee described by "Employee maintenance" icon "employee" {
 . . .
+}
-perspective ProductMaintenanceSelect process ProductMaintenance usertask SelectSomeProducts toolbar HandleTask iconURI "information" {
+perspective ProductMaintenanceSelect process ProductMaintenance usertask SelectSomeProducts toolbar HandleTask icon "information" {
 	. . .
+}
@@ Line 142: / Line 142: @@
 ► '''Example''':
 <syntaxhighlight lang="java">
-perspective Employee described by "Employee maintenance" iconURI "employee" {
+perspective Employee described by "Employee maintenance" icon "employee" {
 	sashContainer outer orientation vertical {
 		sashContainer top orientation horizontal {
@@ Line 182: / Line 182: @@
 ► '''Example''':
 <syntaxhighlight lang="java">
-perspective Employee described by "Employee maintenance" iconURI "employee" {
+perspective Employee described by "Employee maintenance" icon "employee" {
 	sashContainer outer orientation vertical {
 		sashContainer top orientation horizontal {
@@ Line 214: / Line 214: @@
 	[accessibility <accessibilityPhrase STRING>]
+     &
-	[iconURI <iconURI string>]
+	[icon <iconURI string>]
+     &
 	[view  select <table.Table> | table <table.Table>
@@ Line 229: / Line 229: @@
 * Keyword <code>spaceVolume</code>  is optional, it redefine the space volume of this part in screen. A number will be defined to representing the relative size of this part.
 * Keyword <code>accessibility</code>  is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.
-* Keyword <code>iconURI</code>  is optional, it define the identifier for a resource, e.g. icon file
+* Keyword <code>icon</code>  is optional, it defines the identifier for a resource, e.g. icon file
 * Keyword <code>view</code>  is optional, it defines the predefined view of this part, it can be report, dialog, table, chart, organigram, topology.
 * Keyword <code>isClosable</code>  is optional; it will allow the user to close this part when this keyword is selected.
@@ Line 235: / Line 235: @@
 ► '''Example''':
 <syntaxhighlight lang="java">
-perspective Employee described by "Employee maintenance" iconURI "employee" {
+perspective Employee described by "Employee maintenance" icon "employee" {
 	sashContainer outer orientation vertical {
 		sashContainer top orientation horizontal {

@@ Line 220: / Line 220: @@
 | organigram <organization.Organization>
 | topology <topology.Topology>
-| dialog <dialog.Dialog> | bpmn | grid <table.Table>
+| dialog <dialog.Dialog> | grid <table.Table>
+  ]
+     &

@@ Line 13: / Line 13: @@
 * Part stack. A part stack contains a stack of parts showing the content of one part while displaying only the headers of the other parts.
-* View. A view is used to work on a set of data, which might be a hierarchical structure. If data is changed via the view, this change is directly applied to the underlying data structure. A predefined view could be a bpmn(Business Process Model and Notation) view, a chart, a dialog, a grid, an organigram, a report, a select table, a table or a topology in OS.bee.
+* View. A view is used to work on a set of data, which might be a hierarchical structure. If data is changed via the view, this change is directly applied to the underlying data structure. A predefined view could be a chart, a dialog, a grid, an organigram, a report, a select table, a table or a topology in OS.bee.
 ==Perspective DSL==

@@ Line 91: / Line 91: @@
 * Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.
-* Keyword <code>toolbar</code> is optional, which define the action tool bar from predefined ActionDSL. Graphical control elements are defined, on which on-screen buttons, icons, menus, or other input or output elements are placed.
+* Keyword <code>toolbar</code> is optional, which define the action tool bar from predefined [[Action DSL]]. Graphical control elements are defined, on which on-screen buttons, icons, menus, or other input or output elements are placed.
 ► '''Example''':

Perspective DSL - Revision history

Kraeling: added description for keyword "synchronized"

Kraeling: Added example for event managers

Kraeling at 12:20, 26 August 2019

Kraeling: Changed keyword "IconURI" to "Icon"

Riegel: /* part */

Riegel: /* part */

Riegel: /* Introduction */

Cmollik: /* perspective */

Cmollik: Created page with "==Introduction== Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model. File:PerspectiveDSL..."

Cmollik: Created page with "==Introduction== Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model.

File:PerspectiveDSL..."