Stephan Herrmann | 0166441 | 2010-04-01 20:28:43 +0000 | [diff] [blame] | 1 | <html> |
| 2 | <head> |
| 3 | <meta name="copyright" content="Copyright Technical University Berlin and others 2004, 2010. This page is made available under the Eclipse Public License v1.0. For full details see http://www.eclipse.org/legal/epl-v10.html" /> |
| 4 | <link rel=stylesheet type="text/css" href="../css/book.css"> |
| 5 | <title>Team and role creation wizards</title> |
| 6 | <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| 7 | <style type="text/css"> |
| 8 | h2 {color: orange} |
| 9 | h3 {color: blue} |
| 10 | h4 {color: brown} |
| 11 | </style> |
| 12 | </head> |
| 13 | <body> |
| 14 | <h1>Team and role creation wizards</h1> |
| 15 | <h2>Team wizard</h2> |
| 16 | <p> |
| 17 | <img src="images/screenshots/teamWizard.jpg" |
| 18 | alt="Wizard for creating a new team class"> |
| 19 | </p> |
| 20 | <h3>Opening the team wizard</h3> |
| 21 | The easiest way to create a new team class is to use the team wizard. |
| 22 | First select the container where you want the new team class to reside. |
| 23 | Then the wizard can be opened either by selecting <b>File > New > Team</b> from the main |
| 24 | workbench window or by selecting <b>New > Team</b> from the container's pop-up menu or |
| 25 | by choosing <b>Team</b> from the drop-down menu on the <b>New</b> button in the |
| 26 | workbench toolbar. |
| 27 | <h3>Define settings / enter information</h3> |
| 28 | Most settings for a new team correspond exactly to those specified for a regular |
| 29 | <a href="/help/topic/org.eclipse.jdt.doc.user/reference/ref-126.htm">Java class</a>. |
| 30 | <h4>Edit using the Binding Editor</h4> |
| 31 | If a super-team has been selected and if the team should be constructed as a <i>connector</i> |
| 32 | the binding editor can be launched for adding class and method bindings. |
| 33 | <h3>Resulting effects</h3> |
| 34 | By clicking the <b>Finish</b> button the team is created with the chosen properties. |
| 35 | The tree view of the package explorer and the outline is updated and the new team is |
| 36 | displayed.<br><br> |
| 37 | <h2>Role wizard</h2> |
| 38 | <p> |
| 39 | <img src="images/screenshots/roleWizard.jpg" |
| 40 | alt="Wizard for creating a new role class"> |
Stephan Herrmann | 2be84c1 | 2012-06-04 01:02:48 +0200 | [diff] [blame] | 41 | </p> |
Stephan Herrmann | 0166441 | 2010-04-01 20:28:43 +0000 | [diff] [blame] | 42 | <h3>Opening the role wizard</h3> |
| 43 | The easiest way to create a new role class is to use the role wizard. |
| 44 | First select the container where you want the new role class to reside. |
| 45 | Then the wizard can be opened either by selecting <b>File > New > Role</b> from the main |
| 46 | workbench window or by selecting <b>New > Role</b> from the container's pop-up menu or |
| 47 | by choosing <b>Role</b> from the drop-down menu on the <b>New</b> button in the |
| 48 | workbench toolbar. |
| 49 | <h3>Define settings / enter information</h3> |
| 50 | <h4>Source folder and enclosing team</h4> |
| 51 | The fields of the source folder and the enclosing team incorporate the same semantics |
| 52 | as in the team creation wizard. Entries can be modified/changed by clicking the |
| 53 | respective <b>Browse...</b> button and choosing a folder and team class in the selection |
| 54 | dialog respectively. The fully qualified name of the enclosing team is displayed unless |
| 55 | it stands in the default package. A role is inlined by default, i.e. a role is defined |
| 56 | inside the specified enclosing team. If an external role should be created the checkbox |
Stephan Herrmann | 2be84c1 | 2012-06-04 01:02:48 +0200 | [diff] [blame] | 57 | "inlined" has to be deselected |
| 58 | (<a href="otjld/def/s1.html#s1.2.5"><img src="../images/ot_paragraph.png"> OTJLD §1.2.5</a>).<br> |
Stephan Herrmann | 0166441 | 2010-04-01 20:28:43 +0000 | [diff] [blame] | 59 | <h4>Role name</h4> |
| 60 | A valid name for the new role class must be entered. The type name is mandatory.<br> |
| 61 | <h4>Modifiers</h4> |
| 62 | Possible visibility modifiers for role types are <code>public</code> and |
| 63 | <code>protected</code>. Roles can also be either <code>abstract</code> or |
| 64 | <code>final</code>.<br> |
| 65 | <h4>Implicit superclass</h4> |
| 66 | The implicit superclass field is set automatically if the entered type name matches a |
| 67 | role type which already exists in a team class which is present in the supertype |
Stephan Herrmann | 2be84c1 | 2012-06-04 01:02:48 +0200 | [diff] [blame] | 68 | hierarchy of the enclosing team |
| 69 | (<a href="otjld/def/s1.html#s1.3.1"><img src="../images/ot_paragraph.png"> OTJLD §1.3.1</a>). |
| 70 | The fully qualified name of the implicit superclass is then shown.<br> |
Stephan Herrmann | 0166441 | 2010-04-01 20:28:43 +0000 | [diff] [blame] | 71 | <h4>Explicit superclass</h4> |
| 72 | Initially the explicit superclass is set to "java.lang.Object". It can be changed by |
| 73 | clicking the <b>Browse...</b> button and selecting a class from the selection dialog. |
| 74 | A role can explicitly inherit from another role class of the same team or from any other |
| 75 | regular class other than team classes.<br> |
| 76 | <h4>Bound base class</h4> |
| 77 | A bound base class can be defined by clicking the <b>Browse...</b> button and selecting |
Stephan Herrmann | 2be84c1 | 2012-06-04 01:02:48 +0200 | [diff] [blame] | 78 | a class from the selection dialog. A bound base class can be any class. |
| 79 | (<a href="otjld/def/s2.html#s2.1"><img src="../images/ot_paragraph.png"> OTJLD §2.1</a>)<br> |
Stephan Herrmann | 0166441 | 2010-04-01 20:28:43 +0000 | [diff] [blame] | 80 | <h4>Interfaces</h4> |
| 81 | Interfaces which the role should implement can be added/removed with the <b>Add.../ |
| 82 | Remove</b> buttons. |
| 83 | <h4>Method stubs</h4> |
| 84 | Method stubs for inherited abstract methods can be created by selecting the according |
Stephan Herrmann | 2be84c1 | 2012-06-04 01:02:48 +0200 | [diff] [blame] | 85 | checkbox. Note, that this option includes those abstract methods that are inherited |
| 86 | from an implicit super role |
| 87 | (<a href="otjld/def/s1.html#s1.3.1"><img src="../images/ot_paragraph.png"> OTJLD §1.3.1</a>). |
| 88 | </p> |
| 89 | The checkbox is selected by default. |
Stephan Herrmann | 0166441 | 2010-04-01 20:28:43 +0000 | [diff] [blame] | 90 | <h3>Resulting effects</h3> |
| 91 | By clicking the <b>Finish</b> button the role with the chosen properties is created |
| 92 | inside the enclosing team, or, in the case of an external role, in a package which has |
| 93 | the name of the enclosing team. The tree view of the package explorer and the outline |
| 94 | is updated and the new role is displayed. |
| 95 | </body> |
| 96 | </html> |