AbstractXYItemLabelGenerator.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653
  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>AbstractXYItemLabelGenerator (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="AbstractXYItemLabelGenerator (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,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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/AbstractXYItemLabelGenerator.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/AbstractPieItemLabelGenerator.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/BoxAndWhiskerToolTipGenerator.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/AbstractXYItemLabelGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="AbstractXYItemLabelGenerator.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 AbstractXYItemLabelGenerator" class="title">Class AbstractXYItemLabelGenerator</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.AbstractXYItemLabelGenerator</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, java.lang.Cloneable</dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../org/jfree/chart/labels/BubbleXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">BubbleXYItemLabelGenerator</a>, <a href="../../../../org/jfree/chart/labels/IntervalXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">IntervalXYItemLabelGenerator</a>, <a href="../../../../org/jfree/chart/labels/StandardXYItemLabelGenerator.html" title="class in org.jfree.chart.labels">StandardXYItemLabelGenerator</a>, <a href="../../../../org/jfree/chart/labels/StandardXYToolTipGenerator.html" title="class in org.jfree.chart.labels">StandardXYToolTipGenerator</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public class <a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.72">AbstractXYItemLabelGenerator</a>
  121. extends java.lang.Object
  122. implements java.lang.Cloneable, java.io.Serializable</pre>
  123. <div class="block">A base class for creating item label generators.</div>
  124. <dl>
  125. <dt><span class="seeLabel">See Also:</span></dt>
  126. <dd><a href="../../../../serialized-form.html#org.jfree.chart.labels.AbstractXYItemLabelGenerator">Serialized Form</a></dd>
  127. </dl>
  128. </li>
  129. </ul>
  130. </div>
  131. <div class="summary">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  135. <ul class="blockList">
  136. <li class="blockList"><a name="constructor.summary">
  137. <!-- -->
  138. </a>
  139. <h3>Constructor Summary</h3>
  140. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  141. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  142. <tr>
  143. <th class="colFirst" scope="col">Modifier</th>
  144. <th class="colLast" scope="col">Constructor and Description</th>
  145. </tr>
  146. <tr class="altColor">
  147. <td class="colFirst"><code>protected </code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#AbstractXYItemLabelGenerator--">AbstractXYItemLabelGenerator</a></span>()</code>
  149. <div class="block">Creates an item label generator using default number formatters.</div>
  150. </td>
  151. </tr>
  152. <tr class="rowColor">
  153. <td class="colFirst"><code>protected </code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#AbstractXYItemLabelGenerator-java.lang.String-java.text.DateFormat-java.text.DateFormat-">AbstractXYItemLabelGenerator</a></span>(java.lang.String&nbsp;formatString,
  155. java.text.DateFormat&nbsp;xFormat,
  156. java.text.DateFormat&nbsp;yFormat)</code>
  157. <div class="block">Creates an item label generator using the specified number formatters.</div>
  158. </td>
  159. </tr>
  160. <tr class="altColor">
  161. <td class="colFirst"><code>protected </code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#AbstractXYItemLabelGenerator-java.lang.String-java.text.DateFormat-java.text.NumberFormat-">AbstractXYItemLabelGenerator</a></span>(java.lang.String&nbsp;formatString,
  163. java.text.DateFormat&nbsp;xFormat,
  164. java.text.NumberFormat&nbsp;yFormat)</code>
  165. <div class="block">Creates an item label generator using the specified number formatters.</div>
  166. </td>
  167. </tr>
  168. <tr class="rowColor">
  169. <td class="colFirst"><code>protected </code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#AbstractXYItemLabelGenerator-java.lang.String-java.text.NumberFormat-java.text.DateFormat-">AbstractXYItemLabelGenerator</a></span>(java.lang.String&nbsp;formatString,
  171. java.text.NumberFormat&nbsp;xFormat,
  172. java.text.DateFormat&nbsp;yFormat)</code>
  173. <div class="block">Creates an item label generator using the specified formatters (a
  174. number formatter for the x-values and a date formatter for the
  175. y-values).</div>
  176. </td>
  177. </tr>
  178. <tr class="altColor">
  179. <td class="colFirst"><code>protected </code></td>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#AbstractXYItemLabelGenerator-java.lang.String-java.text.NumberFormat-java.text.NumberFormat-">AbstractXYItemLabelGenerator</a></span>(java.lang.String&nbsp;formatString,
  181. java.text.NumberFormat&nbsp;xFormat,
  182. java.text.NumberFormat&nbsp;yFormat)</code>
  183. <div class="block">Creates an item label generator using the specified number formatters.</div>
  184. </td>
  185. </tr>
  186. </table>
  187. </li>
  188. </ul>
  189. <!-- ========== METHOD SUMMARY =========== -->
  190. <ul class="blockList">
  191. <li class="blockList"><a name="method.summary">
  192. <!-- -->
  193. </a>
  194. <h3>Method Summary</h3>
  195. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  196. <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>
  197. <tr>
  198. <th class="colFirst" scope="col">Modifier and Type</th>
  199. <th class="colLast" scope="col">Method and Description</th>
  200. </tr>
  201. <tr id="i0" class="altColor">
  202. <td class="colFirst"><code>java.lang.Object</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#clone--">clone</a></span>()</code>
  204. <div class="block">Returns an independent copy of the generator.</div>
  205. </td>
  206. </tr>
  207. <tr id="i1" class="rowColor">
  208. <td class="colFirst"><code>protected java.lang.Object[]</code></td>
  209. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#createItemArray-org.jfree.data.xy.XYDataset-int-int-">createItemArray</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  210. int&nbsp;series,
  211. int&nbsp;item)</code>
  212. <div class="block">Creates the array of items that can be passed to the
  213. <code>MessageFormat</code> class for creating labels.</div>
  214. </td>
  215. </tr>
  216. <tr id="i2" class="altColor">
  217. <td class="colFirst"><code>boolean</code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  219. <div class="block">Tests this object for equality with an arbitrary object.</div>
  220. </td>
  221. </tr>
  222. <tr id="i3" class="rowColor">
  223. <td class="colFirst"><code>java.lang.String</code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.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,
  225. int&nbsp;series,
  226. int&nbsp;item)</code>
  227. <div class="block">Generates a label string for an item in the dataset.</div>
  228. </td>
  229. </tr>
  230. <tr id="i4" class="altColor">
  231. <td class="colFirst"><code>java.lang.String</code></td>
  232. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getFormatString--">getFormatString</a></span>()</code>
  233. <div class="block">Returns the format string (this controls the overall structure of the
  234. label).</div>
  235. </td>
  236. </tr>
  237. <tr id="i5" class="rowColor">
  238. <td class="colFirst"><code>java.lang.String</code></td>
  239. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getNullYString--">getNullYString</a></span>()</code>
  240. <div class="block">Returns the string representing a null value.</div>
  241. </td>
  242. </tr>
  243. <tr id="i6" class="altColor">
  244. <td class="colFirst"><code>java.text.DateFormat</code></td>
  245. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getXDateFormat--">getXDateFormat</a></span>()</code>
  246. <div class="block">Returns the date formatter for the x-values.</div>
  247. </td>
  248. </tr>
  249. <tr id="i7" class="rowColor">
  250. <td class="colFirst"><code>java.text.NumberFormat</code></td>
  251. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getXFormat--">getXFormat</a></span>()</code>
  252. <div class="block">Returns the number formatter for the x-values.</div>
  253. </td>
  254. </tr>
  255. <tr id="i8" class="altColor">
  256. <td class="colFirst"><code>java.text.DateFormat</code></td>
  257. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getYDateFormat--">getYDateFormat</a></span>()</code>
  258. <div class="block">Returns the date formatter for the y-values.</div>
  259. </td>
  260. </tr>
  261. <tr id="i9" class="rowColor">
  262. <td class="colFirst"><code>java.text.NumberFormat</code></td>
  263. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#getYFormat--">getYFormat</a></span>()</code>
  264. <div class="block">Returns the number formatter for the y-values.</div>
  265. </td>
  266. </tr>
  267. <tr id="i10" class="altColor">
  268. <td class="colFirst"><code>int</code></td>
  269. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#hashCode--">hashCode</a></span>()</code>
  270. <div class="block">Returns a hash code for this instance.</div>
  271. </td>
  272. </tr>
  273. </table>
  274. <ul class="blockList">
  275. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  276. <!-- -->
  277. </a>
  278. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  279. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  280. </ul>
  281. </li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </div>
  286. <div class="details">
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  290. <ul class="blockList">
  291. <li class="blockList"><a name="constructor.detail">
  292. <!-- -->
  293. </a>
  294. <h3>Constructor Detail</h3>
  295. <a name="AbstractXYItemLabelGenerator--">
  296. <!-- -->
  297. </a>
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <h4>AbstractXYItemLabelGenerator</h4>
  301. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.98">AbstractXYItemLabelGenerator</a>()</pre>
  302. <div class="block">Creates an item label generator using default number formatters.</div>
  303. </li>
  304. </ul>
  305. <a name="AbstractXYItemLabelGenerator-java.lang.String-java.text.NumberFormat-java.text.NumberFormat-">
  306. <!-- -->
  307. </a>
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <h4>AbstractXYItemLabelGenerator</h4>
  311. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.113">AbstractXYItemLabelGenerator</a>(java.lang.String&nbsp;formatString,
  312. java.text.NumberFormat&nbsp;xFormat,
  313. java.text.NumberFormat&nbsp;yFormat)</pre>
  314. <div class="block">Creates an item label generator using the specified number formatters.</div>
  315. <dl>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>formatString</code> - the item label format string (<code>null</code>
  318. not permitted).</dd>
  319. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  320. not permitted).</dd>
  321. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  322. not permitted).</dd>
  323. </dl>
  324. </li>
  325. </ul>
  326. <a name="AbstractXYItemLabelGenerator-java.lang.String-java.text.DateFormat-java.text.NumberFormat-">
  327. <!-- -->
  328. </a>
  329. <ul class="blockList">
  330. <li class="blockList">
  331. <h4>AbstractXYItemLabelGenerator</h4>
  332. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.134">AbstractXYItemLabelGenerator</a>(java.lang.String&nbsp;formatString,
  333. java.text.DateFormat&nbsp;xFormat,
  334. java.text.NumberFormat&nbsp;yFormat)</pre>
  335. <div class="block">Creates an item label generator using the specified number formatters.</div>
  336. <dl>
  337. <dt><span class="paramLabel">Parameters:</span></dt>
  338. <dd><code>formatString</code> - the item label format string (<code>null</code>
  339. not permitted).</dd>
  340. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  341. permitted).</dd>
  342. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  343. not permitted).</dd>
  344. </dl>
  345. </li>
  346. </ul>
  347. <a name="AbstractXYItemLabelGenerator-java.lang.String-java.text.NumberFormat-java.text.DateFormat-">
  348. <!-- -->
  349. </a>
  350. <ul class="blockList">
  351. <li class="blockList">
  352. <h4>AbstractXYItemLabelGenerator</h4>
  353. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.155">AbstractXYItemLabelGenerator</a>(java.lang.String&nbsp;formatString,
  354. java.text.NumberFormat&nbsp;xFormat,
  355. java.text.DateFormat&nbsp;yFormat)</pre>
  356. <div class="block">Creates an item label generator using the specified formatters (a
  357. number formatter for the x-values and a date formatter for the
  358. y-values).</div>
  359. <dl>
  360. <dt><span class="paramLabel">Parameters:</span></dt>
  361. <dd><code>formatString</code> - the item label format string (<code>null</code>
  362. not permitted).</dd>
  363. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  364. permitted).</dd>
  365. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  366. not permitted).</dd>
  367. <dt><span class="simpleTagLabel">Since:</span></dt>
  368. <dd>1.0.4</dd>
  369. </dl>
  370. </li>
  371. </ul>
  372. <a name="AbstractXYItemLabelGenerator-java.lang.String-java.text.DateFormat-java.text.DateFormat-">
  373. <!-- -->
  374. </a>
  375. <ul class="blockListLast">
  376. <li class="blockList">
  377. <h4>AbstractXYItemLabelGenerator</h4>
  378. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.172">AbstractXYItemLabelGenerator</a>(java.lang.String&nbsp;formatString,
  379. java.text.DateFormat&nbsp;xFormat,
  380. java.text.DateFormat&nbsp;yFormat)</pre>
  381. <div class="block">Creates an item label generator using the specified number formatters.</div>
  382. <dl>
  383. <dt><span class="paramLabel">Parameters:</span></dt>
  384. <dd><code>formatString</code> - the item label format string (<code>null</code>
  385. not permitted).</dd>
  386. <dd><code>xFormat</code> - the format object for the x values (<code>null</code>
  387. permitted).</dd>
  388. <dd><code>yFormat</code> - the format object for the y values (<code>null</code>
  389. not permitted).</dd>
  390. </dl>
  391. </li>
  392. </ul>
  393. </li>
  394. </ul>
  395. <!-- ============ METHOD DETAIL ========== -->
  396. <ul class="blockList">
  397. <li class="blockList"><a name="method.detail">
  398. <!-- -->
  399. </a>
  400. <h3>Method Detail</h3>
  401. <a name="getFormatString--">
  402. <!-- -->
  403. </a>
  404. <ul class="blockList">
  405. <li class="blockList">
  406. <h4>getFormatString</h4>
  407. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.187">getFormatString</a>()</pre>
  408. <div class="block">Returns the format string (this controls the overall structure of the
  409. label).</div>
  410. <dl>
  411. <dt><span class="returnLabel">Returns:</span></dt>
  412. <dd>The format string (never <code>null</code>).</dd>
  413. </dl>
  414. </li>
  415. </ul>
  416. <a name="getXFormat--">
  417. <!-- -->
  418. </a>
  419. <ul class="blockList">
  420. <li class="blockList">
  421. <h4>getXFormat</h4>
  422. <pre>public&nbsp;java.text.NumberFormat&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.196">getXFormat</a>()</pre>
  423. <div class="block">Returns the number formatter for the x-values.</div>
  424. <dl>
  425. <dt><span class="returnLabel">Returns:</span></dt>
  426. <dd>The number formatter (possibly <code>null</code>).</dd>
  427. </dl>
  428. </li>
  429. </ul>
  430. <a name="getXDateFormat--">
  431. <!-- -->
  432. </a>
  433. <ul class="blockList">
  434. <li class="blockList">
  435. <h4>getXDateFormat</h4>
  436. <pre>public&nbsp;java.text.DateFormat&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.205">getXDateFormat</a>()</pre>
  437. <div class="block">Returns the date formatter for the x-values.</div>
  438. <dl>
  439. <dt><span class="returnLabel">Returns:</span></dt>
  440. <dd>The date formatter (possibly <code>null</code>).</dd>
  441. </dl>
  442. </li>
  443. </ul>
  444. <a name="getYFormat--">
  445. <!-- -->
  446. </a>
  447. <ul class="blockList">
  448. <li class="blockList">
  449. <h4>getYFormat</h4>
  450. <pre>public&nbsp;java.text.NumberFormat&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.214">getYFormat</a>()</pre>
  451. <div class="block">Returns the number formatter for the y-values.</div>
  452. <dl>
  453. <dt><span class="returnLabel">Returns:</span></dt>
  454. <dd>The number formatter (possibly <code>null</code>).</dd>
  455. </dl>
  456. </li>
  457. </ul>
  458. <a name="getYDateFormat--">
  459. <!-- -->
  460. </a>
  461. <ul class="blockList">
  462. <li class="blockList">
  463. <h4>getYDateFormat</h4>
  464. <pre>public&nbsp;java.text.DateFormat&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.223">getYDateFormat</a>()</pre>
  465. <div class="block">Returns the date formatter for the y-values.</div>
  466. <dl>
  467. <dt><span class="returnLabel">Returns:</span></dt>
  468. <dd>The date formatter (possibly <code>null</code>).</dd>
  469. </dl>
  470. </li>
  471. </ul>
  472. <a name="generateLabelString-org.jfree.data.xy.XYDataset-int-int-">
  473. <!-- -->
  474. </a>
  475. <ul class="blockList">
  476. <li class="blockList">
  477. <h4>generateLabelString</h4>
  478. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.236">generateLabelString</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  479. int&nbsp;series,
  480. int&nbsp;item)</pre>
  481. <div class="block">Generates a label string for an item in the dataset.</div>
  482. <dl>
  483. <dt><span class="paramLabel">Parameters:</span></dt>
  484. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  485. <dd><code>series</code> - the series (zero-based index).</dd>
  486. <dd><code>item</code> - the item (zero-based index).</dd>
  487. <dt><span class="returnLabel">Returns:</span></dt>
  488. <dd>The label (possibly <code>null</code>).</dd>
  489. </dl>
  490. </li>
  491. </ul>
  492. <a name="getNullYString--">
  493. <!-- -->
  494. </a>
  495. <ul class="blockList">
  496. <li class="blockList">
  497. <h4>getNullYString</h4>
  498. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.250">getNullYString</a>()</pre>
  499. <div class="block">Returns the string representing a null value.</div>
  500. <dl>
  501. <dt><span class="returnLabel">Returns:</span></dt>
  502. <dd>The string representing a null value.</dd>
  503. <dt><span class="simpleTagLabel">Since:</span></dt>
  504. <dd>1.0.10</dd>
  505. </dl>
  506. </li>
  507. </ul>
  508. <a name="createItemArray-org.jfree.data.xy.XYDataset-int-int-">
  509. <!-- -->
  510. </a>
  511. <ul class="blockList">
  512. <li class="blockList">
  513. <h4>createItemArray</h4>
  514. <pre>protected&nbsp;java.lang.Object[]&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.265">createItemArray</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  515. int&nbsp;series,
  516. int&nbsp;item)</pre>
  517. <div class="block">Creates the array of items that can be passed to the
  518. <code>MessageFormat</code> class for creating labels.</div>
  519. <dl>
  520. <dt><span class="paramLabel">Parameters:</span></dt>
  521. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  522. <dd><code>series</code> - the series (zero-based index).</dd>
  523. <dd><code>item</code> - the item (zero-based index).</dd>
  524. <dt><span class="returnLabel">Returns:</span></dt>
  525. <dd>An array of three items from the dataset formatted as
  526. <code>String</code> objects (never <code>null</code>).</dd>
  527. </dl>
  528. </li>
  529. </ul>
  530. <a name="equals-java.lang.Object-">
  531. <!-- -->
  532. </a>
  533. <ul class="blockList">
  534. <li class="blockList">
  535. <h4>equals</h4>
  536. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.301">equals</a>(java.lang.Object&nbsp;obj)</pre>
  537. <div class="block">Tests this object for equality with an arbitrary object.</div>
  538. <dl>
  539. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  540. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  541. <dt><span class="paramLabel">Parameters:</span></dt>
  542. <dd><code>obj</code> - the other object (<code>null</code> permitted).</dd>
  543. <dt><span class="returnLabel">Returns:</span></dt>
  544. <dd>A boolean.</dd>
  545. </dl>
  546. </li>
  547. </ul>
  548. <a name="hashCode--">
  549. <!-- -->
  550. </a>
  551. <ul class="blockList">
  552. <li class="blockList">
  553. <h4>hashCode</h4>
  554. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.336">hashCode</a>()</pre>
  555. <div class="block">Returns a hash code for this instance.</div>
  556. <dl>
  557. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  558. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  559. <dt><span class="returnLabel">Returns:</span></dt>
  560. <dd>A hash code.</dd>
  561. </dl>
  562. </li>
  563. </ul>
  564. <a name="clone--">
  565. <!-- -->
  566. </a>
  567. <ul class="blockListLast">
  568. <li class="blockList">
  569. <h4>clone</h4>
  570. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/AbstractXYItemLabelGenerator.html#line.354">clone</a>()
  571. throws java.lang.CloneNotSupportedException</pre>
  572. <div class="block">Returns an independent copy of the generator.</div>
  573. <dl>
  574. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  575. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  576. <dt><span class="returnLabel">Returns:</span></dt>
  577. <dd>A clone.</dd>
  578. <dt><span class="throwsLabel">Throws:</span></dt>
  579. <dd><code>java.lang.CloneNotSupportedException</code> - if cloning is not supported.</dd>
  580. </dl>
  581. </li>
  582. </ul>
  583. </li>
  584. </ul>
  585. </li>
  586. </ul>
  587. </div>
  588. </div>
  589. <!-- ========= END OF CLASS DATA ========= -->
  590. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  591. <div class="bottomNav"><a name="navbar.bottom">
  592. <!-- -->
  593. </a>
  594. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  595. <a name="navbar.bottom.firstrow">
  596. <!-- -->
  597. </a>
  598. <ul class="navList" title="Navigation">
  599. <li><a href="../../../../overview-summary.html">Overview</a></li>
  600. <li><a href="package-summary.html">Package</a></li>
  601. <li class="navBarCell1Rev">Class</li>
  602. <li><a href="class-use/AbstractXYItemLabelGenerator.html">Use</a></li>
  603. <li><a href="package-tree.html">Tree</a></li>
  604. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  605. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  606. <li><a href="../../../../help-doc.html">Help</a></li>
  607. </ul>
  608. </div>
  609. <div class="subNav">
  610. <ul class="navList">
  611. <li><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  612. <li><a href="../../../../org/jfree/chart/labels/BoxAndWhiskerToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  613. </ul>
  614. <ul class="navList">
  615. <li><a href="../../../../index.html?org/jfree/chart/labels/AbstractXYItemLabelGenerator.html" target="_top">Frames</a></li>
  616. <li><a href="AbstractXYItemLabelGenerator.html" target="_top">No&nbsp;Frames</a></li>
  617. </ul>
  618. <ul class="navList" id="allclasses_navbar_bottom">
  619. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  620. </ul>
  621. <div>
  622. <script type="text/javascript"><!--
  623. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  624. if(window==top) {
  625. allClassesLink.style.display = "block";
  626. }
  627. else {
  628. allClassesLink.style.display = "none";
  629. }
  630. //-->
  631. </script>
  632. </div>
  633. <div>
  634. <ul class="subNavList">
  635. <li>Summary:&nbsp;</li>
  636. <li>Nested&nbsp;|&nbsp;</li>
  637. <li>Field&nbsp;|&nbsp;</li>
  638. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  639. <li><a href="#method.summary">Method</a></li>
  640. </ul>
  641. <ul class="subNavList">
  642. <li>Detail:&nbsp;</li>
  643. <li>Field&nbsp;|&nbsp;</li>
  644. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  645. <li><a href="#method.detail">Method</a></li>
  646. </ul>
  647. </div>
  648. <a name="skip.navbar.bottom">
  649. <!-- -->
  650. </a></div>
  651. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  652. </body>
  653. </html>