StandardXYItemLabelGenerator.html 26 KB

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