StandardPieURLGenerator.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  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>StandardPieURLGenerator (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="StandardPieURLGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":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/StandardPieURLGenerator.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/StandardCategoryURLGenerator.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/StandardXYURLGenerator.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/StandardPieURLGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="StandardPieURLGenerator.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 StandardPieURLGenerator" class="title">Class StandardPieURLGenerator</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.StandardPieURLGenerator</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, <a href="../../../../org/jfree/chart/urls/PieURLGenerator.html" title="interface in org.jfree.chart.urls">PieURLGenerator</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.65">StandardPieURLGenerator</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/chart/urls/PieURLGenerator.html" title="interface in org.jfree.chart.urls">PieURLGenerator</a>, java.io.Serializable</pre>
  119. <div class="block">A URL generator for pie charts. Instances of this class are immutable.</div>
  120. <dl>
  121. <dt><span class="seeLabel">See Also:</span></dt>
  122. <dd><a href="../../../../serialized-form.html#org.jfree.chart.urls.StandardPieURLGenerator">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/StandardPieURLGenerator.html#StandardPieURLGenerator--">StandardPieURLGenerator</a></span>()</code>
  143. <div class="block">Default constructor.</div>
  144. </td>
  145. </tr>
  146. <tr class="rowColor">
  147. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/StandardPieURLGenerator.html#StandardPieURLGenerator-java.lang.String-">StandardPieURLGenerator</a></span>(java.lang.String&nbsp;prefix)</code>
  148. <div class="block">Creates a new generator.</div>
  149. </td>
  150. </tr>
  151. <tr class="altColor">
  152. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/StandardPieURLGenerator.html#StandardPieURLGenerator-java.lang.String-java.lang.String-">StandardPieURLGenerator</a></span>(java.lang.String&nbsp;prefix,
  153. java.lang.String&nbsp;categoryParamName)</code>
  154. <div class="block">Creates a new generator.</div>
  155. </td>
  156. </tr>
  157. <tr class="rowColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/StandardPieURLGenerator.html#StandardPieURLGenerator-java.lang.String-java.lang.String-java.lang.String-">StandardPieURLGenerator</a></span>(java.lang.String&nbsp;prefix,
  159. java.lang.String&nbsp;categoryParamName,
  160. java.lang.String&nbsp;indexParamName)</code>
  161. <div class="block">Creates a new generator.</div>
  162. </td>
  163. </tr>
  164. </table>
  165. </li>
  166. </ul>
  167. <!-- ========== METHOD SUMMARY =========== -->
  168. <ul class="blockList">
  169. <li class="blockList"><a name="method.summary">
  170. <!-- -->
  171. </a>
  172. <h3>Method Summary</h3>
  173. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  174. <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>
  175. <tr>
  176. <th class="colFirst" scope="col">Modifier and Type</th>
  177. <th class="colLast" scope="col">Method and Description</th>
  178. </tr>
  179. <tr id="i0" class="altColor">
  180. <td class="colFirst"><code>boolean</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/StandardPieURLGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  182. <div class="block">Tests if this object is equal to another.</div>
  183. </td>
  184. </tr>
  185. <tr id="i1" class="rowColor">
  186. <td class="colFirst"><code>java.lang.String</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/urls/StandardPieURLGenerator.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,
  188. java.lang.Comparable&nbsp;key,
  189. int&nbsp;pieIndex)</code>
  190. <div class="block">Generates a URL.</div>
  191. </td>
  192. </tr>
  193. </table>
  194. <ul class="blockList">
  195. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  196. <!-- -->
  197. </a>
  198. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  199. <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  200. </ul>
  201. </li>
  202. </ul>
  203. </li>
  204. </ul>
  205. </div>
  206. <div class="details">
  207. <ul class="blockList">
  208. <li class="blockList">
  209. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  210. <ul class="blockList">
  211. <li class="blockList"><a name="constructor.detail">
  212. <!-- -->
  213. </a>
  214. <h3>Constructor Detail</h3>
  215. <a name="StandardPieURLGenerator--">
  216. <!-- -->
  217. </a>
  218. <ul class="blockList">
  219. <li class="blockList">
  220. <h4>StandardPieURLGenerator</h4>
  221. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.82">StandardPieURLGenerator</a>()</pre>
  222. <div class="block">Default constructor.</div>
  223. </li>
  224. </ul>
  225. <a name="StandardPieURLGenerator-java.lang.String-">
  226. <!-- -->
  227. </a>
  228. <ul class="blockList">
  229. <li class="blockList">
  230. <h4>StandardPieURLGenerator</h4>
  231. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.91">StandardPieURLGenerator</a>(java.lang.String&nbsp;prefix)</pre>
  232. <div class="block">Creates a new generator.</div>
  233. <dl>
  234. <dt><span class="paramLabel">Parameters:</span></dt>
  235. <dd><code>prefix</code> - the prefix (<code>null</code> not permitted).</dd>
  236. </dl>
  237. </li>
  238. </ul>
  239. <a name="StandardPieURLGenerator-java.lang.String-java.lang.String-">
  240. <!-- -->
  241. </a>
  242. <ul class="blockList">
  243. <li class="blockList">
  244. <h4>StandardPieURLGenerator</h4>
  245. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.102">StandardPieURLGenerator</a>(java.lang.String&nbsp;prefix,
  246. java.lang.String&nbsp;categoryParamName)</pre>
  247. <div class="block">Creates a new generator.</div>
  248. <dl>
  249. <dt><span class="paramLabel">Parameters:</span></dt>
  250. <dd><code>prefix</code> - the prefix (<code>null</code> not permitted).</dd>
  251. <dd><code>categoryParamName</code> - the category parameter name (<code>null</code> not
  252. permitted).</dd>
  253. </dl>
  254. </li>
  255. </ul>
  256. <a name="StandardPieURLGenerator-java.lang.String-java.lang.String-java.lang.String-">
  257. <!-- -->
  258. </a>
  259. <ul class="blockListLast">
  260. <li class="blockList">
  261. <h4>StandardPieURLGenerator</h4>
  262. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.114">StandardPieURLGenerator</a>(java.lang.String&nbsp;prefix,
  263. java.lang.String&nbsp;categoryParamName,
  264. java.lang.String&nbsp;indexParamName)</pre>
  265. <div class="block">Creates a new generator.</div>
  266. <dl>
  267. <dt><span class="paramLabel">Parameters:</span></dt>
  268. <dd><code>prefix</code> - the prefix (<code>null</code> not permitted).</dd>
  269. <dd><code>categoryParamName</code> - the category parameter name (<code>null</code> not
  270. permitted).</dd>
  271. <dd><code>indexParamName</code> - the index parameter name (<code>null</code> permitted).</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. </li>
  276. </ul>
  277. <!-- ============ METHOD DETAIL ========== -->
  278. <ul class="blockList">
  279. <li class="blockList"><a name="method.detail">
  280. <!-- -->
  281. </a>
  282. <h3>Method Detail</h3>
  283. <a name="generateURL-org.jfree.data.general.PieDataset-java.lang.Comparable-int-">
  284. <!-- -->
  285. </a>
  286. <ul class="blockList">
  287. <li class="blockList">
  288. <h4>generateURL</h4>
  289. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.133">generateURL</a>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  290. java.lang.Comparable&nbsp;key,
  291. int&nbsp;pieIndex)</pre>
  292. <div class="block">Generates a URL.</div>
  293. <dl>
  294. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  295. <dd><code><a href="../../../../org/jfree/chart/urls/PieURLGenerator.html#generateURL-org.jfree.data.general.PieDataset-java.lang.Comparable-int-">generateURL</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/urls/PieURLGenerator.html" title="interface in org.jfree.chart.urls">PieURLGenerator</a></code></dd>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>dataset</code> - the dataset (ignored).</dd>
  298. <dd><code>key</code> - the item key (<code>null</code> not permitted).</dd>
  299. <dd><code>pieIndex</code> - the pie index.</dd>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd>A string containing the generated URL.</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. <a name="equals-java.lang.Object-">
  306. <!-- -->
  307. </a>
  308. <ul class="blockListLast">
  309. <li class="blockList">
  310. <h4>equals</h4>
  311. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/urls/StandardPieURLGenerator.html#line.161">equals</a>(java.lang.Object&nbsp;obj)</pre>
  312. <div class="block">Tests if this object is equal to another.</div>
  313. <dl>
  314. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  315. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  318. <dt><span class="returnLabel">Returns:</span></dt>
  319. <dd>A boolean.</dd>
  320. </dl>
  321. </li>
  322. </ul>
  323. </li>
  324. </ul>
  325. </li>
  326. </ul>
  327. </div>
  328. </div>
  329. <!-- ========= END OF CLASS DATA ========= -->
  330. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  331. <div class="bottomNav"><a name="navbar.bottom">
  332. <!-- -->
  333. </a>
  334. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  335. <a name="navbar.bottom.firstrow">
  336. <!-- -->
  337. </a>
  338. <ul class="navList" title="Navigation">
  339. <li><a href="../../../../overview-summary.html">Overview</a></li>
  340. <li><a href="package-summary.html">Package</a></li>
  341. <li class="navBarCell1Rev">Class</li>
  342. <li><a href="class-use/StandardPieURLGenerator.html">Use</a></li>
  343. <li><a href="package-tree.html">Tree</a></li>
  344. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  345. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  346. <li><a href="../../../../help-doc.html">Help</a></li>
  347. </ul>
  348. </div>
  349. <div class="subNav">
  350. <ul class="navList">
  351. <li><a href="../../../../org/jfree/chart/urls/StandardCategoryURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  352. <li><a href="../../../../org/jfree/chart/urls/StandardXYURLGenerator.html" title="class in org.jfree.chart.urls"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  353. </ul>
  354. <ul class="navList">
  355. <li><a href="../../../../index.html?org/jfree/chart/urls/StandardPieURLGenerator.html" target="_top">Frames</a></li>
  356. <li><a href="StandardPieURLGenerator.html" target="_top">No&nbsp;Frames</a></li>
  357. </ul>
  358. <ul class="navList" id="allclasses_navbar_bottom">
  359. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  360. </ul>
  361. <div>
  362. <script type="text/javascript"><!--
  363. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  364. if(window==top) {
  365. allClassesLink.style.display = "block";
  366. }
  367. else {
  368. allClassesLink.style.display = "none";
  369. }
  370. //-->
  371. </script>
  372. </div>
  373. <div>
  374. <ul class="subNavList">
  375. <li>Summary:&nbsp;</li>
  376. <li>Nested&nbsp;|&nbsp;</li>
  377. <li>Field&nbsp;|&nbsp;</li>
  378. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  379. <li><a href="#method.summary">Method</a></li>
  380. </ul>
  381. <ul class="subNavList">
  382. <li>Detail:&nbsp;</li>
  383. <li>Field&nbsp;|&nbsp;</li>
  384. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  385. <li><a href="#method.detail">Method</a></li>
  386. </ul>
  387. </div>
  388. <a name="skip.navbar.bottom">
  389. <!-- -->
  390. </a></div>
  391. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  392. </body>
  393. </html>