EntityCollection.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  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:30 CEST 2014 -->
  6. <title>EntityCollection (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="EntityCollection (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/EntityCollection.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/entity/ContourEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/entity/JFreeChartEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/entity/EntityCollection.html" target="_top">Frames</a></li>
  57. <li><a href="EntityCollection.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.entity</div>
  96. <h2 title="Interface EntityCollection" class="title">Interface EntityCollection</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/entity/StandardEntityCollection.html" title="class in org.jfree.chart.entity">StandardEntityCollection</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.57">EntityCollection</a></pre>
  109. <div class="block">This interface defines the methods used to access an ordered list of
  110. <a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity"><code>ChartEntity</code></a> objects.</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>void</code></td>
  131. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#add-org.jfree.chart.entity.ChartEntity-">add</a></span>(<a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;entity)</code>
  132. <div class="block">Adds an entity to the collection.</div>
  133. </td>
  134. </tr>
  135. <tr id="i1" class="rowColor">
  136. <td class="colFirst"><code>void</code></td>
  137. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#addAll-org.jfree.chart.entity.EntityCollection-">addAll</a></span>(<a href="../../../../org/jfree/chart/entity/EntityCollection.html" title="interface in org.jfree.chart.entity">EntityCollection</a>&nbsp;collection)</code>
  138. <div class="block">Adds the entities from another collection to this collection.</div>
  139. </td>
  140. </tr>
  141. <tr id="i2" class="altColor">
  142. <td class="colFirst"><code>void</code></td>
  143. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#clear--">clear</a></span>()</code>
  144. <div class="block">Clears all entities.</div>
  145. </td>
  146. </tr>
  147. <tr id="i3" class="rowColor">
  148. <td class="colFirst"><code>java.util.Collection</code></td>
  149. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#getEntities--">getEntities</a></span>()</code>
  150. <div class="block">Returns the entities in an unmodifiable collection.</div>
  151. </td>
  152. </tr>
  153. <tr id="i4" class="altColor">
  154. <td class="colFirst"><code><a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a></code></td>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#getEntity-double-double-">getEntity</a></span>(double&nbsp;x,
  156. double&nbsp;y)</code>
  157. <div class="block">Returns an entity whose area contains the specified point.</div>
  158. </td>
  159. </tr>
  160. <tr id="i5" class="rowColor">
  161. <td class="colFirst"><code><a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a></code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#getEntity-int-">getEntity</a></span>(int&nbsp;index)</code>
  163. <div class="block">Returns an entity from the collection.</div>
  164. </td>
  165. </tr>
  166. <tr id="i6" class="altColor">
  167. <td class="colFirst"><code>int</code></td>
  168. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#getEntityCount--">getEntityCount</a></span>()</code>
  169. <div class="block">Returns the entity count.</div>
  170. </td>
  171. </tr>
  172. <tr id="i7" class="rowColor">
  173. <td class="colFirst"><code>java.util.Iterator</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/EntityCollection.html#iterator--">iterator</a></span>()</code>
  175. <div class="block">Returns an iterator for the entities in the collection.</div>
  176. </td>
  177. </tr>
  178. </table>
  179. </li>
  180. </ul>
  181. </li>
  182. </ul>
  183. </div>
  184. <div class="details">
  185. <ul class="blockList">
  186. <li class="blockList">
  187. <!-- ============ METHOD DETAIL ========== -->
  188. <ul class="blockList">
  189. <li class="blockList"><a name="method.detail">
  190. <!-- -->
  191. </a>
  192. <h3>Method Detail</h3>
  193. <a name="clear--">
  194. <!-- -->
  195. </a>
  196. <ul class="blockList">
  197. <li class="blockList">
  198. <h4>clear</h4>
  199. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.62">clear</a>()</pre>
  200. <div class="block">Clears all entities.</div>
  201. </li>
  202. </ul>
  203. <a name="add-org.jfree.chart.entity.ChartEntity-">
  204. <!-- -->
  205. </a>
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <h4>add</h4>
  209. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.69">add</a>(<a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;entity)</pre>
  210. <div class="block">Adds an entity to the collection.</div>
  211. <dl>
  212. <dt><span class="paramLabel">Parameters:</span></dt>
  213. <dd><code>entity</code> - the entity (<code>null</code> not permitted).</dd>
  214. </dl>
  215. </li>
  216. </ul>
  217. <a name="addAll-org.jfree.chart.entity.EntityCollection-">
  218. <!-- -->
  219. </a>
  220. <ul class="blockList">
  221. <li class="blockList">
  222. <h4>addAll</h4>
  223. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.76">addAll</a>(<a href="../../../../org/jfree/chart/entity/EntityCollection.html" title="interface in org.jfree.chart.entity">EntityCollection</a>&nbsp;collection)</pre>
  224. <div class="block">Adds the entities from another collection to this collection.</div>
  225. <dl>
  226. <dt><span class="paramLabel">Parameters:</span></dt>
  227. <dd><code>collection</code> - the other collection.</dd>
  228. </dl>
  229. </li>
  230. </ul>
  231. <a name="getEntity-double-double-">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>getEntity</h4>
  237. <pre><a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.86">getEntity</a>(double&nbsp;x,
  238. double&nbsp;y)</pre>
  239. <div class="block">Returns an entity whose area contains the specified point.</div>
  240. <dl>
  241. <dt><span class="paramLabel">Parameters:</span></dt>
  242. <dd><code>x</code> - the x coordinate.</dd>
  243. <dd><code>y</code> - the y coordinate.</dd>
  244. <dt><span class="returnLabel">Returns:</span></dt>
  245. <dd>The entity.</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="getEntity-int-">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>getEntity</h4>
  255. <pre><a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.95">getEntity</a>(int&nbsp;index)</pre>
  256. <div class="block">Returns an entity from the collection.</div>
  257. <dl>
  258. <dt><span class="paramLabel">Parameters:</span></dt>
  259. <dd><code>index</code> - the index (zero-based).</dd>
  260. <dt><span class="returnLabel">Returns:</span></dt>
  261. <dd>An entity.</dd>
  262. </dl>
  263. </li>
  264. </ul>
  265. <a name="getEntityCount--">
  266. <!-- -->
  267. </a>
  268. <ul class="blockList">
  269. <li class="blockList">
  270. <h4>getEntityCount</h4>
  271. <pre>int&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.102">getEntityCount</a>()</pre>
  272. <div class="block">Returns the entity count.</div>
  273. <dl>
  274. <dt><span class="returnLabel">Returns:</span></dt>
  275. <dd>The entity count.</dd>
  276. </dl>
  277. </li>
  278. </ul>
  279. <a name="getEntities--">
  280. <!-- -->
  281. </a>
  282. <ul class="blockList">
  283. <li class="blockList">
  284. <h4>getEntities</h4>
  285. <pre>java.util.Collection&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.109">getEntities</a>()</pre>
  286. <div class="block">Returns the entities in an unmodifiable collection.</div>
  287. <dl>
  288. <dt><span class="returnLabel">Returns:</span></dt>
  289. <dd>The entities.</dd>
  290. </dl>
  291. </li>
  292. </ul>
  293. <a name="iterator--">
  294. <!-- -->
  295. </a>
  296. <ul class="blockListLast">
  297. <li class="blockList">
  298. <h4>iterator</h4>
  299. <pre>java.util.Iterator&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/EntityCollection.html#line.116">iterator</a>()</pre>
  300. <div class="block">Returns an iterator for the entities in the collection.</div>
  301. <dl>
  302. <dt><span class="returnLabel">Returns:</span></dt>
  303. <dd>An iterator.</dd>
  304. </dl>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </li>
  310. </ul>
  311. </div>
  312. </div>
  313. <!-- ========= END OF CLASS DATA ========= -->
  314. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  315. <div class="bottomNav"><a name="navbar.bottom">
  316. <!-- -->
  317. </a>
  318. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  319. <a name="navbar.bottom.firstrow">
  320. <!-- -->
  321. </a>
  322. <ul class="navList" title="Navigation">
  323. <li><a href="../../../../overview-summary.html">Overview</a></li>
  324. <li><a href="package-summary.html">Package</a></li>
  325. <li class="navBarCell1Rev">Class</li>
  326. <li><a href="class-use/EntityCollection.html">Use</a></li>
  327. <li><a href="package-tree.html">Tree</a></li>
  328. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  329. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  330. <li><a href="../../../../help-doc.html">Help</a></li>
  331. </ul>
  332. </div>
  333. <div class="subNav">
  334. <ul class="navList">
  335. <li><a href="../../../../org/jfree/chart/entity/ContourEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  336. <li><a href="../../../../org/jfree/chart/entity/JFreeChartEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  337. </ul>
  338. <ul class="navList">
  339. <li><a href="../../../../index.html?org/jfree/chart/entity/EntityCollection.html" target="_top">Frames</a></li>
  340. <li><a href="EntityCollection.html" target="_top">No&nbsp;Frames</a></li>
  341. </ul>
  342. <ul class="navList" id="allclasses_navbar_bottom">
  343. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  344. </ul>
  345. <div>
  346. <script type="text/javascript"><!--
  347. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  348. if(window==top) {
  349. allClassesLink.style.display = "block";
  350. }
  351. else {
  352. allClassesLink.style.display = "none";
  353. }
  354. //-->
  355. </script>
  356. </div>
  357. <div>
  358. <ul class="subNavList">
  359. <li>Summary:&nbsp;</li>
  360. <li>Nested&nbsp;|&nbsp;</li>
  361. <li>Field&nbsp;|&nbsp;</li>
  362. <li>Constr&nbsp;|&nbsp;</li>
  363. <li><a href="#method.summary">Method</a></li>
  364. </ul>
  365. <ul class="subNavList">
  366. <li>Detail:&nbsp;</li>
  367. <li>Field&nbsp;|&nbsp;</li>
  368. <li>Constr&nbsp;|&nbsp;</li>
  369. <li><a href="#method.detail">Method</a></li>
  370. </ul>
  371. </div>
  372. <a name="skip.navbar.bottom">
  373. <!-- -->
  374. </a></div>
  375. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  376. </body>
  377. </html>