CategoryURLGenerator.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  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>CategoryURLGenerator (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="CategoryURLGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/CategoryURLGenerator.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>Prev&nbsp;Class</li>
  53. <li><a href="../../../../org/jfree/chart/urls/CustomCategoryURLGenerator.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/CategoryURLGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="CategoryURLGenerator.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>Constr&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>Constr&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="Interface CategoryURLGenerator" class="title">Interface CategoryURLGenerator</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/chart/urls/CustomCategoryURLGenerator.html" title="class in org.jfree.chart.urls">CustomCategoryURLGenerator</a>, <a href="../../../../org/jfree/chart/urls/StandardCategoryURLGenerator.html" title="class in org.jfree.chart.urls">StandardCategoryURLGenerator</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/urls/CategoryURLGenerator.html#line.60">CategoryURLGenerator</a></pre>
  109. <div class="block">A URL generator for items in a <a href="../../../../org/jfree/data/category/CategoryDataset.html" title="interface in org.jfree.data.category"><code>CategoryDataset</code></a>.</div>
  110. </li>
  111. </ul>
  112. </div>
  113. <div class="summary">
  114. <ul class="blockList">
  115. <li class="blockList">
  116. <!-- ========== METHOD SUMMARY =========== -->
  117. <ul class="blockList">
  118. <li class="blockList"><a name="method.summary">
  119. <!-- -->
  120. </a>
  121. <h3>Method Summary</h3>
  122. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  123. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  124. <tr>
  125. <th class="colFirst" scope="col">Modifier and Type</th>
  126. <th class="colLast" scope="col">Method and Description</th>
  127. </tr>
  128. <tr id="i0" class="altColor">
  129. <td class="colFirst"><code>java.lang.String</code></td>
  130. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/CategoryURLGenerator.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,
  131. int&nbsp;series,
  132. int&nbsp;category)</code>
  133. <div class="block">Returns a URL for one item in a dataset.</div>
  134. </td>
  135. </tr>
  136. </table>
  137. </li>
  138. </ul>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="details">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- ============ METHOD DETAIL ========== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="method.detail">
  148. <!-- -->
  149. </a>
  150. <h3>Method Detail</h3>
  151. <a name="generateURL-org.jfree.data.category.CategoryDataset-int-int-">
  152. <!-- -->
  153. </a>
  154. <ul class="blockListLast">
  155. <li class="blockList">
  156. <h4>generateURL</h4>
  157. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/CategoryURLGenerator.html#line.75">generateURL</a>(<a href="../../../../org/jfree/data/category/CategoryDataset.html" title="interface in org.jfree.data.category">CategoryDataset</a>&nbsp;dataset,
  158. int&nbsp;series,
  159. int&nbsp;category)</pre>
  160. <div class="block">Returns a URL for one item in a dataset. As a guideline, the URL
  161. should be valid within the context of an XHTML 1.0 document. Classes
  162. that implement this interface are responsible for correctly escaping
  163. any text that is derived from the dataset, as this may be user-specified
  164. and could pose a security risk.</div>
  165. <dl>
  166. <dt><span class="paramLabel">Parameters:</span></dt>
  167. <dd><code>dataset</code> - the dataset.</dd>
  168. <dd><code>series</code> - the series (zero-based index).</dd>
  169. <dd><code>category</code> - the category.</dd>
  170. <dt><span class="returnLabel">Returns:</span></dt>
  171. <dd>A string containing the URL.</dd>
  172. </dl>
  173. </li>
  174. </ul>
  175. </li>
  176. </ul>
  177. </li>
  178. </ul>
  179. </div>
  180. </div>
  181. <!-- ========= END OF CLASS DATA ========= -->
  182. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  183. <div class="bottomNav"><a name="navbar.bottom">
  184. <!-- -->
  185. </a>
  186. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  187. <a name="navbar.bottom.firstrow">
  188. <!-- -->
  189. </a>
  190. <ul class="navList" title="Navigation">
  191. <li><a href="../../../../overview-summary.html">Overview</a></li>
  192. <li><a href="package-summary.html">Package</a></li>
  193. <li class="navBarCell1Rev">Class</li>
  194. <li><a href="class-use/CategoryURLGenerator.html">Use</a></li>
  195. <li><a href="package-tree.html">Tree</a></li>
  196. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  197. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  198. <li><a href="../../../../help-doc.html">Help</a></li>
  199. </ul>
  200. </div>
  201. <div class="subNav">
  202. <ul class="navList">
  203. <li>Prev&nbsp;Class</li>
  204. <li><a href="../../../../org/jfree/chart/urls/CustomCategoryURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  205. </ul>
  206. <ul class="navList">
  207. <li><a href="../../../../index.html?org/jfree/chart/urls/CategoryURLGenerator.html" target="_top">Frames</a></li>
  208. <li><a href="CategoryURLGenerator.html" target="_top">No&nbsp;Frames</a></li>
  209. </ul>
  210. <ul class="navList" id="allclasses_navbar_bottom">
  211. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  212. </ul>
  213. <div>
  214. <script type="text/javascript"><!--
  215. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  216. if(window==top) {
  217. allClassesLink.style.display = "block";
  218. }
  219. else {
  220. allClassesLink.style.display = "none";
  221. }
  222. //-->
  223. </script>
  224. </div>
  225. <div>
  226. <ul class="subNavList">
  227. <li>Summary:&nbsp;</li>
  228. <li>Nested&nbsp;|&nbsp;</li>
  229. <li>Field&nbsp;|&nbsp;</li>
  230. <li>Constr&nbsp;|&nbsp;</li>
  231. <li><a href="#method.summary">Method</a></li>
  232. </ul>
  233. <ul class="subNavList">
  234. <li>Detail:&nbsp;</li>
  235. <li>Field&nbsp;|&nbsp;</li>
  236. <li>Constr&nbsp;|&nbsp;</li>
  237. <li><a href="#method.detail">Method</a></li>
  238. </ul>
  239. </div>
  240. <a name="skip.navbar.bottom">
  241. <!-- -->
  242. </a></div>
  243. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  244. </body>
  245. </html>