StandardContourToolTipGenerator.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  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>StandardContourToolTipGenerator (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="StandardContourToolTipGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":42,"i1":42};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/StandardContourToolTipGenerator.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/StandardCategoryToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/labels/StandardContourToolTipGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="StandardContourToolTipGenerator.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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="Class StandardContourToolTipGenerator" class="title">Class StandardContourToolTipGenerator</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.chart.labels.StandardContourToolTipGenerator</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable, <a href="../../../../org/jfree/chart/labels/ContourToolTipGenerator.html" title="interface in org.jfree.chart.labels">ContourToolTipGenerator</a></dd>
  113. </dl>
  114. <hr>
  115. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  116. <div class="block"><span class="deprecationComment">This class is no longer supported (as of version 1.0.4). If
  117. you are creating contour plots, please try to use <a href="../../../../org/jfree/chart/plot/XYPlot.html" title="class in org.jfree.chart.plot"><code>XYPlot</code></a> and
  118. <a href="../../../../org/jfree/chart/renderer/xy/XYBlockRenderer.html" title="class in org.jfree.chart.renderer.xy"><code>XYBlockRenderer</code></a>.</span></div>
  119. </div>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/chart/labels/StandardContourToolTipGenerator.html#line.63">StandardContourToolTipGenerator</a>
  122. extends java.lang.Object
  123. implements <a href="../../../../org/jfree/chart/labels/ContourToolTipGenerator.html" title="interface in org.jfree.chart.labels">ContourToolTipGenerator</a>, java.io.Serializable</pre>
  124. <div class="block">A standard tooltip generator for plots that use data from an
  125. <a href="../../../../org/jfree/data/contour/ContourDataset.html" title="interface in org.jfree.data.contour"><code>ContourDataset</code></a>.</div>
  126. <dl>
  127. <dt><span class="seeLabel">See Also:</span></dt>
  128. <dd><a href="../../../../serialized-form.html#org.jfree.chart.labels.StandardContourToolTipGenerator">Serialized Form</a></dd>
  129. </dl>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="summary">
  134. <ul class="blockList">
  135. <li class="blockList">
  136. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="constructor.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Constructor Summary</h3>
  142. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  143. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  144. <tr>
  145. <th class="colOne" scope="col">Constructor and Description</th>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardContourToolTipGenerator.html#StandardContourToolTipGenerator--">StandardContourToolTipGenerator</a></span>()</code>
  149. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  150. &nbsp;</td>
  151. </tr>
  152. </table>
  153. </li>
  154. </ul>
  155. <!-- ========== METHOD SUMMARY =========== -->
  156. <ul class="blockList">
  157. <li class="blockList"><a name="method.summary">
  158. <!-- -->
  159. </a>
  160. <h3>Method Summary</h3>
  161. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  162. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  163. <tr>
  164. <th class="colFirst" scope="col">Modifier and Type</th>
  165. <th class="colLast" scope="col">Method and Description</th>
  166. </tr>
  167. <tr id="i0" class="altColor">
  168. <td class="colFirst"><code>boolean</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardContourToolTipGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  170. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  171. <div class="block">Tests if this object is equal to another.</div>
  172. </td>
  173. </tr>
  174. <tr id="i1" class="rowColor">
  175. <td class="colFirst"><code>java.lang.String</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardContourToolTipGenerator.html#generateToolTip-org.jfree.data.contour.ContourDataset-int-">generateToolTip</a></span>(<a href="../../../../org/jfree/data/contour/ContourDataset.html" title="interface in org.jfree.data.contour">ContourDataset</a>&nbsp;data,
  177. int&nbsp;item)</code>
  178. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  179. <div class="block">Generates a tooltip text item for a particular item within a series.</div>
  180. </td>
  181. </tr>
  182. </table>
  183. <ul class="blockList">
  184. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  185. <!-- -->
  186. </a>
  187. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  188. <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </li>
  193. </ul>
  194. </div>
  195. <div class="details">
  196. <ul class="blockList">
  197. <li class="blockList">
  198. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  199. <ul class="blockList">
  200. <li class="blockList"><a name="constructor.detail">
  201. <!-- -->
  202. </a>
  203. <h3>Constructor Detail</h3>
  204. <a name="StandardContourToolTipGenerator--">
  205. <!-- -->
  206. </a>
  207. <ul class="blockListLast">
  208. <li class="blockList">
  209. <h4>StandardContourToolTipGenerator</h4>
  210. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardContourToolTipGenerator.html#line.63">StandardContourToolTipGenerator</a>()</pre>
  211. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  212. </li>
  213. </ul>
  214. </li>
  215. </ul>
  216. <!-- ============ METHOD DETAIL ========== -->
  217. <ul class="blockList">
  218. <li class="blockList"><a name="method.detail">
  219. <!-- -->
  220. </a>
  221. <h3>Method Detail</h3>
  222. <a name="generateToolTip-org.jfree.data.contour.ContourDataset-int-">
  223. <!-- -->
  224. </a>
  225. <ul class="blockList">
  226. <li class="blockList">
  227. <h4>generateToolTip</h4>
  228. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardContourToolTipGenerator.html#line.81">generateToolTip</a>(<a href="../../../../org/jfree/data/contour/ContourDataset.html" title="interface in org.jfree.data.contour">ContourDataset</a>&nbsp;data,
  229. int&nbsp;item)</pre>
  230. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  231. <div class="block">Generates a tooltip text item for a particular item within a series.</div>
  232. <dl>
  233. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  234. <dd><code><a href="../../../../org/jfree/chart/labels/ContourToolTipGenerator.html#generateToolTip-org.jfree.data.contour.ContourDataset-int-">generateToolTip</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/labels/ContourToolTipGenerator.html" title="interface in org.jfree.chart.labels">ContourToolTipGenerator</a></code></dd>
  235. <dt><span class="paramLabel">Parameters:</span></dt>
  236. <dd><code>data</code> - the dataset.</dd>
  237. <dd><code>item</code> - the item index (zero-based).</dd>
  238. <dt><span class="returnLabel">Returns:</span></dt>
  239. <dd>The tooltip text.</dd>
  240. </dl>
  241. </li>
  242. </ul>
  243. <a name="equals-java.lang.Object-">
  244. <!-- -->
  245. </a>
  246. <ul class="blockListLast">
  247. <li class="blockList">
  248. <h4>equals</h4>
  249. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardContourToolTipGenerator.html#line.121">equals</a>(java.lang.Object&nbsp;obj)</pre>
  250. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  251. <div class="block">Tests if this object is equal to another.</div>
  252. <dl>
  253. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  254. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  255. <dt><span class="paramLabel">Parameters:</span></dt>
  256. <dd><code>obj</code> - the other object.</dd>
  257. <dt><span class="returnLabel">Returns:</span></dt>
  258. <dd>A boolean.</dd>
  259. </dl>
  260. </li>
  261. </ul>
  262. </li>
  263. </ul>
  264. </li>
  265. </ul>
  266. </div>
  267. </div>
  268. <!-- ========= END OF CLASS DATA ========= -->
  269. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  270. <div class="bottomNav"><a name="navbar.bottom">
  271. <!-- -->
  272. </a>
  273. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  274. <a name="navbar.bottom.firstrow">
  275. <!-- -->
  276. </a>
  277. <ul class="navList" title="Navigation">
  278. <li><a href="../../../../overview-summary.html">Overview</a></li>
  279. <li><a href="package-summary.html">Package</a></li>
  280. <li class="navBarCell1Rev">Class</li>
  281. <li><a href="class-use/StandardContourToolTipGenerator.html">Use</a></li>
  282. <li><a href="package-tree.html">Tree</a></li>
  283. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  284. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  285. <li><a href="../../../../help-doc.html">Help</a></li>
  286. </ul>
  287. </div>
  288. <div class="subNav">
  289. <ul class="navList">
  290. <li><a href="../../../../org/jfree/chart/labels/StandardCategoryToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  291. <li><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  292. </ul>
  293. <ul class="navList">
  294. <li><a href="../../../../index.html?org/jfree/chart/labels/StandardContourToolTipGenerator.html" target="_top">Frames</a></li>
  295. <li><a href="StandardContourToolTipGenerator.html" target="_top">No&nbsp;Frames</a></li>
  296. </ul>
  297. <ul class="navList" id="allclasses_navbar_bottom">
  298. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  299. </ul>
  300. <div>
  301. <script type="text/javascript"><!--
  302. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  303. if(window==top) {
  304. allClassesLink.style.display = "block";
  305. }
  306. else {
  307. allClassesLink.style.display = "none";
  308. }
  309. //-->
  310. </script>
  311. </div>
  312. <div>
  313. <ul class="subNavList">
  314. <li>Summary:&nbsp;</li>
  315. <li>Nested&nbsp;|&nbsp;</li>
  316. <li>Field&nbsp;|&nbsp;</li>
  317. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  318. <li><a href="#method.summary">Method</a></li>
  319. </ul>
  320. <ul class="subNavList">
  321. <li>Detail:&nbsp;</li>
  322. <li>Field&nbsp;|&nbsp;</li>
  323. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  324. <li><a href="#method.detail">Method</a></li>
  325. </ul>
  326. </div>
  327. <a name="skip.navbar.bottom">
  328. <!-- -->
  329. </a></div>
  330. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  331. </body>
  332. </html>