XYZToolTipGenerator.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  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>XYZToolTipGenerator (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="XYZToolTipGenerator (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/XYZToolTipGenerator.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/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li>Next&nbsp;Class</li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/labels/XYZToolTipGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="XYZToolTipGenerator.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.labels</div>
  96. <h2 title="Interface XYZToolTipGenerator" class="title">Interface XYZToolTipGenerator</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Superinterfaces:</dt>
  104. <dd><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels">XYToolTipGenerator</a></dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Implementing Classes:</dt>
  108. <dd><a href="../../../../org/jfree/chart/labels/StandardXYZToolTipGenerator.html" title="class in org.jfree.chart.labels">StandardXYZToolTipGenerator</a></dd>
  109. </dl>
  110. <hr>
  111. <br>
  112. <pre>public interface <a href="../../../../src-html/org/jfree/chart/labels/XYZToolTipGenerator.html#line.51">XYZToolTipGenerator</a>
  113. extends <a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels">XYToolTipGenerator</a></pre>
  114. <div class="block">Interface for a tooltip generator for plots that use data from an
  115. <a href="../../../../org/jfree/data/xy/XYZDataset.html" title="interface in org.jfree.data.xy"><code>XYZDataset</code></a>.</div>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ========== METHOD SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="method.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Method Summary</h3>
  128. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  129. <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>
  130. <tr>
  131. <th class="colFirst" scope="col">Modifier and Type</th>
  132. <th class="colLast" scope="col">Method and Description</th>
  133. </tr>
  134. <tr id="i0" class="altColor">
  135. <td class="colFirst"><code>java.lang.String</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/XYZToolTipGenerator.html#generateToolTip-org.jfree.data.xy.XYZDataset-int-int-">generateToolTip</a></span>(<a href="../../../../org/jfree/data/xy/XYZDataset.html" title="interface in org.jfree.data.xy">XYZDataset</a>&nbsp;dataset,
  137. int&nbsp;series,
  138. int&nbsp;item)</code>
  139. <div class="block">Generates a tool tip text item for a particular item within a series.</div>
  140. </td>
  141. </tr>
  142. </table>
  143. <ul class="blockList">
  144. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.labels.XYToolTipGenerator">
  145. <!-- -->
  146. </a>
  147. <h3>Methods inherited from interface&nbsp;org.jfree.chart.labels.<a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels">XYToolTipGenerator</a></h3>
  148. <code><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html#generateToolTip-org.jfree.data.xy.XYDataset-int-int-">generateToolTip</a></code></li>
  149. </ul>
  150. </li>
  151. </ul>
  152. </li>
  153. </ul>
  154. </div>
  155. <div class="details">
  156. <ul class="blockList">
  157. <li class="blockList">
  158. <!-- ============ METHOD DETAIL ========== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="method.detail">
  161. <!-- -->
  162. </a>
  163. <h3>Method Detail</h3>
  164. <a name="generateToolTip-org.jfree.data.xy.XYZDataset-int-int-">
  165. <!-- -->
  166. </a>
  167. <ul class="blockListLast">
  168. <li class="blockList">
  169. <h4>generateToolTip</h4>
  170. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/XYZToolTipGenerator.html#line.62">generateToolTip</a>(<a href="../../../../org/jfree/data/xy/XYZDataset.html" title="interface in org.jfree.data.xy">XYZDataset</a>&nbsp;dataset,
  171. int&nbsp;series,
  172. int&nbsp;item)</pre>
  173. <div class="block">Generates a tool tip text item for a particular item within a series.</div>
  174. <dl>
  175. <dt><span class="paramLabel">Parameters:</span></dt>
  176. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  177. <dd><code>series</code> - the series index (zero-based).</dd>
  178. <dd><code>item</code> - the item index (zero-based).</dd>
  179. <dt><span class="returnLabel">Returns:</span></dt>
  180. <dd>The tooltip text (possibly <code>null</code>).</dd>
  181. </dl>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </li>
  187. </ul>
  188. </div>
  189. </div>
  190. <!-- ========= END OF CLASS DATA ========= -->
  191. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  192. <div class="bottomNav"><a name="navbar.bottom">
  193. <!-- -->
  194. </a>
  195. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  196. <a name="navbar.bottom.firstrow">
  197. <!-- -->
  198. </a>
  199. <ul class="navList" title="Navigation">
  200. <li><a href="../../../../overview-summary.html">Overview</a></li>
  201. <li><a href="package-summary.html">Package</a></li>
  202. <li class="navBarCell1Rev">Class</li>
  203. <li><a href="class-use/XYZToolTipGenerator.html">Use</a></li>
  204. <li><a href="package-tree.html">Tree</a></li>
  205. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  206. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  207. <li><a href="../../../../help-doc.html">Help</a></li>
  208. </ul>
  209. </div>
  210. <div class="subNav">
  211. <ul class="navList">
  212. <li><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  213. <li>Next&nbsp;Class</li>
  214. </ul>
  215. <ul class="navList">
  216. <li><a href="../../../../index.html?org/jfree/chart/labels/XYZToolTipGenerator.html" target="_top">Frames</a></li>
  217. <li><a href="XYZToolTipGenerator.html" target="_top">No&nbsp;Frames</a></li>
  218. </ul>
  219. <ul class="navList" id="allclasses_navbar_bottom">
  220. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  221. </ul>
  222. <div>
  223. <script type="text/javascript"><!--
  224. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  225. if(window==top) {
  226. allClassesLink.style.display = "block";
  227. }
  228. else {
  229. allClassesLink.style.display = "none";
  230. }
  231. //-->
  232. </script>
  233. </div>
  234. <div>
  235. <ul class="subNavList">
  236. <li>Summary:&nbsp;</li>
  237. <li>Nested&nbsp;|&nbsp;</li>
  238. <li>Field&nbsp;|&nbsp;</li>
  239. <li>Constr&nbsp;|&nbsp;</li>
  240. <li><a href="#method.summary">Method</a></li>
  241. </ul>
  242. <ul class="subNavList">
  243. <li>Detail:&nbsp;</li>
  244. <li>Field&nbsp;|&nbsp;</li>
  245. <li>Constr&nbsp;|&nbsp;</li>
  246. <li><a href="#method.detail">Method</a></li>
  247. </ul>
  248. </div>
  249. <a name="skip.navbar.bottom">
  250. <!-- -->
  251. </a></div>
  252. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  253. </body>
  254. </html>