ToolTipTagFragmentGenerator.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:31 CEST 2014 -->
  6. <title>ToolTipTagFragmentGenerator (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="ToolTipTagFragmentGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/ToolTipTagFragmentGenerator.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/chart/imagemap/StandardURLTagFragmentGenerator.html" title="class in org.jfree.chart.imagemap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/imagemap/URLTagFragmentGenerator.html" title="interface in org.jfree.chart.imagemap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="ToolTipTagFragmentGenerator.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li>Constr&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li>Constr&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart.imagemap</div>
  96. <h2 title="Interface ToolTipTagFragmentGenerator" class="title">Interface ToolTipTagFragmentGenerator</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/chart/imagemap/DynamicDriveToolTipTagFragmentGenerator.html" title="class in org.jfree.chart.imagemap">DynamicDriveToolTipTagFragmentGenerator</a>, <a href="../../../../org/jfree/chart/imagemap/OverLIBToolTipTagFragmentGenerator.html" title="class in org.jfree.chart.imagemap">OverLIBToolTipTagFragmentGenerator</a>, <a href="../../../../org/jfree/chart/imagemap/StandardToolTipTagFragmentGenerator.html" title="class in org.jfree.chart.imagemap">StandardToolTipTagFragmentGenerator</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html#line.47">ToolTipTagFragmentGenerator</a></pre>
  109. <div class="block">Interface for generating the tooltip fragment of an HTML image map area tag.
  110. The fragment should be <code>XHTML 1.0</code> compliant.</div>
  111. </li>
  112. </ul>
  113. </div>
  114. <div class="summary">
  115. <ul class="blockList">
  116. <li class="blockList">
  117. <!-- ========== METHOD SUMMARY =========== -->
  118. <ul class="blockList">
  119. <li class="blockList"><a name="method.summary">
  120. <!-- -->
  121. </a>
  122. <h3>Method Summary</h3>
  123. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  124. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  125. <tr>
  126. <th class="colFirst" scope="col">Modifier and Type</th>
  127. <th class="colLast" scope="col">Method and Description</th>
  128. </tr>
  129. <tr id="i0" class="altColor">
  130. <td class="colFirst"><code>java.lang.String</code></td>
  131. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html#generateToolTipFragment-java.lang.String-">generateToolTipFragment</a></span>(java.lang.String&nbsp;toolTipText)</code>
  132. <div class="block">Generates a tooltip string to go in an HTML image map.</div>
  133. </td>
  134. </tr>
  135. </table>
  136. </li>
  137. </ul>
  138. </li>
  139. </ul>
  140. </div>
  141. <div class="details">
  142. <ul class="blockList">
  143. <li class="blockList">
  144. <!-- ============ METHOD DETAIL ========== -->
  145. <ul class="blockList">
  146. <li class="blockList"><a name="method.detail">
  147. <!-- -->
  148. </a>
  149. <h3>Method Detail</h3>
  150. <a name="generateToolTipFragment-java.lang.String-">
  151. <!-- -->
  152. </a>
  153. <ul class="blockListLast">
  154. <li class="blockList">
  155. <h4>generateToolTipFragment</h4>
  156. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html#line.63">generateToolTipFragment</a>(java.lang.String&nbsp;toolTipText)</pre>
  157. <div class="block">Generates a tooltip string to go in an HTML image map. To allow for
  158. varying standards compliance among browsers, this method is expected
  159. to return an 'alt' attribute IN ADDITION TO whatever it does to create
  160. the tooltip (often a 'title' attribute).
  161. <br><br>
  162. Note that the <code>toolTipText</code> may have been generated from
  163. user-defined data, so care should be taken to filter/escape any
  164. characters that may corrupt the HTML tag.</div>
  165. <dl>
  166. <dt><span class="paramLabel">Parameters:</span></dt>
  167. <dd><code>toolTipText</code> - the tooltip.</dd>
  168. <dt><span class="returnLabel">Returns:</span></dt>
  169. <dd>The formatted HTML area tag attribute(s).</dd>
  170. </dl>
  171. </li>
  172. </ul>
  173. </li>
  174. </ul>
  175. </li>
  176. </ul>
  177. </div>
  178. </div>
  179. <!-- ========= END OF CLASS DATA ========= -->
  180. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  181. <div class="bottomNav"><a name="navbar.bottom">
  182. <!-- -->
  183. </a>
  184. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  185. <a name="navbar.bottom.firstrow">
  186. <!-- -->
  187. </a>
  188. <ul class="navList" title="Navigation">
  189. <li><a href="../../../../overview-summary.html">Overview</a></li>
  190. <li><a href="package-summary.html">Package</a></li>
  191. <li class="navBarCell1Rev">Class</li>
  192. <li><a href="class-use/ToolTipTagFragmentGenerator.html">Use</a></li>
  193. <li><a href="package-tree.html">Tree</a></li>
  194. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  195. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  196. <li><a href="../../../../help-doc.html">Help</a></li>
  197. </ul>
  198. </div>
  199. <div class="subNav">
  200. <ul class="navList">
  201. <li><a href="../../../../org/jfree/chart/imagemap/StandardURLTagFragmentGenerator.html" title="class in org.jfree.chart.imagemap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  202. <li><a href="../../../../org/jfree/chart/imagemap/URLTagFragmentGenerator.html" title="interface in org.jfree.chart.imagemap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  203. </ul>
  204. <ul class="navList">
  205. <li><a href="../../../../index.html?org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html" target="_top">Frames</a></li>
  206. <li><a href="ToolTipTagFragmentGenerator.html" target="_top">No&nbsp;Frames</a></li>
  207. </ul>
  208. <ul class="navList" id="allclasses_navbar_bottom">
  209. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  210. </ul>
  211. <div>
  212. <script type="text/javascript"><!--
  213. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  214. if(window==top) {
  215. allClassesLink.style.display = "block";
  216. }
  217. else {
  218. allClassesLink.style.display = "none";
  219. }
  220. //-->
  221. </script>
  222. </div>
  223. <div>
  224. <ul class="subNavList">
  225. <li>Summary:&nbsp;</li>
  226. <li>Nested&nbsp;|&nbsp;</li>
  227. <li>Field&nbsp;|&nbsp;</li>
  228. <li>Constr&nbsp;|&nbsp;</li>
  229. <li><a href="#method.summary">Method</a></li>
  230. </ul>
  231. <ul class="subNavList">
  232. <li>Detail:&nbsp;</li>
  233. <li>Field&nbsp;|&nbsp;</li>
  234. <li>Constr&nbsp;|&nbsp;</li>
  235. <li><a href="#method.detail">Method</a></li>
  236. </ul>
  237. </div>
  238. <a name="skip.navbar.bottom">
  239. <!-- -->
  240. </a></div>
  241. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  242. </body>
  243. </html>