CustomXYURLGenerator.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  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:41 CEST 2014 -->
  6. <title>CustomXYURLGenerator (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="CustomXYURLGenerator (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};
  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/CustomXYURLGenerator.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/urls/CustomPieURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/urls/PieURLGenerator.html" title="interface in org.jfree.chart.urls"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/urls/CustomXYURLGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="CustomXYURLGenerator.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.urls</div>
  96. <h2 title="Class CustomXYURLGenerator" class="title">Class CustomXYURLGenerator</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.urls.CustomXYURLGenerator</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, <a href="../../../../org/jfree/chart/urls/XYURLGenerator.html" title="interface in org.jfree.chart.urls">XYURLGenerator</a>, org.jfree.util.PublicCloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.60">CustomXYURLGenerator</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/chart/urls/XYURLGenerator.html" title="interface in org.jfree.chart.urls">XYURLGenerator</a>, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  119. <div class="block">A custom URL generator.</div>
  120. <dl>
  121. <dt><span class="seeLabel">See Also:</span></dt>
  122. <dd><a href="../../../../serialized-form.html#org.jfree.chart.urls.CustomXYURLGenerator">Serialized Form</a></dd>
  123. </dl>
  124. </li>
  125. </ul>
  126. </div>
  127. <div class="summary">
  128. <ul class="blockList">
  129. <li class="blockList">
  130. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  131. <ul class="blockList">
  132. <li class="blockList"><a name="constructor.summary">
  133. <!-- -->
  134. </a>
  135. <h3>Constructor Summary</h3>
  136. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  137. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  138. <tr>
  139. <th class="colOne" scope="col">Constructor and Description</th>
  140. </tr>
  141. <tr class="altColor">
  142. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#CustomXYURLGenerator--">CustomXYURLGenerator</a></span>()</code>
  143. <div class="block">Default constructor.</div>
  144. </td>
  145. </tr>
  146. </table>
  147. </li>
  148. </ul>
  149. <!-- ========== METHOD SUMMARY =========== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="method.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Method Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  156. <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>
  157. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colLast" scope="col">Method and Description</th>
  160. </tr>
  161. <tr id="i0" class="altColor">
  162. <td class="colFirst"><code>void</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#addURLSeries-java.util.List-">addURLSeries</a></span>(java.util.List&nbsp;urls)</code>
  164. <div class="block">Adds a list of URLs.</div>
  165. </td>
  166. </tr>
  167. <tr id="i1" class="rowColor">
  168. <td class="colFirst"><code>java.lang.Object</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#clone--">clone</a></span>()</code>
  170. <div class="block">Returns a new generator that is a copy of, and independent from, this
  171. generator.</div>
  172. </td>
  173. </tr>
  174. <tr id="i2" class="altColor">
  175. <td class="colFirst"><code>boolean</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  177. <div class="block">Tests this generator for equality with an arbitrary object.</div>
  178. </td>
  179. </tr>
  180. <tr id="i3" class="rowColor">
  181. <td class="colFirst"><code>java.lang.String</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#generateURL-org.jfree.data.xy.XYDataset-int-int-">generateURL</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  183. int&nbsp;series,
  184. int&nbsp;item)</code>
  185. <div class="block">Generates a URL.</div>
  186. </td>
  187. </tr>
  188. <tr id="i4" class="altColor">
  189. <td class="colFirst"><code>int</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#getListCount--">getListCount</a></span>()</code>
  191. <div class="block">Returns the number of URL lists stored by the renderer.</div>
  192. </td>
  193. </tr>
  194. <tr id="i5" class="rowColor">
  195. <td class="colFirst"><code>java.lang.String</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#getURL-int-int-">getURL</a></span>(int&nbsp;series,
  197. int&nbsp;item)</code>
  198. <div class="block">Returns the URL for an item.</div>
  199. </td>
  200. </tr>
  201. <tr id="i6" class="altColor">
  202. <td class="colFirst"><code>int</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html#getURLCount-int-">getURLCount</a></span>(int&nbsp;list)</code>
  204. <div class="block">Returns the number of URLs in a given list.</div>
  205. </td>
  206. </tr>
  207. </table>
  208. <ul class="blockList">
  209. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  210. <!-- -->
  211. </a>
  212. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  213. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  214. </ul>
  215. </li>
  216. </ul>
  217. </li>
  218. </ul>
  219. </div>
  220. <div class="details">
  221. <ul class="blockList">
  222. <li class="blockList">
  223. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  224. <ul class="blockList">
  225. <li class="blockList"><a name="constructor.detail">
  226. <!-- -->
  227. </a>
  228. <h3>Constructor Detail</h3>
  229. <a name="CustomXYURLGenerator--">
  230. <!-- -->
  231. </a>
  232. <ul class="blockListLast">
  233. <li class="blockList">
  234. <h4>CustomXYURLGenerator</h4>
  235. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.72">CustomXYURLGenerator</a>()</pre>
  236. <div class="block">Default constructor.</div>
  237. </li>
  238. </ul>
  239. </li>
  240. </ul>
  241. <!-- ============ METHOD DETAIL ========== -->
  242. <ul class="blockList">
  243. <li class="blockList"><a name="method.detail">
  244. <!-- -->
  245. </a>
  246. <h3>Method Detail</h3>
  247. <a name="getListCount--">
  248. <!-- -->
  249. </a>
  250. <ul class="blockList">
  251. <li class="blockList">
  252. <h4>getListCount</h4>
  253. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.81">getListCount</a>()</pre>
  254. <div class="block">Returns the number of URL lists stored by the renderer.</div>
  255. <dl>
  256. <dt><span class="returnLabel">Returns:</span></dt>
  257. <dd>The list count.</dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. <a name="getURLCount-int-">
  262. <!-- -->
  263. </a>
  264. <ul class="blockList">
  265. <li class="blockList">
  266. <h4>getURLCount</h4>
  267. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.92">getURLCount</a>(int&nbsp;list)</pre>
  268. <div class="block">Returns the number of URLs in a given list.</div>
  269. <dl>
  270. <dt><span class="paramLabel">Parameters:</span></dt>
  271. <dd><code>list</code> - the list index (zero based).</dd>
  272. <dt><span class="returnLabel">Returns:</span></dt>
  273. <dd>The URL count.</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. <a name="getURL-int-int-">
  278. <!-- -->
  279. </a>
  280. <ul class="blockList">
  281. <li class="blockList">
  282. <h4>getURL</h4>
  283. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.109">getURL</a>(int&nbsp;series,
  284. int&nbsp;item)</pre>
  285. <div class="block">Returns the URL for an item.</div>
  286. <dl>
  287. <dt><span class="paramLabel">Parameters:</span></dt>
  288. <dd><code>series</code> - the series index.</dd>
  289. <dd><code>item</code> - the item index.</dd>
  290. <dt><span class="returnLabel">Returns:</span></dt>
  291. <dd>The URL (possibly <code>null</code>).</dd>
  292. </dl>
  293. </li>
  294. </ul>
  295. <a name="generateURL-org.jfree.data.xy.XYDataset-int-int-">
  296. <!-- -->
  297. </a>
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <h4>generateURL</h4>
  301. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.132">generateURL</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  302. int&nbsp;series,
  303. int&nbsp;item)</pre>
  304. <div class="block">Generates a URL.</div>
  305. <dl>
  306. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  307. <dd><code><a href="../../../../org/jfree/chart/urls/XYURLGenerator.html#generateURL-org.jfree.data.xy.XYDataset-int-int-">generateURL</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/urls/XYURLGenerator.html" title="interface in org.jfree.chart.urls">XYURLGenerator</a></code></dd>
  308. <dt><span class="paramLabel">Parameters:</span></dt>
  309. <dd><code>dataset</code> - the dataset.</dd>
  310. <dd><code>series</code> - the series (zero-based index).</dd>
  311. <dd><code>item</code> - the item (zero-based index).</dd>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>A string containing the URL (possibly <code>null</code>).</dd>
  314. </dl>
  315. </li>
  316. </ul>
  317. <a name="addURLSeries-java.util.List-">
  318. <!-- -->
  319. </a>
  320. <ul class="blockList">
  321. <li class="blockList">
  322. <h4>addURLSeries</h4>
  323. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.142">addURLSeries</a>(java.util.List&nbsp;urls)</pre>
  324. <div class="block">Adds a list of URLs.</div>
  325. <dl>
  326. <dt><span class="paramLabel">Parameters:</span></dt>
  327. <dd><code>urls</code> - the list of URLs (<code>null</code> permitted, the list
  328. is copied).</dd>
  329. </dl>
  330. </li>
  331. </ul>
  332. <a name="equals-java.lang.Object-">
  333. <!-- -->
  334. </a>
  335. <ul class="blockList">
  336. <li class="blockList">
  337. <h4>equals</h4>
  338. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.158">equals</a>(java.lang.Object&nbsp;obj)</pre>
  339. <div class="block">Tests this generator for equality with an arbitrary object.</div>
  340. <dl>
  341. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  342. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  343. <dt><span class="paramLabel">Parameters:</span></dt>
  344. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  345. <dt><span class="returnLabel">Returns:</span></dt>
  346. <dd>A boolean.</dd>
  347. </dl>
  348. </li>
  349. </ul>
  350. <a name="clone--">
  351. <!-- -->
  352. </a>
  353. <ul class="blockListLast">
  354. <li class="blockList">
  355. <h4>clone</h4>
  356. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CustomXYURLGenerator.html#line.205">clone</a>()
  357. throws java.lang.CloneNotSupportedException</pre>
  358. <div class="block">Returns a new generator that is a copy of, and independent from, this
  359. generator.</div>
  360. <dl>
  361. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  362. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  363. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  364. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  365. <dt><span class="returnLabel">Returns:</span></dt>
  366. <dd>A clone.</dd>
  367. <dt><span class="throwsLabel">Throws:</span></dt>
  368. <dd><code>java.lang.CloneNotSupportedException</code> - if there is a problem with cloning.</dd>
  369. </dl>
  370. </li>
  371. </ul>
  372. </li>
  373. </ul>
  374. </li>
  375. </ul>
  376. </div>
  377. </div>
  378. <!-- ========= END OF CLASS DATA ========= -->
  379. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  380. <div class="bottomNav"><a name="navbar.bottom">
  381. <!-- -->
  382. </a>
  383. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  384. <a name="navbar.bottom.firstrow">
  385. <!-- -->
  386. </a>
  387. <ul class="navList" title="Navigation">
  388. <li><a href="../../../../overview-summary.html">Overview</a></li>
  389. <li><a href="package-summary.html">Package</a></li>
  390. <li class="navBarCell1Rev">Class</li>
  391. <li><a href="class-use/CustomXYURLGenerator.html">Use</a></li>
  392. <li><a href="package-tree.html">Tree</a></li>
  393. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  394. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  395. <li><a href="../../../../help-doc.html">Help</a></li>
  396. </ul>
  397. </div>
  398. <div class="subNav">
  399. <ul class="navList">
  400. <li><a href="../../../../org/jfree/chart/urls/CustomPieURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  401. <li><a href="../../../../org/jfree/chart/urls/PieURLGenerator.html" title="interface in org.jfree.chart.urls"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  402. </ul>
  403. <ul class="navList">
  404. <li><a href="../../../../index.html?org/jfree/chart/urls/CustomXYURLGenerator.html" target="_top">Frames</a></li>
  405. <li><a href="CustomXYURLGenerator.html" target="_top">No&nbsp;Frames</a></li>
  406. </ul>
  407. <ul class="navList" id="allclasses_navbar_bottom">
  408. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  409. </ul>
  410. <div>
  411. <script type="text/javascript"><!--
  412. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  413. if(window==top) {
  414. allClassesLink.style.display = "block";
  415. }
  416. else {
  417. allClassesLink.style.display = "none";
  418. }
  419. //-->
  420. </script>
  421. </div>
  422. <div>
  423. <ul class="subNavList">
  424. <li>Summary:&nbsp;</li>
  425. <li>Nested&nbsp;|&nbsp;</li>
  426. <li>Field&nbsp;|&nbsp;</li>
  427. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  428. <li><a href="#method.summary">Method</a></li>
  429. </ul>
  430. <ul class="subNavList">
  431. <li>Detail:&nbsp;</li>
  432. <li>Field&nbsp;|&nbsp;</li>
  433. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  434. <li><a href="#method.detail">Method</a></li>
  435. </ul>
  436. </div>
  437. <a name="skip.navbar.bottom">
  438. <!-- -->
  439. </a></div>
  440. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  441. </body>
  442. </html>