StandardXYToolTipGenerator.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552
  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>StandardXYToolTipGenerator (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="StandardXYToolTipGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/StandardXYToolTipGenerator.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/StandardXYSeriesLabelGenerator.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/StandardXYZToolTipGenerator.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/StandardXYToolTipGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="StandardXYToolTipGenerator.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 StandardXYToolTipGenerator" class="title">Class StandardXYToolTipGenerator</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><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">org.jfree.chart.labels.AbstractXYItemLabelGenerator</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.labels.StandardXYToolTipGenerator</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.Serializable, java.lang.Cloneable, <a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels">XYToolTipGenerator</a>, org.jfree.util.PublicCloneable</dd>
  118. </dl>
  119. <dl>
  120. <dt>Direct Known Subclasses:</dt>
  121. <dd><a href="../../../../org/jfree/chart/labels/BoxAndWhiskerXYToolTipGenerator.html" title="class in org.jfree.chart.labels">BoxAndWhiskerXYToolTipGenerator</a>, <a href="../../../../org/jfree/chart/labels/StandardXYZToolTipGenerator.html" title="class in org.jfree.chart.labels">StandardXYZToolTipGenerator</a></dd>
  122. </dl>
  123. <hr>
  124. <br>
  125. <pre>public class <a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.56">StandardXYToolTipGenerator</a>
  126. extends <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractXYItemLabelGenerator</a>
  127. implements <a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels">XYToolTipGenerator</a>, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  128. <div class="block">A standard tool tip generator for use with an
  129. <a href="../../../../org/jfree/chart/renderer/xy/XYItemRenderer.html" title="interface in org.jfree.chart.renderer.xy"><code>XYItemRenderer</code></a>.</div>
  130. <dl>
  131. <dt><span class="seeLabel">See Also:</span></dt>
  132. <dd><a href="../../../../serialized-form.html#org.jfree.chart.labels.StandardXYToolTipGenerator">Serialized Form</a></dd>
  133. </dl>
  134. </li>
  135. </ul>
  136. </div>
  137. <div class="summary">
  138. <ul class="blockList">
  139. <li class="blockList">
  140. <!-- =========== FIELD SUMMARY =========== -->
  141. <ul class="blockList">
  142. <li class="blockList"><a name="field.summary">
  143. <!-- -->
  144. </a>
  145. <h3>Field Summary</h3>
  146. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  147. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  148. <tr>
  149. <th class="colFirst" scope="col">Modifier and Type</th>
  150. <th class="colLast" scope="col">Field and Description</th>
  151. </tr>
  152. <tr class="altColor">
  153. <td class="colFirst"><code>static java.lang.String</code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#DEFAULT_TOOL_TIP_FORMAT">DEFAULT_TOOL_TIP_FORMAT</a></span></code>
  155. <div class="block">The default tooltip format.</div>
  156. </td>
  157. </tr>
  158. </table>
  159. </li>
  160. </ul>
  161. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  162. <ul class="blockList">
  163. <li class="blockList"><a name="constructor.summary">
  164. <!-- -->
  165. </a>
  166. <h3>Constructor Summary</h3>
  167. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  168. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  169. <tr>
  170. <th class="colOne" scope="col">Constructor and Description</th>
  171. </tr>
  172. <tr class="altColor">
  173. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#StandardXYToolTipGenerator--">StandardXYToolTipGenerator</a></span>()</code>
  174. <div class="block">Creates a tool tip generator using default number formatters.</div>
  175. </td>
  176. </tr>
  177. <tr class="rowColor">
  178. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#StandardXYToolTipGenerator-java.lang.String-java.text.DateFormat-java.text.DateFormat-">StandardXYToolTipGenerator</a></span>(java.lang.String&nbsp;formatString,
  179. java.text.DateFormat&nbsp;xFormat,
  180. java.text.DateFormat&nbsp;yFormat)</code>
  181. <div class="block">Creates a tool tip generator using the specified date formatters.</div>
  182. </td>
  183. </tr>
  184. <tr class="altColor">
  185. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#StandardXYToolTipGenerator-java.lang.String-java.text.DateFormat-java.text.NumberFormat-">StandardXYToolTipGenerator</a></span>(java.lang.String&nbsp;formatString,
  186. java.text.DateFormat&nbsp;xFormat,
  187. java.text.NumberFormat&nbsp;yFormat)</code>
  188. <div class="block">Creates a tool tip generator using the specified number formatters.</div>
  189. </td>
  190. </tr>
  191. <tr class="rowColor">
  192. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#StandardXYToolTipGenerator-java.lang.String-java.text.NumberFormat-java.text.DateFormat-">StandardXYToolTipGenerator</a></span>(java.lang.String&nbsp;formatString,
  193. java.text.NumberFormat&nbsp;xFormat,
  194. java.text.DateFormat&nbsp;yFormat)</code>
  195. <div class="block">Creates a tool tip generator using the specified formatters (a
  196. number formatter for the x-values and a date formatter for the
  197. y-values).</div>
  198. </td>
  199. </tr>
  200. <tr class="altColor">
  201. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#StandardXYToolTipGenerator-java.lang.String-java.text.NumberFormat-java.text.NumberFormat-">StandardXYToolTipGenerator</a></span>(java.lang.String&nbsp;formatString,
  202. java.text.NumberFormat&nbsp;xFormat,
  203. java.text.NumberFormat&nbsp;yFormat)</code>
  204. <div class="block">Creates a tool tip generator using the specified number formatters.</div>
  205. </td>
  206. </tr>
  207. </table>
  208. </li>
  209. </ul>
  210. <!-- ========== METHOD SUMMARY =========== -->
  211. <ul class="blockList">
  212. <li class="blockList"><a name="method.summary">
  213. <!-- -->
  214. </a>
  215. <h3>Method Summary</h3>
  216. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  217. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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></caption>
  218. <tr>
  219. <th class="colFirst" scope="col">Modifier and Type</th>
  220. <th class="colLast" scope="col">Method and Description</th>
  221. </tr>
  222. <tr id="i0" class="altColor">
  223. <td class="colFirst"><code>java.lang.Object</code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#clone--">clone</a></span>()</code>
  225. <div class="block">Returns an independent copy of the generator.</div>
  226. </td>
  227. </tr>
  228. <tr id="i1" class="rowColor">
  229. <td class="colFirst"><code>boolean</code></td>
  230. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  231. <div class="block">Tests this object for equality with an arbitrary object.</div>
  232. </td>
  233. </tr>
  234. <tr id="i2" class="altColor">
  235. <td class="colFirst"><code>java.lang.String</code></td>
  236. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#generateToolTip-org.jfree.data.xy.XYDataset-int-int-">generateToolTip</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  237. int&nbsp;series,
  238. int&nbsp;item)</code>
  239. <div class="block">Generates the tool tip text for an item in a dataset.</div>
  240. </td>
  241. </tr>
  242. <tr id="i3" class="rowColor">
  243. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html" title="class in org.jfree.chart.labels">StandardXYToolTipGenerator</a></code></td>
  244. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html#getTimeSeriesInstance--">getTimeSeriesInstance</a></span>()</code>
  245. <div class="block">Returns a tool tip generator that formats the x-values as dates and the
  246. y-values as numbers.</div>
  247. </td>
  248. </tr>
  249. </table>
  250. <ul class="blockList">
  251. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.labels.AbstractXYItemLabelGenerator">
  252. <!-- -->
  253. </a>
  254. <h3>Methods inherited from class&nbsp;org.jfree.chart.labels.<a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractXYItemLabelGenerator</a></h3>
  255. <code><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#createItemArray-org.jfree.data.xy.XYDataset-int-int-">createItemArray</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#generateLabelString-org.jfree.data.xy.XYDataset-int-int-">generateLabelString</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getFormatString--">getFormatString</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getNullYString--">getNullYString</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getXDateFormat--">getXDateFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getXFormat--">getXFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getYDateFormat--">getYDateFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getYFormat--">getYFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#hashCode--">hashCode</a></code></li>
  256. </ul>
  257. <ul class="blockList">
  258. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  259. <!-- -->
  260. </a>
  261. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  262. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  263. </ul>
  264. </li>
  265. </ul>
  266. </li>
  267. </ul>
  268. </div>
  269. <div class="details">
  270. <ul class="blockList">
  271. <li class="blockList">
  272. <!-- ============ FIELD DETAIL =========== -->
  273. <ul class="blockList">
  274. <li class="blockList"><a name="field.detail">
  275. <!-- -->
  276. </a>
  277. <h3>Field Detail</h3>
  278. <a name="DEFAULT_TOOL_TIP_FORMAT">
  279. <!-- -->
  280. </a>
  281. <ul class="blockListLast">
  282. <li class="blockList">
  283. <h4>DEFAULT_TOOL_TIP_FORMAT</h4>
  284. <pre>public static final&nbsp;java.lang.String <a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.64">DEFAULT_TOOL_TIP_FORMAT</a></pre>
  285. <div class="block">The default tooltip format.</div>
  286. <dl>
  287. <dt><span class="seeLabel">See Also:</span></dt>
  288. <dd><a href="../../../../constant-values.html#org.jfree.chart.labels.StandardXYToolTipGenerator.DEFAULT_TOOL_TIP_FORMAT">Constant Field Values</a></dd>
  289. </dl>
  290. </li>
  291. </ul>
  292. </li>
  293. </ul>
  294. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  295. <ul class="blockList">
  296. <li class="blockList"><a name="constructor.detail">
  297. <!-- -->
  298. </a>
  299. <h3>Constructor Detail</h3>
  300. <a name="StandardXYToolTipGenerator--">
  301. <!-- -->
  302. </a>
  303. <ul class="blockList">
  304. <li class="blockList">
  305. <h4>StandardXYToolTipGenerator</h4>
  306. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.80">StandardXYToolTipGenerator</a>()</pre>
  307. <div class="block">Creates a tool tip generator using default number formatters.</div>
  308. </li>
  309. </ul>
  310. <a name="StandardXYToolTipGenerator-java.lang.String-java.text.NumberFormat-java.text.NumberFormat-">
  311. <!-- -->
  312. </a>
  313. <ul class="blockList">
  314. <li class="blockList">
  315. <h4>StandardXYToolTipGenerator</h4>
  316. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.95">StandardXYToolTipGenerator</a>(java.lang.String&nbsp;formatString,
  317. java.text.NumberFormat&nbsp;xFormat,
  318. java.text.NumberFormat&nbsp;yFormat)</pre>
  319. <div class="block">Creates a tool tip generator using the specified number formatters.</div>
  320. <dl>
  321. <dt><span class="paramLabel">Parameters:</span></dt>
  322. <dd><code>formatString</code> - the item label format string (<code>null</code> not
  323. permitted).</dd>
  324. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  325. not permitted).</dd>
  326. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  327. not permitted).</dd>
  328. </dl>
  329. </li>
  330. </ul>
  331. <a name="StandardXYToolTipGenerator-java.lang.String-java.text.DateFormat-java.text.NumberFormat-">
  332. <!-- -->
  333. </a>
  334. <ul class="blockList">
  335. <li class="blockList">
  336. <h4>StandardXYToolTipGenerator</h4>
  337. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.112">StandardXYToolTipGenerator</a>(java.lang.String&nbsp;formatString,
  338. java.text.DateFormat&nbsp;xFormat,
  339. java.text.NumberFormat&nbsp;yFormat)</pre>
  340. <div class="block">Creates a tool tip generator using the specified number formatters.</div>
  341. <dl>
  342. <dt><span class="paramLabel">Parameters:</span></dt>
  343. <dd><code>formatString</code> - the label format string (<code>null</code> not
  344. permitted).</dd>
  345. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  346. not permitted).</dd>
  347. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  348. not permitted).</dd>
  349. </dl>
  350. </li>
  351. </ul>
  352. <a name="StandardXYToolTipGenerator-java.lang.String-java.text.NumberFormat-java.text.DateFormat-">
  353. <!-- -->
  354. </a>
  355. <ul class="blockList">
  356. <li class="blockList">
  357. <h4>StandardXYToolTipGenerator</h4>
  358. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.133">StandardXYToolTipGenerator</a>(java.lang.String&nbsp;formatString,
  359. java.text.NumberFormat&nbsp;xFormat,
  360. java.text.DateFormat&nbsp;yFormat)</pre>
  361. <div class="block">Creates a tool tip generator using the specified formatters (a
  362. number formatter for the x-values and a date formatter for the
  363. y-values).</div>
  364. <dl>
  365. <dt><span class="paramLabel">Parameters:</span></dt>
  366. <dd><code>formatString</code> - the item label format string (<code>null</code>
  367. not permitted).</dd>
  368. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  369. permitted).</dd>
  370. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  371. not permitted).</dd>
  372. <dt><span class="simpleTagLabel">Since:</span></dt>
  373. <dd>1.0.4</dd>
  374. </dl>
  375. </li>
  376. </ul>
  377. <a name="StandardXYToolTipGenerator-java.lang.String-java.text.DateFormat-java.text.DateFormat-">
  378. <!-- -->
  379. </a>
  380. <ul class="blockListLast">
  381. <li class="blockList">
  382. <h4>StandardXYToolTipGenerator</h4>
  383. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.148">StandardXYToolTipGenerator</a>(java.lang.String&nbsp;formatString,
  384. java.text.DateFormat&nbsp;xFormat,
  385. java.text.DateFormat&nbsp;yFormat)</pre>
  386. <div class="block">Creates a tool tip generator using the specified date formatters.</div>
  387. <dl>
  388. <dt><span class="paramLabel">Parameters:</span></dt>
  389. <dd><code>formatString</code> - the label format string (<code>null</code> not
  390. permitted).</dd>
  391. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  392. not permitted).</dd>
  393. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  394. not permitted).</dd>
  395. </dl>
  396. </li>
  397. </ul>
  398. </li>
  399. </ul>
  400. <!-- ============ METHOD DETAIL ========== -->
  401. <ul class="blockList">
  402. <li class="blockList"><a name="method.detail">
  403. <!-- -->
  404. </a>
  405. <h3>Method Detail</h3>
  406. <a name="getTimeSeriesInstance--">
  407. <!-- -->
  408. </a>
  409. <ul class="blockList">
  410. <li class="blockList">
  411. <h4>getTimeSeriesInstance</h4>
  412. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html" title="class in org.jfree.chart.labels">StandardXYToolTipGenerator</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.72">getTimeSeriesInstance</a>()</pre>
  413. <div class="block">Returns a tool tip generator that formats the x-values as dates and the
  414. y-values as numbers.</div>
  415. <dl>
  416. <dt><span class="returnLabel">Returns:</span></dt>
  417. <dd>A tool tip generator (never <code>null</code>).</dd>
  418. </dl>
  419. </li>
  420. </ul>
  421. <a name="generateToolTip-org.jfree.data.xy.XYDataset-int-int-">
  422. <!-- -->
  423. </a>
  424. <ul class="blockList">
  425. <li class="blockList">
  426. <h4>generateToolTip</h4>
  427. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.165">generateToolTip</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  428. int&nbsp;series,
  429. int&nbsp;item)</pre>
  430. <div class="block">Generates the tool tip text for an item in a dataset.</div>
  431. <dl>
  432. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  433. <dd><code><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html#generateToolTip-org.jfree.data.xy.XYDataset-int-int-">generateToolTip</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels">XYToolTipGenerator</a></code></dd>
  434. <dt><span class="paramLabel">Parameters:</span></dt>
  435. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  436. <dd><code>series</code> - the series index (zero-based).</dd>
  437. <dd><code>item</code> - the item index (zero-based).</dd>
  438. <dt><span class="returnLabel">Returns:</span></dt>
  439. <dd>The tooltip text (possibly <code>null</code>).</dd>
  440. </dl>
  441. </li>
  442. </ul>
  443. <a name="equals-java.lang.Object-">
  444. <!-- -->
  445. </a>
  446. <ul class="blockList">
  447. <li class="blockList">
  448. <h4>equals</h4>
  449. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.177">equals</a>(java.lang.Object&nbsp;obj)</pre>
  450. <div class="block">Tests this object for equality with an arbitrary object.</div>
  451. <dl>
  452. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  453. <dd><code><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractXYItemLabelGenerator</a></code></dd>
  454. <dt><span class="paramLabel">Parameters:</span></dt>
  455. <dd><code>obj</code> - the other object (<code>null</code> permitted).</dd>
  456. <dt><span class="returnLabel">Returns:</span></dt>
  457. <dd>A boolean.</dd>
  458. </dl>
  459. </li>
  460. </ul>
  461. <a name="clone--">
  462. <!-- -->
  463. </a>
  464. <ul class="blockListLast">
  465. <li class="blockList">
  466. <h4>clone</h4>
  467. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardXYToolTipGenerator.html#line.195">clone</a>()
  468. throws java.lang.CloneNotSupportedException</pre>
  469. <div class="block">Returns an independent copy of the generator.</div>
  470. <dl>
  471. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  472. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  473. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  474. <dd><code><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractXYItemLabelGenerator</a></code></dd>
  475. <dt><span class="returnLabel">Returns:</span></dt>
  476. <dd>A clone.</dd>
  477. <dt><span class="throwsLabel">Throws:</span></dt>
  478. <dd><code>java.lang.CloneNotSupportedException</code> - if cloning is not supported.</dd>
  479. </dl>
  480. </li>
  481. </ul>
  482. </li>
  483. </ul>
  484. </li>
  485. </ul>
  486. </div>
  487. </div>
  488. <!-- ========= END OF CLASS DATA ========= -->
  489. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  490. <div class="bottomNav"><a name="navbar.bottom">
  491. <!-- -->
  492. </a>
  493. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  494. <a name="navbar.bottom.firstrow">
  495. <!-- -->
  496. </a>
  497. <ul class="navList" title="Navigation">
  498. <li><a href="../../../../overview-summary.html">Overview</a></li>
  499. <li><a href="package-summary.html">Package</a></li>
  500. <li class="navBarCell1Rev">Class</li>
  501. <li><a href="class-use/StandardXYToolTipGenerator.html">Use</a></li>
  502. <li><a href="package-tree.html">Tree</a></li>
  503. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  504. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  505. <li><a href="../../../../help-doc.html">Help</a></li>
  506. </ul>
  507. </div>
  508. <div class="subNav">
  509. <ul class="navList">
  510. <li><a href="../../../../org/jfree/chart/labels/StandardXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  511. <li><a href="../../../../org/jfree/chart/labels/StandardXYZToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  512. </ul>
  513. <ul class="navList">
  514. <li><a href="../../../../index.html?org/jfree/chart/labels/StandardXYToolTipGenerator.html" target="_top">Frames</a></li>
  515. <li><a href="StandardXYToolTipGenerator.html" target="_top">No&nbsp;Frames</a></li>
  516. </ul>
  517. <ul class="navList" id="allclasses_navbar_bottom">
  518. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  519. </ul>
  520. <div>
  521. <script type="text/javascript"><!--
  522. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  523. if(window==top) {
  524. allClassesLink.style.display = "block";
  525. }
  526. else {
  527. allClassesLink.style.display = "none";
  528. }
  529. //-->
  530. </script>
  531. </div>
  532. <div>
  533. <ul class="subNavList">
  534. <li>Summary:&nbsp;</li>
  535. <li>Nested&nbsp;|&nbsp;</li>
  536. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  537. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  538. <li><a href="#method.summary">Method</a></li>
  539. </ul>
  540. <ul class="subNavList">
  541. <li>Detail:&nbsp;</li>
  542. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  543. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  544. <li><a href="#method.detail">Method</a></li>
  545. </ul>
  546. </div>
  547. <a name="skip.navbar.bottom">
  548. <!-- -->
  549. </a></div>
  550. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  551. </body>
  552. </html>