PieSectionLabelGenerator.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  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:31 CEST 2014 -->
  6. <title>PieSectionLabelGenerator (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="PieSectionLabelGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":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/PieSectionLabelGenerator.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/labels/MultipleXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/labels/PieToolTipGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/labels/PieSectionLabelGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="PieSectionLabelGenerator.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.labels</div>
  96. <h2 title="Interface PieSectionLabelGenerator" class="title">Interface PieSectionLabelGenerator</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/labels/StandardPieSectionLabelGenerator.html" title="class in org.jfree.chart.labels">StandardPieSectionLabelGenerator</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/labels/PieSectionLabelGenerator.html#line.67">PieSectionLabelGenerator</a></pre>
  109. <div class="block">Interface for a label generator for plots that use data from
  110. a <a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general"><code>PieDataset</code></a>.</div>
  111. </li>
  112. </ul>
  113. </div>
  114. <div class="summary">
  115. <ul class="blockList">
  116. <li class="blockList">
  117. <!-- ========== METHOD SUMMARY =========== -->
  118. <ul class="blockList">
  119. <li class="blockList"><a name="method.summary">
  120. <!-- -->
  121. </a>
  122. <h3>Method Summary</h3>
  123. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  124. <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>
  125. <tr>
  126. <th class="colFirst" scope="col">Modifier and Type</th>
  127. <th class="colLast" scope="col">Method and Description</th>
  128. </tr>
  129. <tr id="i0" class="altColor">
  130. <td class="colFirst"><code>java.text.AttributedString</code></td>
  131. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html#generateAttributedSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">generateAttributedSectionLabel</a></span>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  132. java.lang.Comparable&nbsp;key)</code>
  133. <div class="block">Generates an attributed label for the specified series, or
  134. <code>null</code> if no attributed label is available (in which case,
  135. the string returned by
  136. <a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-"><code>generateSectionLabel(PieDataset, Comparable)</code></a> will
  137. provide the fallback).</div>
  138. </td>
  139. </tr>
  140. <tr id="i1" class="rowColor">
  141. <td class="colFirst"><code>java.lang.String</code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">generateSectionLabel</a></span>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  143. java.lang.Comparable&nbsp;key)</code>
  144. <div class="block">Generates a label for a pie section.</div>
  145. </td>
  146. </tr>
  147. </table>
  148. </li>
  149. </ul>
  150. </li>
  151. </ul>
  152. </div>
  153. <div class="details">
  154. <ul class="blockList">
  155. <li class="blockList">
  156. <!-- ============ METHOD DETAIL ========== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="method.detail">
  159. <!-- -->
  160. </a>
  161. <h3>Method Detail</h3>
  162. <a name="generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">
  163. <!-- -->
  164. </a>
  165. <ul class="blockList">
  166. <li class="blockList">
  167. <h4>generateSectionLabel</h4>
  168. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/PieSectionLabelGenerator.html#line.77">generateSectionLabel</a>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  169. java.lang.Comparable&nbsp;key)</pre>
  170. <div class="block">Generates a label for a pie section.</div>
  171. <dl>
  172. <dt><span class="paramLabel">Parameters:</span></dt>
  173. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  174. <dd><code>key</code> - the section key (<code>null</code> not permitted).</dd>
  175. <dt><span class="returnLabel">Returns:</span></dt>
  176. <dd>The label (possibly <code>null</code>).</dd>
  177. </dl>
  178. </li>
  179. </ul>
  180. <a name="generateAttributedSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">
  181. <!-- -->
  182. </a>
  183. <ul class="blockListLast">
  184. <li class="blockList">
  185. <h4>generateAttributedSectionLabel</h4>
  186. <pre>java.text.AttributedString&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/PieSectionLabelGenerator.html#line.106">generateAttributedSectionLabel</a>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  187. java.lang.Comparable&nbsp;key)</pre>
  188. <div class="block">Generates an attributed label for the specified series, or
  189. <code>null</code> if no attributed label is available (in which case,
  190. the string returned by
  191. <a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-"><code>generateSectionLabel(PieDataset, Comparable)</code></a> will
  192. provide the fallback). Only certain attributes are recognised by the
  193. code that ultimately displays the labels:
  194. <ul>
  195. <li><code>TextAttribute.FONT</code>: will set the font;</li>
  196. <li><code>TextAttribute.POSTURE</code>: a value of
  197. <code>TextAttribute.POSTURE_OBLIQUE</code> will add <code>Font.ITALIC</code> to
  198. the current font;</li>
  199. <li><code>TextAttribute.WEIGHT</code>: a value of
  200. <code>TextAttribute.WEIGHT_BOLD</code> will add <code>Font.BOLD</code> to the
  201. current font;</li>
  202. <li><code>TextAttribute.FOREGROUND</code>: this will set the <code>Paint</code>
  203. for the current</li>
  204. <li><code>TextAttribute.SUPERSCRIPT</code>: the values
  205. <code>TextAttribute.SUPERSCRIPT_SUB</code> and
  206. <code>TextAttribute.SUPERSCRIPT_SUPER</code> are recognised.</li>
  207. </ul></div>
  208. <dl>
  209. <dt><span class="paramLabel">Parameters:</span></dt>
  210. <dd><code>dataset</code> - the dataset.</dd>
  211. <dd><code>key</code> - the key.</dd>
  212. <dt><span class="returnLabel">Returns:</span></dt>
  213. <dd>An attributed label (possibly <code>null</code>).</dd>
  214. </dl>
  215. </li>
  216. </ul>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. </div>
  222. </div>
  223. <!-- ========= END OF CLASS DATA ========= -->
  224. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  225. <div class="bottomNav"><a name="navbar.bottom">
  226. <!-- -->
  227. </a>
  228. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  229. <a name="navbar.bottom.firstrow">
  230. <!-- -->
  231. </a>
  232. <ul class="navList" title="Navigation">
  233. <li><a href="../../../../overview-summary.html">Overview</a></li>
  234. <li><a href="package-summary.html">Package</a></li>
  235. <li class="navBarCell1Rev">Class</li>
  236. <li><a href="class-use/PieSectionLabelGenerator.html">Use</a></li>
  237. <li><a href="package-tree.html">Tree</a></li>
  238. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  239. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  240. <li><a href="../../../../help-doc.html">Help</a></li>
  241. </ul>
  242. </div>
  243. <div class="subNav">
  244. <ul class="navList">
  245. <li><a href="../../../../org/jfree/chart/labels/MultipleXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  246. <li><a href="../../../../org/jfree/chart/labels/PieToolTipGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  247. </ul>
  248. <ul class="navList">
  249. <li><a href="../../../../index.html?org/jfree/chart/labels/PieSectionLabelGenerator.html" target="_top">Frames</a></li>
  250. <li><a href="PieSectionLabelGenerator.html" target="_top">No&nbsp;Frames</a></li>
  251. </ul>
  252. <ul class="navList" id="allclasses_navbar_bottom">
  253. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  254. </ul>
  255. <div>
  256. <script type="text/javascript"><!--
  257. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  258. if(window==top) {
  259. allClassesLink.style.display = "block";
  260. }
  261. else {
  262. allClassesLink.style.display = "none";
  263. }
  264. //-->
  265. </script>
  266. </div>
  267. <div>
  268. <ul class="subNavList">
  269. <li>Summary:&nbsp;</li>
  270. <li>Nested&nbsp;|&nbsp;</li>
  271. <li>Field&nbsp;|&nbsp;</li>
  272. <li>Constr&nbsp;|&nbsp;</li>
  273. <li><a href="#method.summary">Method</a></li>
  274. </ul>
  275. <ul class="subNavList">
  276. <li>Detail:&nbsp;</li>
  277. <li>Field&nbsp;|&nbsp;</li>
  278. <li>Constr&nbsp;|&nbsp;</li>
  279. <li><a href="#method.detail">Method</a></li>
  280. </ul>
  281. </div>
  282. <a name="skip.navbar.bottom">
  283. <!-- -->
  284. </a></div>
  285. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  286. </body>
  287. </html>