StandardPieSectionLabelGenerator.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607
  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>StandardPieSectionLabelGenerator (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="StandardPieSectionLabelGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/StandardPieSectionLabelGenerator.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/StandardCrosshairLabelGenerator.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/StandardPieToolTipGenerator.html" title="class 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/StandardPieSectionLabelGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="StandardPieSectionLabelGenerator.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.labels</div>
  96. <h2 title="Class StandardPieSectionLabelGenerator" class="title">Class StandardPieSectionLabelGenerator</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><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels">org.jfree.chart.labels.AbstractPieItemLabelGenerator</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.labels.StandardPieSectionLabelGenerator</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.Serializable, java.lang.Cloneable, <a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html" title="interface in org.jfree.chart.labels">PieSectionLabelGenerator</a>, org.jfree.util.PublicCloneable</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.72">StandardPieSectionLabelGenerator</a>
  122. extends <a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractPieItemLabelGenerator</a>
  123. implements <a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html" title="interface in org.jfree.chart.labels">PieSectionLabelGenerator</a>, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  124. <div class="block">A standard item label generator for plots that use data from a
  125. <a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general"><code>PieDataset</code></a>.
  126. <p>
  127. For the label format, use {0} where the pie section key should be inserted,
  128. {1} for the absolute section value and {2} for the percent amount of the pie
  129. section, e.g. <code>"{0} = {1} ({2})"</code> will display as
  130. <code>apple = 120 (5%)</code>.</div>
  131. <dl>
  132. <dt><span class="seeLabel">See Also:</span></dt>
  133. <dd><a href="../../../../serialized-form.html#org.jfree.chart.labels.StandardPieSectionLabelGenerator">Serialized Form</a></dd>
  134. </dl>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="summary">
  139. <ul class="blockList">
  140. <li class="blockList">
  141. <!-- =========== FIELD SUMMARY =========== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="field.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Field Summary</h3>
  147. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  148. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  149. <tr>
  150. <th class="colFirst" scope="col">Modifier and Type</th>
  151. <th class="colLast" scope="col">Field and Description</th>
  152. </tr>
  153. <tr class="altColor">
  154. <td class="colFirst"><code>static java.lang.String</code></td>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#DEFAULT_SECTION_LABEL_FORMAT">DEFAULT_SECTION_LABEL_FORMAT</a></span></code>
  156. <div class="block">The default section label format.</div>
  157. </td>
  158. </tr>
  159. </table>
  160. </li>
  161. </ul>
  162. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  163. <ul class="blockList">
  164. <li class="blockList"><a name="constructor.summary">
  165. <!-- -->
  166. </a>
  167. <h3>Constructor Summary</h3>
  168. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  169. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  170. <tr>
  171. <th class="colOne" scope="col">Constructor and Description</th>
  172. </tr>
  173. <tr class="altColor">
  174. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#StandardPieSectionLabelGenerator--">StandardPieSectionLabelGenerator</a></span>()</code>
  175. <div class="block">Creates a new section label generator using
  176. <a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#DEFAULT_SECTION_LABEL_FORMAT"><code>DEFAULT_SECTION_LABEL_FORMAT</code></a> as the label format string, and
  177. platform default number and percentage formatters.</div>
  178. </td>
  179. </tr>
  180. <tr class="rowColor">
  181. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#StandardPieSectionLabelGenerator-java.util.Locale-">StandardPieSectionLabelGenerator</a></span>(java.util.Locale&nbsp;locale)</code>
  182. <div class="block">Creates a new instance for the specified locale.</div>
  183. </td>
  184. </tr>
  185. <tr class="altColor">
  186. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#StandardPieSectionLabelGenerator-java.lang.String-">StandardPieSectionLabelGenerator</a></span>(java.lang.String&nbsp;labelFormat)</code>
  187. <div class="block">Creates a new section label generator using the specified label format
  188. string, and platform default number and percentage formatters.</div>
  189. </td>
  190. </tr>
  191. <tr class="rowColor">
  192. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#StandardPieSectionLabelGenerator-java.lang.String-java.util.Locale-">StandardPieSectionLabelGenerator</a></span>(java.lang.String&nbsp;labelFormat,
  193. java.util.Locale&nbsp;locale)</code>
  194. <div class="block">Creates a new instance for the specified locale.</div>
  195. </td>
  196. </tr>
  197. <tr class="altColor">
  198. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#StandardPieSectionLabelGenerator-java.lang.String-java.text.NumberFormat-java.text.NumberFormat-">StandardPieSectionLabelGenerator</a></span>(java.lang.String&nbsp;labelFormat,
  199. java.text.NumberFormat&nbsp;numberFormat,
  200. java.text.NumberFormat&nbsp;percentFormat)</code>
  201. <div class="block">Creates an item label generator using the specified number formatters.</div>
  202. </td>
  203. </tr>
  204. </table>
  205. </li>
  206. </ul>
  207. <!-- ========== METHOD SUMMARY =========== -->
  208. <ul class="blockList">
  209. <li class="blockList"><a name="method.summary">
  210. <!-- -->
  211. </a>
  212. <h3>Method Summary</h3>
  213. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  214. <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>
  215. <tr>
  216. <th class="colFirst" scope="col">Modifier and Type</th>
  217. <th class="colLast" scope="col">Method and Description</th>
  218. </tr>
  219. <tr id="i0" class="altColor">
  220. <td class="colFirst"><code>java.lang.Object</code></td>
  221. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#clone--">clone</a></span>()</code>
  222. <div class="block">Returns an independent copy of the generator.</div>
  223. </td>
  224. </tr>
  225. <tr id="i1" class="rowColor">
  226. <td class="colFirst"><code>boolean</code></td>
  227. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  228. <div class="block">Tests the generator for equality with an arbitrary object.</div>
  229. </td>
  230. </tr>
  231. <tr id="i2" class="altColor">
  232. <td class="colFirst"><code>java.text.AttributedString</code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.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,
  234. java.lang.Comparable&nbsp;key)</code>
  235. <div class="block">Generates an attributed label for the specified series, or
  236. <code>null</code> if no attributed label is available (in which case,
  237. the string returned by
  238. <a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-"><code>generateSectionLabel(PieDataset, Comparable)</code></a> will
  239. provide the fallback).</div>
  240. </td>
  241. </tr>
  242. <tr id="i3" class="rowColor">
  243. <td class="colFirst"><code>java.lang.String</code></td>
  244. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.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,
  245. java.lang.Comparable&nbsp;key)</code>
  246. <div class="block">Generates a label for a pie section.</div>
  247. </td>
  248. </tr>
  249. <tr id="i4" class="altColor">
  250. <td class="colFirst"><code>java.text.AttributedString</code></td>
  251. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#getAttributedLabel-int-">getAttributedLabel</a></span>(int&nbsp;section)</code>
  252. <div class="block">Returns the attributed label for a section, or <code>null</code> if none
  253. is defined.</div>
  254. </td>
  255. </tr>
  256. <tr id="i5" class="rowColor">
  257. <td class="colFirst"><code>void</code></td>
  258. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#setAttributedLabel-int-java.text.AttributedString-">setAttributedLabel</a></span>(int&nbsp;section,
  259. java.text.AttributedString&nbsp;label)</code>
  260. <div class="block">Sets the attributed label for a section.</div>
  261. </td>
  262. </tr>
  263. </table>
  264. <ul class="blockList">
  265. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.labels.AbstractPieItemLabelGenerator">
  266. <!-- -->
  267. </a>
  268. <h3>Methods inherited from class&nbsp;org.jfree.chart.labels.<a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractPieItemLabelGenerator</a></h3>
  269. <code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#createItemArray-org.jfree.data.general.PieDataset-java.lang.Comparable-">createItemArray</a>, <a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#getLabelFormat--">getLabelFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#getNumberFormat--">getNumberFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#getPercentFormat--">getPercentFormat</a>, <a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#hashCode--">hashCode</a></code></li>
  270. </ul>
  271. <ul class="blockList">
  272. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  273. <!-- -->
  274. </a>
  275. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  276. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  277. </ul>
  278. </li>
  279. </ul>
  280. </li>
  281. </ul>
  282. </div>
  283. <div class="details">
  284. <ul class="blockList">
  285. <li class="blockList">
  286. <!-- ============ FIELD DETAIL =========== -->
  287. <ul class="blockList">
  288. <li class="blockList"><a name="field.detail">
  289. <!-- -->
  290. </a>
  291. <h3>Field Detail</h3>
  292. <a name="DEFAULT_SECTION_LABEL_FORMAT">
  293. <!-- -->
  294. </a>
  295. <ul class="blockListLast">
  296. <li class="blockList">
  297. <h4>DEFAULT_SECTION_LABEL_FORMAT</h4>
  298. <pre>public static final&nbsp;java.lang.String <a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.81">DEFAULT_SECTION_LABEL_FORMAT</a></pre>
  299. <div class="block">The default section label format.</div>
  300. <dl>
  301. <dt><span class="seeLabel">See Also:</span></dt>
  302. <dd><a href="../../../../constant-values.html#org.jfree.chart.labels.StandardPieSectionLabelGenerator.DEFAULT_SECTION_LABEL_FORMAT">Constant Field Values</a></dd>
  303. </dl>
  304. </li>
  305. </ul>
  306. </li>
  307. </ul>
  308. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  309. <ul class="blockList">
  310. <li class="blockList"><a name="constructor.detail">
  311. <!-- -->
  312. </a>
  313. <h3>Constructor Detail</h3>
  314. <a name="StandardPieSectionLabelGenerator--">
  315. <!-- -->
  316. </a>
  317. <ul class="blockList">
  318. <li class="blockList">
  319. <h4>StandardPieSectionLabelGenerator</h4>
  320. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.94">StandardPieSectionLabelGenerator</a>()</pre>
  321. <div class="block">Creates a new section label generator using
  322. <a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#DEFAULT_SECTION_LABEL_FORMAT"><code>DEFAULT_SECTION_LABEL_FORMAT</code></a> as the label format string, and
  323. platform default number and percentage formatters.</div>
  324. </li>
  325. </ul>
  326. <a name="StandardPieSectionLabelGenerator-java.util.Locale-">
  327. <!-- -->
  328. </a>
  329. <ul class="blockList">
  330. <li class="blockList">
  331. <h4>StandardPieSectionLabelGenerator</h4>
  332. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.106">StandardPieSectionLabelGenerator</a>(java.util.Locale&nbsp;locale)</pre>
  333. <div class="block">Creates a new instance for the specified locale.</div>
  334. <dl>
  335. <dt><span class="paramLabel">Parameters:</span></dt>
  336. <dd><code>locale</code> - the local (<code>null</code> not permitted).</dd>
  337. <dt><span class="simpleTagLabel">Since:</span></dt>
  338. <dd>1.0.7</dd>
  339. </dl>
  340. </li>
  341. </ul>
  342. <a name="StandardPieSectionLabelGenerator-java.lang.String-">
  343. <!-- -->
  344. </a>
  345. <ul class="blockList">
  346. <li class="blockList">
  347. <h4>StandardPieSectionLabelGenerator</h4>
  348. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.116">StandardPieSectionLabelGenerator</a>(java.lang.String&nbsp;labelFormat)</pre>
  349. <div class="block">Creates a new section label generator using the specified label format
  350. string, and platform default number and percentage formatters.</div>
  351. <dl>
  352. <dt><span class="paramLabel">Parameters:</span></dt>
  353. <dd><code>labelFormat</code> - the label format (<code>null</code> not permitted).</dd>
  354. </dl>
  355. </li>
  356. </ul>
  357. <a name="StandardPieSectionLabelGenerator-java.lang.String-java.util.Locale-">
  358. <!-- -->
  359. </a>
  360. <ul class="blockList">
  361. <li class="blockList">
  362. <h4>StandardPieSectionLabelGenerator</h4>
  363. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.129">StandardPieSectionLabelGenerator</a>(java.lang.String&nbsp;labelFormat,
  364. java.util.Locale&nbsp;locale)</pre>
  365. <div class="block">Creates a new instance for the specified locale.</div>
  366. <dl>
  367. <dt><span class="paramLabel">Parameters:</span></dt>
  368. <dd><code>labelFormat</code> - the label format (<code>null</code> not permitted).</dd>
  369. <dd><code>locale</code> - the local (<code>null</code> not permitted).</dd>
  370. <dt><span class="simpleTagLabel">Since:</span></dt>
  371. <dd>1.0.7</dd>
  372. </dl>
  373. </li>
  374. </ul>
  375. <a name="StandardPieSectionLabelGenerator-java.lang.String-java.text.NumberFormat-java.text.NumberFormat-">
  376. <!-- -->
  377. </a>
  378. <ul class="blockListLast">
  379. <li class="blockList">
  380. <h4>StandardPieSectionLabelGenerator</h4>
  381. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.144">StandardPieSectionLabelGenerator</a>(java.lang.String&nbsp;labelFormat,
  382. java.text.NumberFormat&nbsp;numberFormat,
  383. java.text.NumberFormat&nbsp;percentFormat)</pre>
  384. <div class="block">Creates an item label generator using the specified number formatters.</div>
  385. <dl>
  386. <dt><span class="paramLabel">Parameters:</span></dt>
  387. <dd><code>labelFormat</code> - the label format string (<code>null</code> not
  388. permitted).</dd>
  389. <dd><code>numberFormat</code> - the format object for the values (<code>null</code>
  390. not permitted).</dd>
  391. <dd><code>percentFormat</code> - the format object for the percentages
  392. (<code>null</code> not permitted).</dd>
  393. </dl>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. <!-- ============ METHOD DETAIL ========== -->
  399. <ul class="blockList">
  400. <li class="blockList"><a name="method.detail">
  401. <!-- -->
  402. </a>
  403. <h3>Method Detail</h3>
  404. <a name="getAttributedLabel-int-">
  405. <!-- -->
  406. </a>
  407. <ul class="blockList">
  408. <li class="blockList">
  409. <h4>getAttributedLabel</h4>
  410. <pre>public&nbsp;java.text.AttributedString&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.158">getAttributedLabel</a>(int&nbsp;section)</pre>
  411. <div class="block">Returns the attributed label for a section, or <code>null</code> if none
  412. is defined.</div>
  413. <dl>
  414. <dt><span class="paramLabel">Parameters:</span></dt>
  415. <dd><code>section</code> - the section index.</dd>
  416. <dt><span class="returnLabel">Returns:</span></dt>
  417. <dd>The attributed label.</dd>
  418. </dl>
  419. </li>
  420. </ul>
  421. <a name="setAttributedLabel-int-java.text.AttributedString-">
  422. <!-- -->
  423. </a>
  424. <ul class="blockList">
  425. <li class="blockList">
  426. <h4>setAttributedLabel</h4>
  427. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.168">setAttributedLabel</a>(int&nbsp;section,
  428. java.text.AttributedString&nbsp;label)</pre>
  429. <div class="block">Sets the attributed label for a section.</div>
  430. <dl>
  431. <dt><span class="paramLabel">Parameters:</span></dt>
  432. <dd><code>section</code> - the section index.</dd>
  433. <dd><code>label</code> - the label (<code>null</code> permitted).</dd>
  434. </dl>
  435. </li>
  436. </ul>
  437. <a name="generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">
  438. <!-- -->
  439. </a>
  440. <ul class="blockList">
  441. <li class="blockList">
  442. <h4>generateSectionLabel</h4>
  443. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.181">generateSectionLabel</a>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  444. java.lang.Comparable&nbsp;key)</pre>
  445. <div class="block">Generates a label for a pie section.</div>
  446. <dl>
  447. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  448. <dd><code><a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">generateSectionLabel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html" title="interface in org.jfree.chart.labels">PieSectionLabelGenerator</a></code></dd>
  449. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  450. <dd><code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">generateSectionLabel</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractPieItemLabelGenerator</a></code></dd>
  451. <dt><span class="paramLabel">Parameters:</span></dt>
  452. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  453. <dd><code>key</code> - the section key (<code>null</code> not permitted).</dd>
  454. <dt><span class="returnLabel">Returns:</span></dt>
  455. <dd>The label (possibly <code>null</code>).</dd>
  456. </dl>
  457. </li>
  458. </ul>
  459. <a name="generateAttributedSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">
  460. <!-- -->
  461. </a>
  462. <ul class="blockList">
  463. <li class="blockList">
  464. <h4>generateAttributedSectionLabel</h4>
  465. <pre>public&nbsp;java.text.AttributedString&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.213">generateAttributedSectionLabel</a>(<a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a>&nbsp;dataset,
  466. java.lang.Comparable&nbsp;key)</pre>
  467. <div class="block">Generates an attributed label for the specified series, or
  468. <code>null</code> if no attributed label is available (in which case,
  469. the string returned by
  470. <a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#generateSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-"><code>generateSectionLabel(PieDataset, Comparable)</code></a> will
  471. provide the fallback). Only certain attributes are recognised by the
  472. code that ultimately displays the labels:
  473. <ul>
  474. <li><code>TextAttribute.FONT</code>: will set the font;</li>
  475. <li><code>TextAttribute.POSTURE</code>: a value of
  476. <code>TextAttribute.POSTURE_OBLIQUE</code> will add <code>Font.ITALIC</code> to
  477. the current font;</li>
  478. <li><code>TextAttribute.WEIGHT</code>: a value of
  479. <code>TextAttribute.WEIGHT_BOLD</code> will add <code>Font.BOLD</code> to the
  480. current font;</li>
  481. <li><code>TextAttribute.FOREGROUND</code>: this will set the <code>Paint</code>
  482. for the current</li>
  483. <li><code>TextAttribute.SUPERSCRIPT</code>: the values
  484. <code>TextAttribute.SUPERSCRIPT_SUB</code> and
  485. <code>TextAttribute.SUPERSCRIPT_SUPER</code> are recognised.</li>
  486. </ul></div>
  487. <dl>
  488. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  489. <dd><code><a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html#generateAttributedSectionLabel-org.jfree.data.general.PieDataset-java.lang.Comparable-">generateAttributedSectionLabel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/labels/PieSectionLabelGenerator.html" title="interface in org.jfree.chart.labels">PieSectionLabelGenerator</a></code></dd>
  490. <dt><span class="paramLabel">Parameters:</span></dt>
  491. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  492. <dd><code>key</code> - the key.</dd>
  493. <dt><span class="returnLabel">Returns:</span></dt>
  494. <dd>An attributed label (possibly <code>null</code>).</dd>
  495. </dl>
  496. </li>
  497. </ul>
  498. <a name="equals-java.lang.Object-">
  499. <!-- -->
  500. </a>
  501. <ul class="blockList">
  502. <li class="blockList">
  503. <h4>equals</h4>
  504. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.226">equals</a>(java.lang.Object&nbsp;obj)</pre>
  505. <div class="block">Tests the generator for equality with an arbitrary object.</div>
  506. <dl>
  507. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  508. <dd><code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractPieItemLabelGenerator</a></code></dd>
  509. <dt><span class="paramLabel">Parameters:</span></dt>
  510. <dd><code>obj</code> - the object to test against (<code>null</code> permitted).</dd>
  511. <dt><span class="returnLabel">Returns:</span></dt>
  512. <dd>A boolean.</dd>
  513. </dl>
  514. </li>
  515. </ul>
  516. <a name="clone--">
  517. <!-- -->
  518. </a>
  519. <ul class="blockListLast">
  520. <li class="blockList">
  521. <h4>clone</h4>
  522. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardPieSectionLabelGenerator.html#line.249">clone</a>()
  523. throws java.lang.CloneNotSupportedException</pre>
  524. <div class="block">Returns an independent copy of the generator.</div>
  525. <dl>
  526. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  527. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  528. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  529. <dd><code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/labels/AbstractPieItemLabelGenerator.html" title="class in org.jfree.chart.labels">AbstractPieItemLabelGenerator</a></code></dd>
  530. <dt><span class="returnLabel">Returns:</span></dt>
  531. <dd>A clone.</dd>
  532. <dt><span class="throwsLabel">Throws:</span></dt>
  533. <dd><code>java.lang.CloneNotSupportedException</code> - should not happen.</dd>
  534. </dl>
  535. </li>
  536. </ul>
  537. </li>
  538. </ul>
  539. </li>
  540. </ul>
  541. </div>
  542. </div>
  543. <!-- ========= END OF CLASS DATA ========= -->
  544. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  545. <div class="bottomNav"><a name="navbar.bottom">
  546. <!-- -->
  547. </a>
  548. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  549. <a name="navbar.bottom.firstrow">
  550. <!-- -->
  551. </a>
  552. <ul class="navList" title="Navigation">
  553. <li><a href="../../../../overview-summary.html">Overview</a></li>
  554. <li><a href="package-summary.html">Package</a></li>
  555. <li class="navBarCell1Rev">Class</li>
  556. <li><a href="class-use/StandardPieSectionLabelGenerator.html">Use</a></li>
  557. <li><a href="package-tree.html">Tree</a></li>
  558. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  559. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  560. <li><a href="../../../../help-doc.html">Help</a></li>
  561. </ul>
  562. </div>
  563. <div class="subNav">
  564. <ul class="navList">
  565. <li><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  566. <li><a href="../../../../org/jfree/chart/labels/StandardPieToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  567. </ul>
  568. <ul class="navList">
  569. <li><a href="../../../../index.html?org/jfree/chart/labels/StandardPieSectionLabelGenerator.html" target="_top">Frames</a></li>
  570. <li><a href="StandardPieSectionLabelGenerator.html" target="_top">No&nbsp;Frames</a></li>
  571. </ul>
  572. <ul class="navList" id="allclasses_navbar_bottom">
  573. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  574. </ul>
  575. <div>
  576. <script type="text/javascript"><!--
  577. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  578. if(window==top) {
  579. allClassesLink.style.display = "block";
  580. }
  581. else {
  582. allClassesLink.style.display = "none";
  583. }
  584. //-->
  585. </script>
  586. </div>
  587. <div>
  588. <ul class="subNavList">
  589. <li>Summary:&nbsp;</li>
  590. <li>Nested&nbsp;|&nbsp;</li>
  591. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  592. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  593. <li><a href="#method.summary">Method</a></li>
  594. </ul>
  595. <ul class="subNavList">
  596. <li>Detail:&nbsp;</li>
  597. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  598. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  599. <li><a href="#method.detail">Method</a></li>
  600. </ul>
  601. </div>
  602. <a name="skip.navbar.bottom">
  603. <!-- -->
  604. </a></div>
  605. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  606. </body>
  607. </html>