| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| |
| <head> |
| <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> |
| <title>Providing tool tips</title> |
| <link href="../book.css" rel="Stylesheet" type="text/css"> |
| <link href="../code.css" rel="Stylesheet" type="text/css"> |
| </head> |
| |
| <body> |
| |
| <h1>Providing Tooltips</h1> |
| <h2>Enhancing the Tool Behavior Provider</h2> |
| <p>Tooltips can be shown on top of active pictogram elements. A typical use case |
| is to show the name of pictogram elements or anything else you can get from the |
| business object.</p> |
| <p>The tooltips are defined in the tool behavior provider.</p> |
| <p>If you didn’t do so already you must <strong>first create a tool behavior provider |
| and add it to the diagram type provider as described </strong> |
| <a href="tool-behavior-provider.htm"><strong>here</strong></a>.</p> |
| <p>There is one method of the tool behavior provider to overwrite: </p> |
| <ul> |
| <li>The method |
| <a href="../../../javadoc/org/eclipse/graphiti/tb/IToolBehaviorProvider.html#getToolTip(org.eclipse.graphiti.mm.algorithms)"> |
| getToolTip</a> has to return the tooltip for the given graphics algorithm, which |
| is then attached to its graphical representation.</li> |
| </ul> |
| <p>In this example we want to show a tooltip for a EClass.</p> |
| <p> </p> |
| <p> |
| <img id="Bild 1" alt="" height="161" src="visio/tool-tip.png" width="158"></p> |
| <p><strong>Figure: Tooltip from EClass with name "Beton"</strong></p> |
| <p>You can see the complete implementation of the tooltip here:</p> |
| <!-- Begin code ------------------------------------------------------------------------------- --> |
| <p> </p> |
| <div class="literallayout"> |
| <div class="incode"> |
| <p class="code">@Override<br><span class="keyword">public</span> String |
| getToolTip(GraphicsAlgorithm ga) {<br> PictogramElement |
| pe = ga.getPictogramElement();<br> Object bo = getFeatureProvider().getBusinessObjectForPictogramElement(pe);<br> |
| <span class="keyword">if</span> (bo <span class="keyword">instanceof</span> |
| EClass) {<br> String name = ((EClass)bo).getName();<br> |
| <span class="keyword">if</span> (name != <span class="keyword">null</span> |
| && !name.isEmpty()) {<br> |
| <span class="keyword">return</span> name; |
| <br> }<br> }<br> |
| <span class="keyword">return super</span>.getToolTip(ga);<br>}<br></p> |
| </div> |
| </div> |
| <p> </p> |
| <!-- End code ------------------------------------------------------------------------------- --> |
| <p>Note: Because the tooltip is bound to a business object of the domain model, |
| every change of the business object will automatically update the tooltip.</p> |
| <h2>Test: Show Tooltip for EClass</h2> |
| <p>Remember, the name of an EClass should start with a upper case letter. Start |
| the editor and create a new EClass named "Anton". Hover over the shape and verify |
| that the tooltip is shown and the tooltip displays the name. Change the name of |
| the EClass to "Beton" and verify that it is displayed accordingly.</p> |
| <p> </p> |
| |
| </body> |
| |
| </html> |
