PieURLGenerator.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  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>PieURLGenerator (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="PieURLGenerator (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/PieURLGenerator.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/CustomXYURLGenerator.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/StandardCategoryURLGenerator.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/PieURLGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="PieURLGenerator.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 PieURLGenerator" class="title">Interface PieURLGenerator</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/CustomPieURLGenerator.html" title="class in org.jfree.chart.urls">CustomPieURLGenerator</a>, <a href="../../../../org/jfree/chart/urls/StandardPieURLGenerator.html" title="class in org.jfree.chart.urls">StandardPieURLGenerator</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/urls/PieURLGenerator.html#line.65">PieURLGenerator</a></pre>
  109. <div class="block">Interface for a URL generator for plots that use data from a
  110. <a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general"><code>PieDataset</code></a>. Classes that implement this interface:
  111. <ul>
  112. <li>are responsible for correctly escaping any text that is derived from the
  113. dataset, as this may be user-specified and could pose a security
  114. risk;</li>
  115. <li>should be either (a) immutable, or (b) cloneable via the
  116. <code>PublicCloneable</code> interface (defined in the JCommon class
  117. library). This provides a mechanism for the referring plot to clone
  118. the generator if necessary.</li>
  119. </ul></div>
  120. </li>
  121. </ul>
  122. </div>
  123. <div class="summary">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <!-- ========== METHOD SUMMARY =========== -->
  127. <ul class="blockList">
  128. <li class="blockList"><a name="method.summary">
  129. <!-- -->
  130. </a>
  131. <h3>Method Summary</h3>
  132. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  133. <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>
  134. <tr>
  135. <th class="colFirst" scope="col">Modifier and Type</th>
  136. <th class="colLast" scope="col">Method and Description</th>
  137. </tr>
  138. <tr id="i0" class="altColor">
  139. <td class="colFirst"><code>java.lang.String</code></td>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/PieURLGenerator.html#generateURL-org.jfree.data.general.PieDataset-java.lang.Comparable-int-">generateURL</a></span>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  141. java.lang.Comparable&nbsp;key,
  142. int&nbsp;pieIndex)</code>
  143. <div class="block">Generates a URL for one item in a <a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general"><code>PieDataset</code></a>.</div>
  144. </td>
  145. </tr>
  146. </table>
  147. </li>
  148. </ul>
  149. </li>
  150. </ul>
  151. </div>
  152. <div class="details">
  153. <ul class="blockList">
  154. <li class="blockList">
  155. <!-- ============ METHOD DETAIL ========== -->
  156. <ul class="blockList">
  157. <li class="blockList"><a name="method.detail">
  158. <!-- -->
  159. </a>
  160. <h3>Method Detail</h3>
  161. <a name="generateURL-org.jfree.data.general.PieDataset-java.lang.Comparable-int-">
  162. <!-- -->
  163. </a>
  164. <ul class="blockListLast">
  165. <li class="blockList">
  166. <h4>generateURL</h4>
  167. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/PieURLGenerator.html#line.78">generateURL</a>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  168. java.lang.Comparable&nbsp;key,
  169. int&nbsp;pieIndex)</pre>
  170. <div class="block">Generates a URL for one item in a <a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general"><code>PieDataset</code></a>. As a guideline,
  171. the URL should be valid within the context of an XHTML 1.0 document.</div>
  172. <dl>
  173. <dt><span class="paramLabel">Parameters:</span></dt>
  174. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  175. <dd><code>key</code> - the item key (<code>null</code> not permitted).</dd>
  176. <dd><code>pieIndex</code> - the pie index (differentiates between pies in a
  177. 'multi' pie chart).</dd>
  178. <dt><span class="returnLabel">Returns:</span></dt>
  179. <dd>A string containing the URL.</dd>
  180. </dl>
  181. </li>
  182. </ul>
  183. </li>
  184. </ul>
  185. </li>
  186. </ul>
  187. </div>
  188. </div>
  189. <!-- ========= END OF CLASS DATA ========= -->
  190. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  191. <div class="bottomNav"><a name="navbar.bottom">
  192. <!-- -->
  193. </a>
  194. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  195. <a name="navbar.bottom.firstrow">
  196. <!-- -->
  197. </a>
  198. <ul class="navList" title="Navigation">
  199. <li><a href="../../../../overview-summary.html">Overview</a></li>
  200. <li><a href="package-summary.html">Package</a></li>
  201. <li class="navBarCell1Rev">Class</li>
  202. <li><a href="class-use/PieURLGenerator.html">Use</a></li>
  203. <li><a href="package-tree.html">Tree</a></li>
  204. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  205. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  206. <li><a href="../../../../help-doc.html">Help</a></li>
  207. </ul>
  208. </div>
  209. <div class="subNav">
  210. <ul class="navList">
  211. <li><a href="../../../../org/jfree/chart/urls/CustomXYURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  212. <li><a href="../../../../org/jfree/chart/urls/StandardCategoryURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  213. </ul>
  214. <ul class="navList">
  215. <li><a href="../../../../index.html?org/jfree/chart/urls/PieURLGenerator.html" target="_top">Frames</a></li>
  216. <li><a href="PieURLGenerator.html" target="_top">No&nbsp;Frames</a></li>
  217. </ul>
  218. <ul class="navList" id="allclasses_navbar_bottom">
  219. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  220. </ul>
  221. <div>
  222. <script type="text/javascript"><!--
  223. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  224. if(window==top) {
  225. allClassesLink.style.display = "block";
  226. }
  227. else {
  228. allClassesLink.style.display = "none";
  229. }
  230. //-->
  231. </script>
  232. </div>
  233. <div>
  234. <ul class="subNavList">
  235. <li>Summary:&nbsp;</li>
  236. <li>Nested&nbsp;|&nbsp;</li>
  237. <li>Field&nbsp;|&nbsp;</li>
  238. <li>Constr&nbsp;|&nbsp;</li>
  239. <li><a href="#method.summary">Method</a></li>
  240. </ul>
  241. <ul class="subNavList">
  242. <li>Detail:&nbsp;</li>
  243. <li>Field&nbsp;|&nbsp;</li>
  244. <li>Constr&nbsp;|&nbsp;</li>
  245. <li><a href="#method.detail">Method</a></li>
  246. </ul>
  247. </div>
  248. <a name="skip.navbar.bottom">
  249. <!-- -->
  250. </a></div>
  251. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  252. </body>
  253. </html>