StandardCategoryURLGenerator.html 17 KB

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