LegendItemCollection.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  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:26 CEST 2014 -->
  6. <title>LegendItemCollection (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="LegendItemCollection (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,"i6":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/LegendItemCollection.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/LegendItem.html" title="class in org.jfree.chart"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/chart/LegendItemSource.html" title="interface in org.jfree.chart"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../index.html?org/jfree/chart/LegendItemCollection.html" target="_top">Frames</a></li>
  57. <li><a href="LegendItemCollection.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</div>
  96. <h2 title="Class LegendItemCollection" class="title">Class LegendItemCollection</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.LegendItemCollection</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, java.lang.Cloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.57">LegendItemCollection</a>
  117. extends java.lang.Object
  118. implements java.lang.Cloneable, java.io.Serializable</pre>
  119. <div class="block">A collection of legend items.</div>
  120. <dl>
  121. <dt><span class="seeLabel">See Also:</span></dt>
  122. <dd><a href="../../../serialized-form.html#org.jfree.chart.LegendItemCollection">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/LegendItemCollection.html#LegendItemCollection--">LegendItemCollection</a></span>()</code>
  143. <div class="block">Constructs a new legend item collection, initially empty.</div>
  144. </td>
  145. </tr>
  146. </table>
  147. </li>
  148. </ul>
  149. <!-- ========== METHOD SUMMARY =========== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="method.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Method Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  156. <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>
  157. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colLast" scope="col">Method and Description</th>
  160. </tr>
  161. <tr id="i0" class="altColor">
  162. <td class="colFirst"><code>void</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#add-org.jfree.chart.LegendItem-">add</a></span>(<a href="../../../org/jfree/chart/LegendItem.html" title="class in org.jfree.chart">LegendItem</a>&nbsp;item)</code>
  164. <div class="block">Adds a legend item to the collection.</div>
  165. </td>
  166. </tr>
  167. <tr id="i1" class="rowColor">
  168. <td class="colFirst"><code>void</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#addAll-org.jfree.chart.LegendItemCollection-">addAll</a></span>(<a href="../../../org/jfree/chart/LegendItemCollection.html" title="class in org.jfree.chart">LegendItemCollection</a>&nbsp;collection)</code>
  170. <div class="block">Adds the legend items from another collection to this collection.</div>
  171. </td>
  172. </tr>
  173. <tr id="i2" class="altColor">
  174. <td class="colFirst"><code>java.lang.Object</code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#clone--">clone</a></span>()</code>
  176. <div class="block">Returns a clone of the collection.</div>
  177. </td>
  178. </tr>
  179. <tr id="i3" class="rowColor">
  180. <td class="colFirst"><code>boolean</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  182. <div class="block">Tests this collection for equality with an arbitrary object.</div>
  183. </td>
  184. </tr>
  185. <tr id="i4" class="altColor">
  186. <td class="colFirst"><code><a href="../../../org/jfree/chart/LegendItem.html" title="class in org.jfree.chart">LegendItem</a></code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#get-int-">get</a></span>(int&nbsp;index)</code>
  188. <div class="block">Returns a legend item from the collection.</div>
  189. </td>
  190. </tr>
  191. <tr id="i5" class="rowColor">
  192. <td class="colFirst"><code>int</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#getItemCount--">getItemCount</a></span>()</code>
  194. <div class="block">Returns the number of legend items in the collection.</div>
  195. </td>
  196. </tr>
  197. <tr id="i6" class="altColor">
  198. <td class="colFirst"><code>java.util.Iterator</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/LegendItemCollection.html#iterator--">iterator</a></span>()</code>
  200. <div class="block">Returns an iterator that provides access to all the legend items.</div>
  201. </td>
  202. </tr>
  203. </table>
  204. <ul class="blockList">
  205. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  206. <!-- -->
  207. </a>
  208. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  209. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </div>
  216. <div class="details">
  217. <ul class="blockList">
  218. <li class="blockList">
  219. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  220. <ul class="blockList">
  221. <li class="blockList"><a name="constructor.detail">
  222. <!-- -->
  223. </a>
  224. <h3>Constructor Detail</h3>
  225. <a name="LegendItemCollection--">
  226. <!-- -->
  227. </a>
  228. <ul class="blockListLast">
  229. <li class="blockList">
  230. <h4>LegendItemCollection</h4>
  231. <pre>public&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.68">LegendItemCollection</a>()</pre>
  232. <div class="block">Constructs a new legend item collection, initially empty.</div>
  233. </li>
  234. </ul>
  235. </li>
  236. </ul>
  237. <!-- ============ METHOD DETAIL ========== -->
  238. <ul class="blockList">
  239. <li class="blockList"><a name="method.detail">
  240. <!-- -->
  241. </a>
  242. <h3>Method Detail</h3>
  243. <a name="add-org.jfree.chart.LegendItem-">
  244. <!-- -->
  245. </a>
  246. <ul class="blockList">
  247. <li class="blockList">
  248. <h4>add</h4>
  249. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.77">add</a>(<a href="../../../org/jfree/chart/LegendItem.html" title="class in org.jfree.chart">LegendItem</a>&nbsp;item)</pre>
  250. <div class="block">Adds a legend item to the collection.</div>
  251. <dl>
  252. <dt><span class="paramLabel">Parameters:</span></dt>
  253. <dd><code>item</code> - the item to add.</dd>
  254. </dl>
  255. </li>
  256. </ul>
  257. <a name="addAll-org.jfree.chart.LegendItemCollection-">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>addAll</h4>
  263. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.87">addAll</a>(<a href="../../../org/jfree/chart/LegendItemCollection.html" title="class in org.jfree.chart">LegendItemCollection</a>&nbsp;collection)</pre>
  264. <div class="block">Adds the legend items from another collection to this collection.</div>
  265. <dl>
  266. <dt><span class="paramLabel">Parameters:</span></dt>
  267. <dd><code>collection</code> - the other collection (<code>null</code> not
  268. permitted).</dd>
  269. </dl>
  270. </li>
  271. </ul>
  272. <a name="get-int-">
  273. <!-- -->
  274. </a>
  275. <ul class="blockList">
  276. <li class="blockList">
  277. <h4>get</h4>
  278. <pre>public&nbsp;<a href="../../../org/jfree/chart/LegendItem.html" title="class in org.jfree.chart">LegendItem</a>&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.98">get</a>(int&nbsp;index)</pre>
  279. <div class="block">Returns a legend item from the collection.</div>
  280. <dl>
  281. <dt><span class="paramLabel">Parameters:</span></dt>
  282. <dd><code>index</code> - the legend item index (zero-based).</dd>
  283. <dt><span class="returnLabel">Returns:</span></dt>
  284. <dd>The legend item.</dd>
  285. </dl>
  286. </li>
  287. </ul>
  288. <a name="getItemCount--">
  289. <!-- -->
  290. </a>
  291. <ul class="blockList">
  292. <li class="blockList">
  293. <h4>getItemCount</h4>
  294. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.107">getItemCount</a>()</pre>
  295. <div class="block">Returns the number of legend items in the collection.</div>
  296. <dl>
  297. <dt><span class="returnLabel">Returns:</span></dt>
  298. <dd>The item count.</dd>
  299. </dl>
  300. </li>
  301. </ul>
  302. <a name="iterator--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockList">
  306. <li class="blockList">
  307. <h4>iterator</h4>
  308. <pre>public&nbsp;java.util.Iterator&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.116">iterator</a>()</pre>
  309. <div class="block">Returns an iterator that provides access to all the legend items.</div>
  310. <dl>
  311. <dt><span class="returnLabel">Returns:</span></dt>
  312. <dd>An iterator.</dd>
  313. </dl>
  314. </li>
  315. </ul>
  316. <a name="equals-java.lang.Object-">
  317. <!-- -->
  318. </a>
  319. <ul class="blockList">
  320. <li class="blockList">
  321. <h4>equals</h4>
  322. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.128">equals</a>(java.lang.Object&nbsp;obj)</pre>
  323. <div class="block">Tests this collection for equality with an arbitrary object.</div>
  324. <dl>
  325. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  326. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  327. <dt><span class="paramLabel">Parameters:</span></dt>
  328. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  329. <dt><span class="returnLabel">Returns:</span></dt>
  330. <dd>A boolean.</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. <a name="clone--">
  335. <!-- -->
  336. </a>
  337. <ul class="blockListLast">
  338. <li class="blockList">
  339. <h4>clone</h4>
  340. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/chart/LegendItemCollection.html#line.151">clone</a>()
  341. throws java.lang.CloneNotSupportedException</pre>
  342. <div class="block">Returns a clone of the collection.</div>
  343. <dl>
  344. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  345. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  346. <dt><span class="returnLabel">Returns:</span></dt>
  347. <dd>A clone.</dd>
  348. <dt><span class="throwsLabel">Throws:</span></dt>
  349. <dd><code>java.lang.CloneNotSupportedException</code> - if an item in the collection is not
  350. cloneable.</dd>
  351. </dl>
  352. </li>
  353. </ul>
  354. </li>
  355. </ul>
  356. </li>
  357. </ul>
  358. </div>
  359. </div>
  360. <!-- ========= END OF CLASS DATA ========= -->
  361. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  362. <div class="bottomNav"><a name="navbar.bottom">
  363. <!-- -->
  364. </a>
  365. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  366. <a name="navbar.bottom.firstrow">
  367. <!-- -->
  368. </a>
  369. <ul class="navList" title="Navigation">
  370. <li><a href="../../../overview-summary.html">Overview</a></li>
  371. <li><a href="package-summary.html">Package</a></li>
  372. <li class="navBarCell1Rev">Class</li>
  373. <li><a href="class-use/LegendItemCollection.html">Use</a></li>
  374. <li><a href="package-tree.html">Tree</a></li>
  375. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  376. <li><a href="../../../index-files/index-1.html">Index</a></li>
  377. <li><a href="../../../help-doc.html">Help</a></li>
  378. </ul>
  379. </div>
  380. <div class="subNav">
  381. <ul class="navList">
  382. <li><a href="../../../org/jfree/chart/LegendItem.html" title="class in org.jfree.chart"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  383. <li><a href="../../../org/jfree/chart/LegendItemSource.html" title="interface in org.jfree.chart"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  384. </ul>
  385. <ul class="navList">
  386. <li><a href="../../../index.html?org/jfree/chart/LegendItemCollection.html" target="_top">Frames</a></li>
  387. <li><a href="LegendItemCollection.html" target="_top">No&nbsp;Frames</a></li>
  388. </ul>
  389. <ul class="navList" id="allclasses_navbar_bottom">
  390. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  391. </ul>
  392. <div>
  393. <script type="text/javascript"><!--
  394. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  395. if(window==top) {
  396. allClassesLink.style.display = "block";
  397. }
  398. else {
  399. allClassesLink.style.display = "none";
  400. }
  401. //-->
  402. </script>
  403. </div>
  404. <div>
  405. <ul class="subNavList">
  406. <li>Summary:&nbsp;</li>
  407. <li>Nested&nbsp;|&nbsp;</li>
  408. <li>Field&nbsp;|&nbsp;</li>
  409. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  410. <li><a href="#method.summary">Method</a></li>
  411. </ul>
  412. <ul class="subNavList">
  413. <li>Detail:&nbsp;</li>
  414. <li>Field&nbsp;|&nbsp;</li>
  415. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  416. <li><a href="#method.detail">Method</a></li>
  417. </ul>
  418. </div>
  419. <a name="skip.navbar.bottom">
  420. <!-- -->
  421. </a></div>
  422. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  423. </body>
  424. </html>