summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-08-22 07:53:36 (EDT)
committerStephan Born2012-08-22 07:53:36 (EDT)
commit4ad51ab1710662e732e6297a32760e0c337416a7 (patch)
tree920079e439c940af2c95d0cf88c75e080cfc0ced
parent8cb3051f6035be1fc99d255c5ecf16e4e1065d02 (diff)
downloadorg.eclipse.stardust.documentation-4ad51ab1710662e732e6297a32760e0c337416a7.zip
org.eclipse.stardust.documentation-4ad51ab1710662e732e6297a32760e0c337416a7.tar.gz
org.eclipse.stardust.documentation-4ad51ab1710662e732e6297a32760e0c337416a7.tar.bz2
CRNT-25044 - Added symbol behavior and handling
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@58609 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/doubl-clik.pngbin0 -> 2309 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hide.pngbin452 -> 11825 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-menu.pngbin0 -> 6279 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/lane-prop.pngbin5257 -> 6982 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/show.pngbin453 -> 2531 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/mg-pools-lanes.htm120
6 files changed, 96 insertions, 24 deletions
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/doubl-clik.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/doubl-clik.png
new file mode 100644
index 0000000..a76d98a
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/doubl-clik.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hide.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hide.png
index 4837586..a4aebab 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hide.png
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hide.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-menu.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-menu.png
new file mode 100644
index 0000000..4335ad3
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-menu.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/lane-prop.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/lane-prop.png
index f8e26a1..8508374 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/lane-prop.png
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/lane-prop.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/show.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/show.png
index 42dd5e4..8fdaa90 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/show.png
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/show.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/mg-pools-lanes.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/mg-pools-lanes.htm
index 5c5d5fd..ddf1f53 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/mg-pools-lanes.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/mg-pools-lanes.htm
@@ -34,6 +34,9 @@ The swim lanes are enabled by default for new process and contain a Default Pool
<li><a href="#col">Collapsing and Expanding Lanes</a></li>
</ul></li>
<li><a href="#prop">Viewing Lane Properties</a></li>
+ <li><a href="#sym">Symbols in Lanes</a></li>
+ <li><a href="#ges">Symbol Gestures</a></li>
+ <li><a href="#ele">Dragging and Dropping of Elements from Outline</a></li>
</ul>
@@ -43,7 +46,9 @@ The swim lanes are enabled by default for new process and contain a Default Pool
<strong>Figure:</strong> Swim Lanes</p>
<h2 id="pool">Default Pool</h2>
-<p>By default, the Default Pool is provided for modeling. It cannot be deleted or renamed.
+<p>A pool serves as a graphical container. By default, the Default Pool is provided for modeling.
+The default pool demarcates the diagram boundaries.
+It cannot be deleted or renamed.
It is not possible to create other pools in a process diagram.
The Default Pool contains a Default Lane. It must at least include one lane.
All lanes for a process should exist within the Default Pool.
@@ -51,12 +56,14 @@ You cannot add symbol directly to the Default Pool. If a symbol is dropped on th
the error message is displayed.
</p>
<h2 id="lane">Default Lane</h2>
-<p>By default, the Default Lane is provided inside the Default Pool. You can drop symbols only
+<p>By default, the Default Lane is provided inside the Default Pool.
+You can drop symbols only
inside lanes.</p>
<h3 id="create">Creating Lanes</h3>
-<p>To create a lane, click the icon <strong>Create Swimlane</strong> in the toolbar.
-The lane is added to the Default Pool and to the right of the last lane. The name to each newly added lane is assigned
+<p> A pool can have more than one lane. To create a lane, click the icon <strong>Create Swimlane</strong> in the toolbar.
+The lane is added to the Default Pool and to the right of the last lane.
+The name to each newly added lane is assigned
based on the sequence in which lanes are added. For example, Lane 2, Lane 3 , Lane 4 and so on.</p>
<p class="image"><img src="images/create-swim.png"
@@ -64,7 +71,8 @@ based on the sequence in which lanes are added. For example, Lane 2, Lane 3 , La
<strong>Figure:</strong> Swim Lane Icon</p>
<h3 id="fly">Lane Flyout Menu - Deleting Lane</h3>
-<p>The lane flyout menu - Delete Lane icon is displayed when you hover the mouse over the lane header or when the cursor is five to ten
+<p>The lane flyout menu - Delete Lane icon is displayed when you hover the mouse over the lane header or
+when the cursor is five to ten
pixels inside the four edges of the lane.
</p>
<p class="image"><img src="images/del-lane.png"
@@ -81,7 +89,7 @@ at least one lane should exist in the process model.
When you delete any lane, all symbols in the lane are deleted but the according elements still exist in the model.</p>
<p>Consider a scenario, where Default Lane, Lane 2 and Lane 3 exist in the model. Delete Default Lane and Lane 2 from the model.
-Now, only Lane 3 exist in the model. Delete Lane 3, too. Note that Lane 1 is created automatically.</p>
+Now, only Lane 3 exists in the model. Delete Lane 3, too. Note that Lane 1 is created automatically.</p>
<h3 id="col">Collapsing and Expanding Lanes</h3>
<p>Click the collapse lane icon displayed in the upper-right corner of the lane header to collapse the lane.
</p>
@@ -94,41 +102,105 @@ Now, only Lane 3 exist in the model. Delete Lane 3, too. Note that Lane 1 is cre
<strong>Figure:</strong> Expand Lane Icon</p>
<h2 id="prop">Viewing Lane Properties</h2>
<p>To view the properties of any lane, click the lane header. The properties of the lane are displayed
-at the right of the lanes. You can hide the property panel using the Hide Property Panel <img src="images/hide.png"> icon.
-Similarly, use the Show Property Panel <img src="images/show.png"> icon to view it again. </p>
+at the right of the lanes.
+
+ </p>
<p class="image"><img src="images/lane-prop.png"
alt="Lane Properties" /> <br>
<strong>Figure:</strong> Lane Properties</p>
<p>Following are the lane properties:</p>
<ul>
- <li>Name - Name of the lane.</li>
+ <li>UUID - A unique identifier ID gets generated as an identifier for client server communication.</li>
+ <li>ID - Default ID of the lane.</li>
+ <li>Name - Specify name of the lane.</li>
<li>Description - Specify the description.</li>
- <li>Participant - By default, None option is displayed. All the participants defined in the
+ <li>Participant - By default, <strong>None</strong> option is displayed. All the participants defined in the
loaded model are listed in this drop-down list.
To assign a lane participant, select any participant from the Participant drop-down list.
The selected participant name is reflected in lane header in parenthesis to the right of the lane name.
Activities automatically get the participant assignment of the lane they are residing in.
</li>
</ul>
-
-<h2>Symbols in Lanes</h2>
-<p>Symbols in Lanes
-All symbols of model elements like activities, applications, data and participants, are tied to lanes.
+<h3>Hide Property Panel </h3>
+<p>Click the <strong>Hide Property Panel</strong> icon displayed at the top right corner of the window.
+</p>
+<p class="image"><img src="images/hide.png"
+ alt="Hide Property Panel" /> <br>
+<strong>Figure:</strong> Hide Property Panel</p>
+
+<h3>Show Property Panel</h3>
+<p>Similarly, click the <strong>Show Property Panel</strong> icon to view it again.
+<p class="image"><img src="images/show.png"
+ alt="Show Property Panel" /> <br>
+<strong>Figure:</strong> Show Property Panel</p>
+
+<h2 id="sym">Symbols in Lanes</h2>
+<p>All symbols of model elements such as activities, applications, data and participants are tied to lanes.
Their entire bounding box fit into lanes. Newly created symbols are added in a lane.
-Existing symbols can be dragged into lanes, as described in the section Drag and Drop of Symbols between Lanes.
+Existing symbols can be dragged across lanes.
</p>
-<h3>Symbol Gesture</h3>
-<h4>Mouse Hover</h4>
-<h4>Double-click Symbol</h4>
-<h4>Clicking a Symbol</h4>
-<h4>Ctrl+click Symbol</h4>
-<h4>Click and Drag</h4>
-<p>Click on the symbol in the toolbar and place it in the lane. Then, click on symbol and drag it from one lane to any another lane.
+<h2 id="ges">Symbol Gestures</h2>
+<p>To work with symbols, you can use following gestures.</p>
+<h4>Clicking and Dragging a Symbol</h4>
+<p>Click on the symbol in the toolbar and place it in the lane.
+Then, click on symbol and drag it from one lane to any another lane.
The connections
-to symbols remains intact.</p>
-<h3>Drag and Drop Gesture</h3>
+to symbols remain intact.</p>
+<h4>Hovering the Mouse Over the Symbol</h4>
+<p>When you hover the mouse in the proximity of any symbol in the lane the Flyout Menu is displayed.
+Also, when you hover the mouser over the symbol its outline changes to red color.</p>
+ <p class="image"><img src="images/hover-menu.png"
+ alt="Mouse Hover - Flyout Menu" /> <br>
+<strong>Figure:</strong> Mouse Hover - Flyout Menu</p>
+<h4>Double-clicking Symbol</h4>
+<p>To rename the activity or subprocess activity and application, double-click on its symbol in the swim lane.
+</p>
+ <p class="image"><img src="images/doubl-clik.png"
+ alt="Double-click on Activity Symbol" /> <br>
+<strong>Figure:</strong> Double-click on Activity Symbol</p>
+
+<h4>Clicking a Symbol</h4>
+<p>When you click any symbol in the swim lane, the Property panel of that symbol is displayed at
+the right side of the swim lane. Also, the symbol gets selected and you can move the symbol across lanes.</p>
+
+
+<h2 id="ele">Dragging and Dropping of Elements from Outline</h2>
+<p>You can drag elements from model Outline and drop it on any swim lane in canvas.</p>
+<table>
+<tr>
+ <th>Element</th>
+ <th>Drop Target</th>
+ <th>Result</th>
+</tr>
+<tr>
+ <td>Structured Type</td>
+ <td>Swim Lane</td>
+ <td>Creates a new data of structured type</td>
+</tr>
+<tr>
+ <td>Data</td>
+ <td>Swim Lane</td>
+ <td>Adds data to the lane for connection</td>
+</tr>
+<tr>
+ <td>Application</td>
+ <td>Swim Lane</td>
+ <td>Creates new application activity</td>
+</tr>
+<tr>
+ <td>Participant</td>
+ <td>Swim Lane</td>
+ <td></td>
+</tr>
+<tr>
+ <td>Process</td>
+ <td>Swim Lane</td>
+ <td>Creates a subprocess activity</td>
+</tr>
+
+</table>