blob: 9e96af43aad8c53fedd196c643a8f6964b88fdf2 [file] [log] [blame]
Stephan Herrmann01664412010-04-01 20:28:43 +00001<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" />
4 <link rel=stylesheet type="text/css" href="../css/book.css">
5 <link rel=stylesheet type="text/css" href="otjld/css/ot.css">
6 <link rel=stylesheet type="text/css" href="otguide.css">
7 <style type="text/css">
8 body { margin:10px; }
9 .high { background-color:#a5b7bd;color:white; }
10 .low { background-color:#fff0c8; padding:2px; }
11 .caption { text-decoration:underline; vertical-align:top;position:relative;top:20px; margin-top:10px;}
12 </style>
13 <title>Binding markers</title>
14 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
15 </head>
16 <body>
17 <h1>Binding markers</h1>
18 <p><b>Binding</b> <a href="/help/topic/org.eclipse.platform.doc.user/concepts/concepts-11.htm">
19 markers</a> are OT/J specific annotations on the vertical ruler (marker bar) left of the
20 extended <a href="editor.html">Java Editor</a>. These markers come in three flavors:
21 <ul>
22 <li>A <b>playedBy marker</b> <img src="../images/playedBy_obj.gif"> signals that one or more roles is bound
23 to the current class using <code class="keyword">playedBy</code> (<a href="otjld/def/s2.html#s2.1"><img src="../icons/ot_paragraph.gif"> 2.1</a>).</li>
24 <li>A <b>callin marker</b> <img src="../images/callinbinding_obj.gif"> signals that one or more callin bindings
25 (<a href="otjld/def/s4.html#s4"><img src="../icons/ot_paragraph.gif"> 4</a>) affect the given base method.
26 <li>A <b>callout marker</b> <img src="../images/callout_marker.gif"> signals that one or more callout bindings (<a href="otjld/def/s3.html#s3"><img src="../icons/ot_paragraph.gif"> 3</a>)
27 affect the given base method <b>and</b> that these callout bindings apply decapsulation
28 (<a href="otjld/def/s3.html#s3.4"><img src="../icons/ot_paragraph.gif"> 3.4</a>)
29 &mdash;&nbsp;(callout bindings <em>without</em> decapsulation are ranked like regular method calls
30 and thus not considered relevant for marking in the ruler).
31 </ul>
32 <table>
33 <tr><td class="caption">PlayedBy and callin markers</td>
34 <td><img src="images/screenshots/callinmarkers.png"
35 alt="Callin marker annotation in vertical ruler (marker bar)">
36 </tr>
37 <tr><td class="caption">Callout decapsulation marker</td>
38 <td><img src="images/screenshots/calloutmarker.png"
39 alt="Callout decapsulation marker annotation in vertical ruler (marker bar)">
40 </tr>
41 </table>
42 <p>
43 Aside from raising awareness of these bindings, the markers can also be used to directly
44 navigate to the corresponding role or callin/callout binding.
45 When right clicking on a binding marker a pop-up menu will open which contains
46 a corresponding submenu <span class="ui">OT/J bound roles</span>, or <span class="ui">OT/J callin bindings</span>, or <span class="ui">OT/J callout decapsulation</span>.
47 This submenu in turn holds all bindings relevant at the current position,
48 sorted by teams.
49 </p>
50 <table>
51 <tr><td class="caption">PlayedBy marker menu
52 <td><img src="images/screenshots/callinmarker-menu.png"
53 alt="PlayedBy marker menu">
54 </tr>
55 <tr><td class="caption">Callin marker menu
56 <td><img src="images/screenshots/callinmarker-menu3.png"
57 alt="Callin marker menu">
58 </tr>
59 </table>
60 <p>
61 Binding markers are enabled/disabled globally on the <span class="ui">Object Teams</span> preference page.<br>
62 Detailed configuration is possible via <span class="ui">Window->Preferences->General->Editors->Text Editors->Annotations</span>
63 </p>
64 </body>