StandardXYZToolTipGenerator.html 27 KB

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