AbstractPieLabelDistributor.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  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:32 CEST 2014 -->
  6. <title>AbstractPieLabelDistributor (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="AbstractPieLabelDistributor (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractPieLabelDistributor.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/plot/CategoryCrosshairState.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/plot/AbstractPieLabelDistributor.html" target="_top">Frames</a></li>
  57. <li><a href="AbstractPieLabelDistributor.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.plot</div>
  96. <h2 title="Class AbstractPieLabelDistributor" class="title">Class AbstractPieLabelDistributor</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.plot.AbstractPieLabelDistributor</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</dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../org/jfree/chart/plot/PieLabelDistributor.html" title="class in org.jfree.chart.plot">PieLabelDistributor</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public abstract class <a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.54">AbstractPieLabelDistributor</a>
  121. extends java.lang.Object
  122. implements java.io.Serializable</pre>
  123. <div class="block">A base class for handling the distribution of pie section labels. Create
  124. your own subclass and set it using the
  125. <a href="../../../../org/jfree/chart/plot/PiePlot.html#setLabelDistributor-org.jfree.chart.plot.AbstractPieLabelDistributor-"><code>PiePlot.setLabelDistributor(AbstractPieLabelDistributor)</code></a> method
  126. if you want to customise the label distribution.</div>
  127. <dl>
  128. <dt><span class="seeLabel">See Also:</span></dt>
  129. <dd><a href="../../../../serialized-form.html#org.jfree.chart.plot.AbstractPieLabelDistributor">Serialized Form</a></dd>
  130. </dl>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- =========== FIELD SUMMARY =========== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="field.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Field Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  144. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colFirst" scope="col">Modifier and Type</th>
  147. <th class="colLast" scope="col">Field and Description</th>
  148. </tr>
  149. <tr class="altColor">
  150. <td class="colFirst"><code>protected java.util.List</code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#labels">labels</a></span></code>
  152. <div class="block">The label records.</div>
  153. </td>
  154. </tr>
  155. </table>
  156. </li>
  157. </ul>
  158. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="constructor.summary">
  161. <!-- -->
  162. </a>
  163. <h3>Constructor Summary</h3>
  164. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  165. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  166. <tr>
  167. <th class="colOne" scope="col">Constructor and Description</th>
  168. </tr>
  169. <tr class="altColor">
  170. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#AbstractPieLabelDistributor--">AbstractPieLabelDistributor</a></span>()</code>
  171. <div class="block">Creates a new instance.</div>
  172. </td>
  173. </tr>
  174. </table>
  175. </li>
  176. </ul>
  177. <!-- ========== METHOD SUMMARY =========== -->
  178. <ul class="blockList">
  179. <li class="blockList"><a name="method.summary">
  180. <!-- -->
  181. </a>
  182. <h3>Method Summary</h3>
  183. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  184. <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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  185. <tr>
  186. <th class="colFirst" scope="col">Modifier and Type</th>
  187. <th class="colLast" scope="col">Method and Description</th>
  188. </tr>
  189. <tr id="i0" class="altColor">
  190. <td class="colFirst"><code>void</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#addPieLabelRecord-org.jfree.chart.plot.PieLabelRecord-">addPieLabelRecord</a></span>(<a href="../../../../org/jfree/chart/plot/PieLabelRecord.html" title="class in org.jfree.chart.plot">PieLabelRecord</a>&nbsp;record)</code>
  192. <div class="block">Adds a label record.</div>
  193. </td>
  194. </tr>
  195. <tr id="i1" class="rowColor">
  196. <td class="colFirst"><code>void</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#clear--">clear</a></span>()</code>
  198. <div class="block">Clears the list of labels.</div>
  199. </td>
  200. </tr>
  201. <tr id="i2" class="altColor">
  202. <td class="colFirst"><code>abstract void</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#distributeLabels-double-double-">distributeLabels</a></span>(double&nbsp;minY,
  204. double&nbsp;height)</code>
  205. <div class="block">Called by the <a href="../../../../org/jfree/chart/plot/PiePlot.html" title="class in org.jfree.chart.plot"><code>PiePlot</code></a> class.</div>
  206. </td>
  207. </tr>
  208. <tr id="i3" class="rowColor">
  209. <td class="colFirst"><code>int</code></td>
  210. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#getItemCount--">getItemCount</a></span>()</code>
  211. <div class="block">Returns the number of items in the list.</div>
  212. </td>
  213. </tr>
  214. <tr id="i4" class="altColor">
  215. <td class="colFirst"><code><a href="../../../../org/jfree/chart/plot/PieLabelRecord.html" title="class in org.jfree.chart.plot">PieLabelRecord</a></code></td>
  216. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/AbstractPieLabelDistributor.html#getPieLabelRecord-int-">getPieLabelRecord</a></span>(int&nbsp;index)</code>
  217. <div class="block">Returns a label record from the list.</div>
  218. </td>
  219. </tr>
  220. </table>
  221. <ul class="blockList">
  222. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  223. <!-- -->
  224. </a>
  225. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  226. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  227. </ul>
  228. </li>
  229. </ul>
  230. </li>
  231. </ul>
  232. </div>
  233. <div class="details">
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <!-- ============ FIELD DETAIL =========== -->
  237. <ul class="blockList">
  238. <li class="blockList"><a name="field.detail">
  239. <!-- -->
  240. </a>
  241. <h3>Field Detail</h3>
  242. <a name="labels">
  243. <!-- -->
  244. </a>
  245. <ul class="blockListLast">
  246. <li class="blockList">
  247. <h4>labels</h4>
  248. <pre>protected&nbsp;java.util.List <a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.57">labels</a></pre>
  249. <div class="block">The label records.</div>
  250. </li>
  251. </ul>
  252. </li>
  253. </ul>
  254. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  255. <ul class="blockList">
  256. <li class="blockList"><a name="constructor.detail">
  257. <!-- -->
  258. </a>
  259. <h3>Constructor Detail</h3>
  260. <a name="AbstractPieLabelDistributor--">
  261. <!-- -->
  262. </a>
  263. <ul class="blockListLast">
  264. <li class="blockList">
  265. <h4>AbstractPieLabelDistributor</h4>
  266. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.62">AbstractPieLabelDistributor</a>()</pre>
  267. <div class="block">Creates a new instance.</div>
  268. </li>
  269. </ul>
  270. </li>
  271. </ul>
  272. <!-- ============ METHOD DETAIL ========== -->
  273. <ul class="blockList">
  274. <li class="blockList"><a name="method.detail">
  275. <!-- -->
  276. </a>
  277. <h3>Method Detail</h3>
  278. <a name="getPieLabelRecord-int-">
  279. <!-- -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>getPieLabelRecord</h4>
  284. <pre>public&nbsp;<a href="../../../../org/jfree/chart/plot/PieLabelRecord.html" title="class in org.jfree.chart.plot">PieLabelRecord</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.73">getPieLabelRecord</a>(int&nbsp;index)</pre>
  285. <div class="block">Returns a label record from the list.</div>
  286. <dl>
  287. <dt><span class="paramLabel">Parameters:</span></dt>
  288. <dd><code>index</code> - the index.</dd>
  289. <dt><span class="returnLabel">Returns:</span></dt>
  290. <dd>The label record.</dd>
  291. </dl>
  292. </li>
  293. </ul>
  294. <a name="addPieLabelRecord-org.jfree.chart.plot.PieLabelRecord-">
  295. <!-- -->
  296. </a>
  297. <ul class="blockList">
  298. <li class="blockList">
  299. <h4>addPieLabelRecord</h4>
  300. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.82">addPieLabelRecord</a>(<a href="../../../../org/jfree/chart/plot/PieLabelRecord.html" title="class in org.jfree.chart.plot">PieLabelRecord</a>&nbsp;record)</pre>
  301. <div class="block">Adds a label record.</div>
  302. <dl>
  303. <dt><span class="paramLabel">Parameters:</span></dt>
  304. <dd><code>record</code> - the label record (<code>null</code> not permitted).</dd>
  305. </dl>
  306. </li>
  307. </ul>
  308. <a name="getItemCount--">
  309. <!-- -->
  310. </a>
  311. <ul class="blockList">
  312. <li class="blockList">
  313. <h4>getItemCount</h4>
  314. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.92">getItemCount</a>()</pre>
  315. <div class="block">Returns the number of items in the list.</div>
  316. <dl>
  317. <dt><span class="returnLabel">Returns:</span></dt>
  318. <dd>The item count.</dd>
  319. </dl>
  320. </li>
  321. </ul>
  322. <a name="clear--">
  323. <!-- -->
  324. </a>
  325. <ul class="blockList">
  326. <li class="blockList">
  327. <h4>clear</h4>
  328. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.99">clear</a>()</pre>
  329. <div class="block">Clears the list of labels.</div>
  330. </li>
  331. </ul>
  332. <a name="distributeLabels-double-double-">
  333. <!-- -->
  334. </a>
  335. <ul class="blockListLast">
  336. <li class="blockList">
  337. <h4>distributeLabels</h4>
  338. <pre>public abstract&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/AbstractPieLabelDistributor.html#line.110">distributeLabels</a>(double&nbsp;minY,
  339. double&nbsp;height)</pre>
  340. <div class="block">Called by the <a href="../../../../org/jfree/chart/plot/PiePlot.html" title="class in org.jfree.chart.plot"><code>PiePlot</code></a> class. Implementations should distribute
  341. the labels in this.labels then return.</div>
  342. <dl>
  343. <dt><span class="paramLabel">Parameters:</span></dt>
  344. <dd><code>minY</code> - the y-coordinate for the top of the label area.</dd>
  345. <dd><code>height</code> - the height of the label area.</dd>
  346. </dl>
  347. </li>
  348. </ul>
  349. </li>
  350. </ul>
  351. </li>
  352. </ul>
  353. </div>
  354. </div>
  355. <!-- ========= END OF CLASS DATA ========= -->
  356. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  357. <div class="bottomNav"><a name="navbar.bottom">
  358. <!-- -->
  359. </a>
  360. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  361. <a name="navbar.bottom.firstrow">
  362. <!-- -->
  363. </a>
  364. <ul class="navList" title="Navigation">
  365. <li><a href="../../../../overview-summary.html">Overview</a></li>
  366. <li><a href="package-summary.html">Package</a></li>
  367. <li class="navBarCell1Rev">Class</li>
  368. <li><a href="class-use/AbstractPieLabelDistributor.html">Use</a></li>
  369. <li><a href="package-tree.html">Tree</a></li>
  370. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  371. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  372. <li><a href="../../../../help-doc.html">Help</a></li>
  373. </ul>
  374. </div>
  375. <div class="subNav">
  376. <ul class="navList">
  377. <li>Prev&nbsp;Class</li>
  378. <li><a href="../../../../org/jfree/chart/plot/CategoryCrosshairState.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  379. </ul>
  380. <ul class="navList">
  381. <li><a href="../../../../index.html?org/jfree/chart/plot/AbstractPieLabelDistributor.html" target="_top">Frames</a></li>
  382. <li><a href="AbstractPieLabelDistributor.html" target="_top">No&nbsp;Frames</a></li>
  383. </ul>
  384. <ul class="navList" id="allclasses_navbar_bottom">
  385. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  386. </ul>
  387. <div>
  388. <script type="text/javascript"><!--
  389. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  390. if(window==top) {
  391. allClassesLink.style.display = "block";
  392. }
  393. else {
  394. allClassesLink.style.display = "none";
  395. }
  396. //-->
  397. </script>
  398. </div>
  399. <div>
  400. <ul class="subNavList">
  401. <li>Summary:&nbsp;</li>
  402. <li>Nested&nbsp;|&nbsp;</li>
  403. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  404. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  405. <li><a href="#method.summary">Method</a></li>
  406. </ul>
  407. <ul class="subNavList">
  408. <li>Detail:&nbsp;</li>
  409. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  410. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  411. <li><a href="#method.detail">Method</a></li>
  412. </ul>
  413. </div>
  414. <a name="skip.navbar.bottom">
  415. <!-- -->
  416. </a></div>
  417. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  418. </body>
  419. </html>