PageRenderTime 4931ms CodeModel.GetById 54ms RepoModel.GetById 2ms app.codeStats 0ms

/deploy/doc/apidoc/org/as3commons/collections/utils/Lists.html

http://github.com/AS3Commons/as3commons-collections
HTML | 752 lines | 672 code | 71 blank | 9 comment | 0 complexity | 4266369e45e926a8c074ce3ab75d0b08 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    5. 

  5. <link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
    6. 

  6. <link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
    7. 

  7. <meta content="Lists,org.as3commons.collections.utils.Lists,addFromArgs,addFromArray,addFromCollection,clone,copy,newArrayList,newSortedList" name="keywords">
    8. 

  8. <title>org.as3commons.collections.utils.Lists</title>
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. <script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
    12. 

  12. <!--
    13. 

  13. 				asdocTitle = 'Lists - AS3Commons Collections 1.3.2';
    14. 

  14. 				var baseRef = '../../../../';
    15. 

  15. 				window.onload = configPage;
    16. 

  16. 			--></script>
    17. 

  17. <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
    18. 

  18. <tr>
    19. 

  19. <td align="left" class="titleTableTitle">AS3Commons Collections 1.3.2</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/as3commons/collections/utils/Lists.html&amp;org/as3commons/collections/utils/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
    20. 

  20. </tr>
    21. 

  21. <tr class="titleTableRow2">
    22. 

  22. <td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Lists</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
    23. 

  23. </tr>
    24. 

  24. <tr class="titleTableRow3">
    25. 

  25. <td colspan="2">&nbsp;</td>
    26. 

  26. </tr>
    27. 

  27. </table>
    28. 

  28. <script type="text/javascript" language="javascript">
    29. 

  29. <!--
    30. 

  30. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Lists"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
    31. 

  31. --></script>
    32. 

  32. <div class="MainContent">
    33. 

  33. <table cellspacing="0" cellpadding="0" class="classHeaderTable">
    34. 

  34. <tr>
    35. 

  35. <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.as3commons.collections.utils</a></td>
    36. 

  36. </tr>
    37. 

  37. <tr>
    38. 

  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Lists</td>
    39. 

  39. </tr>
    40. 

  40. </table>
    41. 

  41. <p></p>
    42. 

  42.   <code>IList</code> utilities.
    43. 

  43.   
    44. 

  44.   <p id="link_ListsAddFromExample"><strong><code>Lists.addFrom...()</code> example</strong></p>
    45. 

  45.   
    46. 

  46.   <a class="exampleCollapsed" href="#link_ListsAddFromExample" onClick="toggleExample(this, 'ListsAddFromExample');">Show example</a><br /><div id="ListsAddFromExample" style='display:none'><div class='listing'><pre>package {
    47. 

  47.     import org.as3commons.collections.ArrayList;
    48. 

  48.     import org.as3commons.collections.LinkedList;
    49. 

  49.     import org.as3commons.collections.Map;
    50. 

  50.     import org.as3commons.collections.utils.Lists;
    51. 

  51.     import flash.display.Sprite;
    52. 

  52. 

  53.     public class ListsAddFromExample extends Sprite {
    54. 

  54. 

  55.         public function ListsAddFromExample() {
    56. 

  56.             // list to populate
    57. 

  57.             var list : ArrayList = new ArrayList();
    58. 

  58. 

  59.             // from array (ordered)
    60. 

  60.             var a : Array = [1, "2", "2"];
    61. 

  61.             Lists.addFromArray(list, a);
    62. 

  62. 

  63.             // from linked list (ordered)
    64. 

  64.             var l : LinkedList = new LinkedList();
    65. 

  65.             l.add("2");
    66. 

  66.             l.add(3);
    67. 

  67.             l.add("4");
    68. 

  68.             l.add(3);
    69. 

  69.             Lists.addFromCollection(list, l);
    70. 

  70. 

  71.             // from map (no order)
    72. 

  72.             var m : Map = new Map();
    73. 

  73.             m.add("five", 5);
    74. 

  74.             m.add("six", "6");
    75. 

  75.             m.add("four", "4");
    76. 

  76.             Lists.addFromCollection(list, m);
    77. 

  77. 

  78.             // from args (ordered)
    79. 

  79.             Lists.addFromArgs(list,
    80. 

  80.                 7, "8", "8", 5
    81. 

  81.             );
    82. 

  82. 

  83.             // test
    84. 

  84.             trace (list.toArray().join("n"));
    85. 

  85.             
    86. 

  86.             //    1            // from array
    87. 

  87.             //    2
    88. 

  88.             //    2
    89. 

  89.             //    2            // from linked list
    90. 

  90.             //    3
    91. 

  91.             //    4
    92. 

  92.             //    3
    93. 

  93.             //    4            // from map
    94. 

  94.             //    6
    95. 

  95.             //    5
    96. 

  96.             //    7            // from args
    97. 

  97.             //    8
    98. 

  98.             //    8
    99. 

  99.             //    5
    100. 

  100.         }
    101. 

  101. 

  102.     }
    103. 

  103. }
    104. 

  104. </pre></div></div>
    105. 

  105.   
    106. 

  106.   <p id="link_ListsCloneExample"><strong><code>Lists.clone()</code> example</strong></p>
    107. 

  107.   
    108. 

  108.   <a class="exampleCollapsed" href="#link_ListsCloneExample" onClick="toggleExample(this, 'ListsCloneExample');">Show example</a><br /><div id="ListsCloneExample" style='display:none'><div class='listing'><pre>package {
    109. 

  109.     import org.as3commons.collections.utils.NumericComparator;
    110. 

  110.     import flash.utils.getQualifiedClassName;
    111. 

  111.     import org.as3commons.collections.framework.IList;
    112. 

  112.     import org.as3commons.collections.utils.Lists;
    113. 

  113.     import flash.display.Sprite;
    114. 

  114. 

  115.     public class ListsCloneExample extends Sprite {
    116. 

  116. 

  117.         public function ListsCloneExample() {
    118. 

  118.             // clone array list
    119. 

  119.             var list : IList = Lists.newArrayList(2, 4, 1, 3);
    120. 

  120.             var clone : IList = Lists.clone(list);
    121. 

  121.             trace (list.toArray().join("n"));
    122. 

  122.             trace (getQualifiedClassName(clone));
    123. 

  123.             //    2
    124. 

  124.             //    4
    125. 

  125.             //    1
    126. 

  126.             //    3
    127. 

  127.             //    org.as3commons.collections::ArrayList
    128. 

  128. 

  129.             // clone sorted list
    130. 

  130.             list = Lists.newSortedList(
    131. 

  131.                 new NumericComparator(),
    132. 

  132.                 2, 4, 1, 3
    133. 

  133.             );
    134. 

  134.             clone = Lists.clone(list);
    135. 

  135.             trace (list.toArray().join("n"));
    136. 

  136.             trace (getQualifiedClassName(clone));
    137. 

  137.             //    1
    138. 

  138.             //    2
    139. 

  139.             //    3
    140. 

  140.             //    4
    141. 

  141.             //    org.as3commons.collections::SortedList
    142. 

  142.         }
    143. 

  143.         
    144. 

  144.     }
    145. 

  145. }
    146. 

  146. </pre></div></div>
    147. 

  147.   
    148. 

  148.   <p id="link_ListsCopyExample"><strong><code>Lists.copy()</code> example</strong></p>
    149. 

  149.   
    150. 

  150.   <a class="exampleCollapsed" href="#link_ListsCopyExample" onClick="toggleExample(this, 'ListsCopyExample');">Show example</a><br /><div id="ListsCopyExample" style='display:none'><div class='listing'><pre>package {
    151. 

  151.     import org.as3commons.collections.framework.IList;
    152. 

  152.     import org.as3commons.collections.utils.Lists;
    153. 

  153.     import org.as3commons.collections.utils.NumericComparator;
    154. 

  154.     import flash.display.Sprite;
    155. 

  155. 

  156.     public class ListsCopyExample extends Sprite {
    157. 

  157.         public function ListsCopyExample() {
    158. 

  158.             // source
    159. 

  159.             var source : IList = Lists.newArrayList(1, 2, 3, 4);
    160. 

  160.             trace (source.toArray() + "n");
    161. 

  161.             //    1, 2, 3, 4
    162. 

  162.             
    163. 

  163.             // copy all
    164. 

  164.             var list : IList = Lists.newSortedList(
    165. 

  165.                 new NumericComparator(),
    166. 

  166.                 5, 6, 7, 8
    167. 

  167.             );
    168. 

  168.             trace (list.toArray() + "n");
    169. 

  169.             //    5, 6, 7, 8
    170. 

  170.             Lists.copy(source, list);
    171. 

  171.             trace (list.toArray() + "n");
    172. 

  172.             //    1, 2, 3, 4, 5, 6, 7, 8
    173. 

  173. 

  174.             // copy only even items
    175. 

  175.             list = Lists.newSortedList(
    176. 

  176.                 new NumericComparator(),
    177. 

  177.                 6, 8
    178. 

  178.             );
    179. 

  179.             trace (list.toArray() + "n");
    180. 

  180.             //    6, 8
    181. 

  181.             Lists.copy(source, list, evenFilter);
    182. 

  182.             trace (list.toArray() + "n");
    183. 

  183.             //    2, 4, 6, 8
    184. 

  184.         }
    185. 

  185.         
    186. 

  186.         private function evenFilter(item :  : Boolean {
    187. 

  187.             return item % 2 == 0;
    188. 

  188.         }
    189. 

  189. 

  190.     }
    191. 

  191. }
    192. 

  192. </pre></div></div>
    193. 

  193.   
    194. 

  194.   <p id="link_AddFromArgsExample"><strong><code>Lists.new...()</code> example</strong></p>
    195. 

  195.   
    196. 

  196.   <a class="exampleCollapsed" href="#link_AddFromArgsExample" onClick="toggleExample(this, 'AddFromArgsExample');">Show example</a><br /><div id="AddFromArgsExample" style='display:none'><div class='listing'><pre>package {
    197. 

  197.     import org.as3commons.collections.framework.
    198. 

  198.     import org.as3commons.collections.utils.
    199. 

  199.     import flash.display.Sprite;
    200. 

  200. 

  201.     public class AddFromArgsExample extends Sprite {
    202. 

  202. 

  203.         public function AddFromArgsExample() {
    204. 

  204.             // ArrayList
    205. 

  205.             var list : IList = Lists.newArrayList(
    206. 

  206.                 1, 2, 3, 4, 5, 6, 7, 8
    207. 

  207.             );
    208. 

  208.             trace (list.toArray() + "n");
    209. 

  209.             // 1, 2, 3, 4, 5, 6, 7, 8
    210. 

  210.             
    211. 

  211.             // ArrayList
    212. 

  212.             list = Lists.newSortedList(
    213. 

  213.                 new NumericComparator(),
    214. 

  214.                 6, 3, 1, 5, 8, 2, 7, 4
    215. 

  215.             );
    216. 

  216.             trace (list.toArray() + "n");
    217. 

  217.             // 1, 2, 3, 4, 5, 6, 7, 8
    218. 

  218.             
    219. 

  219.             // Set
    220. 

  220.             var theSet : ISet = Sets.newSet(
    221. 

  221.                 1, 2, 3, 4, 5, 6, 7, 8
    222. 

  222.             );
    223. 

  223.             trace (theSet.toArray() + "n");
    224. 

  224.             // 1, 2, 3, 4, 5, 6, 7, 8
    225. 

  225.             
    226. 

  226.             // LinkedSet
    227. 

  227.             theSet = Sets.newLinkedSet(
    228. 

  228.                 1, 2, 3, 4, 5, 6, 7, 8
    229. 

  229.             );
    230. 

  230.             trace (theSet.toArray() + "n");
    231. 

  231.             // 1, 2, 3, 4, 5, 6, 7, 8
    232. 

  232.             
    233. 

  233.             // SortedSet
    234. 

  234.             theSet = Sets.newSortedSet(
    235. 

  235.                 new NumericComparator(),
    236. 

  236.                 6, 3, 1, 5, 8, 2, 7, 4
    237. 

  237.             );
    238. 

  238.             trace (theSet.toArray() + "n");
    239. 

  239.             // 1, 2, 3, 4, 5, 6, 7, 8
    240. 

  240.             
    241. 

  241.             // Map
    242. 

  242.             var map : IMap = Maps.newMap(
    243. 

  243.                 "one", 1, "two", 2, "three", 3, "four", 4
    244. 

  244.             );
    245. 

  245.             trace (map.toArray() + "n");
    246. 

  246.             // 1, 4, 2, 3
    247. 

  247.             
    248. 

  248.             // LinkedMap
    249. 

  249.             map = Maps.newLinkedMap(
    250. 

  250.                 "one", 1, "two", 2, "three", 3, "four", 4
    251. 

  251.             );
    252. 

  252.             trace (map.toArray() + "n");
    253. 

  253.             // 1, 2, 3, 4
    254. 

  254.             
    255. 

  255.             // SortedMap
    256. 

  256.             map = Maps.newSortedMap(
    257. 

  257.                 new NumericComparator(),
    258. 

  258.                 "one", 1, "two", 2, "three", 3, "four", 4
    259. 

  259.             );
    260. 

  260.             trace (map.toArray() + "n");
    261. 

  261.             // 1, 2, 3, 4
    262. 

  262.             
    263. 

  263.             // LinkedList
    264. 

  264.             var linkedList : ILinkedList = LinkedLists.newLinkedList(
    265. 

  265.                 1, 2, 3, 4, 5, 6, 7, 8
    266. 

  266.             );
    267. 

  267.             trace (linkedList.toArray() + "n");
    268. 

  268.             // 1, 2, 3, 4, 5, 6, 7, 8
    269. 

  269.         }
    270. 

  270. 

  271.     }
    272. 

  272. }
    273. 

  273. </pre></div></div>
    274. 

  274.   
    275. 

  275.   <p id="link_NestedCollectionsExample"><strong>Nested collections example</strong></p>
    276. 

  276.   
    277. 

  277.   <a class="exampleCollapsed" href="#link_NestedCollectionsExample" onClick="toggleExample(this, 'NestedCollectionsExample');">Show example</a><br /><div id="NestedCollectionsExample" style='display:none'><div class='listing'><pre>package {
    278. 

  278.     import org.as3commons.collections.ArrayList;
    279. 

  279.     import org.as3commons.collections.LinkedSet;
    280. 

  280.     import org.as3commons.collections.framework.IComparator;
    281. 

  281.     import org.as3commons.collections.utils.
    282. 

  282.     import flash.display.Sprite;
    283. 

  283. 

  284.     public class NestedCollectionsExample extends Sprite {
    285. 

  285. 

  286.         public function NestedCollectionsExample() {
    287. 

  287.             // nested array list
    288. 

  288.             var list : ArrayList = Lists.newArrayList(
    289. 

  289.                 Lists.newArrayList(1, 2),
    290. 

  290.                 Lists.newArrayList(
    291. 

  291.                     Lists.newArrayList(3, 4),
    292. 

  292.                     Lists.newArrayList(5, 6)
    293. 

  293.                 ),
    294. 

  294.                 Lists.newArrayList(7, 8),
    295. 

  295.                 Lists.newArrayList(
    296. 

  296.                     Lists.newArrayList(9, 10),
    297. 

  297.                     Lists.newArrayList(11, 12)
    298. 

  298.                 )
    299. 

  299.             );
    300. 

  300.             trace (CollectionUtils.dumpAsString(list));
    301. 

  301.             //    [object ArrayList]
    302. 

  302.             //    .......[object ArrayList]
    303. 

  303.             //    ..............1
    304. 

  304.             //    ..............2
    305. 

  305.             //    .......[object ArrayList]
    306. 

  306.             //    ..............[object ArrayList]
    307. 

  307.             //    .....................3
    308. 

  308.             //    .....................4
    309. 

  309.             //    ..............[object ArrayList]
    310. 

  310.             //    .....................5
    311. 

  311.             //    .....................6
    312. 

  312.             //    .......[object ArrayList]
    313. 

  313.             //    ..............7
    314. 

  314.             //    ..............8
    315. 

  315.             //    .......[object ArrayList]
    316. 

  316.             //    ..............[object ArrayList]
    317. 

  317.             //    .....................9
    318. 

  318.             //    .....................10
    319. 

  319.             //    ..............[object ArrayList]
    320. 

  320.             //    .....................11
    321. 

  321.             //    .....................12            
    322. 

  322.             
    323. 

  323.             // nested mixed collection
    324. 

  324.             var c : IComparator = new NumericComparator();
    325. 

  325.             var theSet : LinkedSet = Sets.newLinkedSet(
    326. 

  326.                 Maps.newLinkedMap("one", 1, "two", 2),
    327. 

  327.                 Lists.newArrayList(
    328. 

  328.                     Sets.newSortedSet(c, 4, 3),
    329. 

  329.                     LinkedLists.newLinkedList(5, 6)
    330. 

  330.                 ),
    331. 

  331.                 Lists.newSortedList(c, 8, 7),
    332. 

  332.                 Lists.newArrayList(
    333. 

  333.                     Maps.newLinkedMap("nine", 9, "ten", 10),
    334. 

  334.                     Maps.newSortedMap(c, "twelve", 12, "eleven", 11)
    335. 

  335.                 )
    336. 

  336.             );
    337. 

  337.             trace (CollectionUtils.dumpAsString(theSet));
    338. 

  338.             //    [object LinkedSet]
    339. 

  339.             //    .......[object LinkedMap]
    340. 

  340.             //    ..............1
    341. 

  341.             //    ..............2
    342. 

  342.             //    .......[object ArrayList]
    343. 

  343.             //    ..............[object SortedSet]
    344. 

  344.             //    .....................3
    345. 

  345.             //    .....................4
    346. 

  346.             //    ..............[object LinkedList]
    347. 

  347.             //    .....................5
    348. 

  348.             //    .....................6
    349. 

  349.             //    .......[object SortedList]
    350. 

  350.             //    ..............7
    351. 

  351.             //    ..............8
    352. 

  352.             //    .......[object ArrayList]
    353. 

  353.             //    ..............[object LinkedMap]
    354. 

  354.             //    .....................9
    355. 

  355.             //    .....................10
    356. 

  356.             //    ..............[object SortedMap]
    357. 

  357.             //    .....................11
    358. 

  358.             //    .....................12            
    359. 

  359.         }
    360. 

  360.     }
    361. 

  361. }
    362. 

  362. </pre></div></div>
    363. 

  363.   
    364. 

  364.   <p></p>
    365. 

  365. <br>
    366. 

  366. <hr>
    367. 

  367. </div>
    368. 

  368. <a name="methodSummary"></a>
    369. 

  369. <div class="summarySection">
    370. 

  370. <div class="summaryTableTitle">Public Methods</div>
    371. 

  371. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
    372. 

  372. <tr>
    373. 

  373. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    374. 

  374. </tr>
    375. 

  375. <tr class="">
    376. 

  376. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    377. 

  377. <div class="summarySignature">
    378. 

  378. <a class="signatureLink" href="#addFromArgs()">addFromArgs</a>(list:<a href="../framework/IList.html">IList</a>, ... args):uint</div>
    379. 

  379. <div class="summaryTableDescription">[static]
    380. 

  380.    Adds the given list of items to the specified list.</div>
    381. 

  381. </td><td class="summaryTableOwnerCol">Lists</td>
    382. 

  382. </tr>
    383. 

  383. <tr class="">
    384. 

  384. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    385. 

  385. <div class="summarySignature">
    386. 

  386. <a class="signatureLink" href="#addFromArray()">addFromArray</a>(list:<a href="../framework/IList.html">IList</a>, source:Array):uint</div>
    387. 

  387. <div class="summaryTableDescription">[static]
    388. 

  388.    Adds the contents of the given <code>Array</code> to the specified list.</div>
    389. 

  389. </td><td class="summaryTableOwnerCol">Lists</td>
    390. 

  390. </tr>
    391. 

  391. <tr class="">
    392. 

  392. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    393. 

  393. <div class="summarySignature">
    394. 

  394. <a class="signatureLink" href="#addFromCollection()">addFromCollection</a>(list:<a href="../framework/IList.html">IList</a>, source:<a href="../framework/ICollection.html">ICollection</a>):uint</div>
    395. 

  395. <div class="summaryTableDescription">[static]
    396. 

  396.    Adds the contents of the given <code>ICollection</code> to the specified list.</div>
    397. 

  397. </td><td class="summaryTableOwnerCol">Lists</td>
    398. 

  398. </tr>
    399. 

  399. <tr class="">
    400. 

  400. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    401. 

  401. <div class="summarySignature">
    402. 

  402. <a class="signatureLink" href="#clone()">clone</a>(list:<a href="../framework/IList.html">IList</a>, filter:Function = null):<a href="../framework/IList.html">IList</a>
    403. 

  403. </div>
    404. 

  404. <div class="summaryTableDescription">[static]
    405. 

  405.    Clones the supplied <code>IList</code> instance returning a new <code>IList</code>
    406. 

  406.    of the same type.</div>
    407. 

  407. </td><td class="summaryTableOwnerCol">Lists</td>
    408. 

  408. </tr>
    409. 

  409. <tr class="">
    410. 

  410. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    411. 

  411. <div class="summarySignature">
    412. 

  412. <a class="signatureLink" href="#copy()">copy</a>(source:<a href="../framework/IList.html">IList</a>, destination:<a href="../framework/IList.html">IList</a>, filter:Function = null):uint</div>
    413. 

  413. <div class="summaryTableDescription">[static]
    414. 

  414.    Copies items from one list to another.</div>
    415. 

  415. </td><td class="summaryTableOwnerCol">Lists</td>
    416. 

  416. </tr>
    417. 

  417. <tr class="">
    418. 

  418. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    419. 

  419. <div class="summarySignature">
    420. 

  420. <a class="signatureLink" href="#newArrayList()">newArrayList</a>(... args):<a href="../../collections/ArrayList.html">ArrayList</a>
    421. 

  421. </div>
    422. 

  422. <div class="summaryTableDescription">[static]
    423. 

  423.    Creates, populates and returns a new <code>ArrayList</code> instance.</div>
    424. 

  424. </td><td class="summaryTableOwnerCol">Lists</td>
    425. 

  425. </tr>
    426. 

  426. <tr class="">
    427. 

  427. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    428. 

  428. <div class="summarySignature">
    429. 

  429. <a class="signatureLink" href="#newSortedList()">newSortedList</a>(comparator:<a href="../framework/IComparator.html">IComparator</a>, ... args):<a href="../../collections/SortedList.html">SortedList</a>
    430. 

  430. </div>
    431. 

  431. <div class="summaryTableDescription">[static]
    432. 

  432.    Creates, populates and returns a new <code>ArrayList</code> instance.</div>
    433. 

  433. </td><td class="summaryTableOwnerCol">Lists</td>
    434. 

  434. </tr>
    435. 

  435. </table>
    436. 

  436. </div>
    437. 

  437. <script type="text/javascript" language="javascript">
    438. 

  438. <!--
    439. 

  439. showHideInherited();
    440. 

  440. --></script>
    441. 

  441. <div class="MainContent">
    442. 

  442. <a name="methodDetail"></a>
    443. 

  443. <div class="detailSectionHeader">Method detail</div>
    444. 

  444. <a name="addFromArgs()"></a>
    445. 

  445. <table cellspacing="0" cellpadding="0" class="detailHeader">
    446. 

  446. <tr>
    447. 

  447. <td class="detailHeaderName">addFromArgs</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
    448. 

  448. </tr>
    449. 

  449. </table>
    450. 

  450. <div class="detailBody">
    451. 

  451. <code>public static function addFromArgs(list:<a href="../framework/IList.html">IList</a>, ... args):uint</code><p>
    452. 

  452.    Adds the given list of items to the specified list.
    453. 

  453.    
    454. 

  454.    <div class='listing'><pre>
    455. 

  455.     Lists.addFromArgs(myList, item1, item2, ...);
    456. 

  456.    </pre></div>
    457. 

  457.    
    458. 

  458.    </p><span class="label">Parameters</span>
    459. 

  459. <table border="0" cellspacing="0" cellpadding="0">
    460. 

  460. <tr>
    461. 

  461. <td width="20px"></td><td><code><span class="label">list</span>:<a href="../framework/IList.html">IList</a></code> &mdash; The list to populate.
    462. 

  462.    </td>
    463. 

  463. </tr>
    464. 

  464. <tr>
    465. 

  465. <td class="paramSpacer">&nbsp;</td>
    466. 

  466. </tr>
    467. 

  467. <tr>
    468. 

  468. <td width="20px"></td><td><code>... <span class="label">args</span></code> &mdash; List of items to add to the list.
    469. 

  469.    </td>
    470. 

  470. </tr>
    471. 

  471. </table>
    472. 

  472. <p></p>
    473. 

  473. <span class="label">Returns</span>
    474. 

  474. <table border="0" cellspacing="0" cellpadding="0">
    475. 

  475. <tr>
    476. 

  476. <td width="20"></td><td><code>uint</code> &mdash; The number of items added to the list.
    477. 

  477.    </td>
    478. 

  478. </tr>
    479. 

  479. </table>
    480. 

  480. </div>
    481. 

  481. <a name="addFromArray()"></a>
    482. 

  482. <table cellspacing="0" cellpadding="0" class="detailHeader">
    483. 

  483. <tr>
    484. 

  484. <td class="detailHeaderName">addFromArray</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    485. 

  485. </tr>
    486. 

  486. </table>
    487. 

  487. <div class="detailBody">
    488. 

  488. <code>public static function addFromArray(list:<a href="../framework/IList.html">IList</a>, source:Array):uint</code><p>
    489. 

  489.    Adds the contents of the given <code>Array</code> to the specified list.
    490. 

  490.    
    491. 

  491.    <div class='listing'><pre>
    492. 

  492.     var array : Array = [item1, item2, ...];
    493. 

  493.     var count : uint = Lists.addFromArray(list, array);
    494. 

  494.    </pre></div>
    495. 

  495.    
    496. 

  496.    </p><span class="label">Parameters</span>
    497. 

  497. <table border="0" cellspacing="0" cellpadding="0">
    498. 

  498. <tr>
    499. 

  499. <td width="20px"></td><td><code><span class="label">list</span>:<a href="../framework/IList.html">IList</a></code> &mdash; The list to populate.
    500. 

  500.    </td>
    501. 

  501. </tr>
    502. 

  502. <tr>
    503. 

  503. <td class="paramSpacer">&nbsp;</td>
    504. 

  504. </tr>
    505. 

  505. <tr>
    506. 

  506. <td width="20px"></td><td><code><span class="label">source</span>:Array</code> &mdash; The <code>Array</code> to add from.
    507. 

  507.    </td>
    508. 

  508. </tr>
    509. 

  509. </table>
    510. 

  510. <p></p>
    511. 

  511. <span class="label">Returns</span>
    512. 

  512. <table border="0" cellspacing="0" cellpadding="0">
    513. 

  513. <tr>
    514. 

  514. <td width="20"></td><td><code>uint</code> &mdash; The number of items added to the list.
    515. 

  515.    </td>
    516. 

  516. </tr>
    517. 

  517. </table>
    518. 

  518. </div>
    519. 

  519. <a name="addFromCollection()"></a>
    520. 

  520. <table cellspacing="0" cellpadding="0" class="detailHeader">
    521. 

  521. <tr>
    522. 

  522. <td class="detailHeaderName">addFromCollection</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    523. 

  523. </tr>
    524. 

  524. </table>
    525. 

  525. <div class="detailBody">
    526. 

  526. <code>public static function addFromCollection(list:<a href="../framework/IList.html">IList</a>, source:<a href="../framework/ICollection.html">ICollection</a>):uint</code><p>
    527. 

  527.    Adds the contents of the given <code>ICollection</code> to the specified list.
    528. 

  528.    
    529. 

  529.    <div class='listing'><pre>
    530. 

  530.     var count : uint = Lists.addFromCollection(list, sourceCollection);
    531. 

  531.    </pre></div>
    532. 

  532.    
    533. 

  533.    </p><span class="label">Parameters</span>
    534. 

  534. <table border="0" cellspacing="0" cellpadding="0">
    535. 

  535. <tr>
    536. 

  536. <td width="20px"></td><td><code><span class="label">list</span>:<a href="../framework/IList.html">IList</a></code> &mdash; The list to populate.
    537. 

  537.    </td>
    538. 

  538. </tr>
    539. 

  539. <tr>
    540. 

  540. <td class="paramSpacer">&nbsp;</td>
    541. 

  541. </tr>
    542. 

  542. <tr>
    543. 

  543. <td width="20px"></td><td><code><span class="label">source</span>:<a href="../framework/ICollection.html">ICollection</a></code> &mdash; The <code>ICollection</code> to add from.
    544. 

  544.    </td>
    545. 

  545. </tr>
    546. 

  546. </table>
    547. 

  547. <p></p>
    548. 

  548. <span class="label">Returns</span>
    549. 

  549. <table border="0" cellspacing="0" cellpadding="0">
    550. 

  550. <tr>
    551. 

  551. <td width="20"></td><td><code>uint</code> &mdash; The number of items added to the list.
    552. 

  552.    </td>
    553. 

  553. </tr>
    554. 

  554. </table>
    555. 

  555. </div>
    556. 

  556. <a name="clone()"></a>
    557. 

  557. <table cellspacing="0" cellpadding="0" class="detailHeader">
    558. 

  558. <tr>
    559. 

  559. <td class="detailHeaderName">clone</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    560. 

  560. </tr>
    561. 

  561. </table>
    562. 

  562. <div class="detailBody">
    563. 

  563. <code>public static function clone(list:<a href="../framework/IList.html">IList</a>, filter:Function = null):<a href="../framework/IList.html">IList</a></code><p>
    564. 

  564.    Clones the supplied <code>IList</code> instance returning a new <code>IList</code>
    565. 

  565.    of the same type.
    566. 

  566.    
    567. 

  567.    </p><p>If a filter is specified the resulting list only contains items that
    568. 

  568.    meet the supplied predicates.<p>
    569. 

  569.    
    570. 

  570.    <p>The filter function accepts the current item and returns a boolean
    571. 

  571.    value (<code>true</code> if the item is accepted).</p>
    572. 

  572.    
    573. 

  573.    <div class='listing'><pre>
    574. 

  574.    function itemFilter(item :  : Boolean {
    575. 

  575.     var accept : Boolean = false;
    576. 

  576.     // test the item
    577. 

  577.     return accept;
    578. 

  578.    }
    579. 

  579.      
    580. 

  580.    var list : IList = Lists.clone(list, filter);
    581. 

  581.    </pre></div>
    582. 

  582.    
    583. 

  583.    <span class="label">Parameters</span>
    584. 

  584. <table border="0" cellspacing="0" cellpadding="0">
    585. 

  585. <tr>
    586. 

  586. <td width="20px"></td><td><code><span class="label">list</span>:<a href="../framework/IList.html">IList</a></code> &mdash; The <code>IList</code> instance to clone.
    587. 

  587.    </td>
    588. 

  588. </tr>
    589. 

  589. <tr>
    590. 

  590. <td class="paramSpacer">&nbsp;</td>
    591. 

  591. </tr>
    592. 

  592. <tr>
    593. 

  593. <td width="20px"></td><td><code><span class="label">filter</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; Function which will be applied to each item in the source list.
    594. 

  594.    </td>
    595. 

  595. </tr>
    596. 

  596. </table>
    597. 

  597. <p></p>
    598. 

  598. <span class="label">Returns</span>
    599. 

  599. <table border="0" cellspacing="0" cellpadding="0">
    600. 

  600. <tr>
    601. 

  601. <td width="20"></td><td><code><a href="../framework/IList.html">IList</a></code> &mdash; 
    602. 

  602.                         A new <code>IList</code> instance.
    603. 

  603.    
    604. 

  604.                         
    605. 

  605.                      </td>
    606. 

  606. </tr>
    607. 

  607. </table>
    608. 

  608. </div>
    609. 

  609. <a name="copy()"></a>
    610. 

  610. <table cellspacing="0" cellpadding="0" class="detailHeader">
    611. 

  611. <tr>
    612. 

  612. <td class="detailHeaderName">copy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    613. 

  613. </tr>
    614. 

  614. </table>
    615. 

  615. <div class="detailBody">
    616. 

  616. <code>public static function copy(source:<a href="../framework/IList.html">IList</a>, destination:<a href="../framework/IList.html">IList</a>, filter:Function = null):uint</code><p>
    617. 

  617.    Copies items from one list to another.
    618. 

  618.    
    619. 

  619.    </p><p>If a filter is specified only items are copied that meet the
    620. 

  620.    supplied predicates.<p>
    621. 

  621.    
    622. 

  622.    <p>The filter function accepts the current item and returns a boolean
    623. 

  623.    value (<code>true</code> if the item is accepted).</p>
    624. 

  624.    
    625. 

  625.    <div class='listing'><pre>
    626. 

  626.    function itemFilter(item :  : Boolean {
    627. 

  627.     var accept : Boolean = false;
    628. 

  628.     // test the item
    629. 

  629.     return accept;
    630. 

  630.    }
    631. 

  631.      
    632. 

  632.    Lists.copy(sourceList, destinationList, filter);
    633. 

  633.    </pre></div>
    634. 

  634.    
    635. 

  635.    <span class="label">Parameters</span>
    636. 

  636. <table border="0" cellspacing="0" cellpadding="0">
    637. 

  637. <tr>
    638. 

  638. <td width="20px"></td><td><code><span class="label">source</span>:<a href="../framework/IList.html">IList</a></code> &mdash; The <code>IList</code> instance to copy from.
    639. 

  639.    </td>
    640. 

  640. </tr>
    641. 

  641. <tr>
    642. 

  642. <td class="paramSpacer">&nbsp;</td>
    643. 

  643. </tr>
    644. 

  644. <tr>
    645. 

  645. <td width="20px"></td><td><code><span class="label">destination</span>:<a href="../framework/IList.html">IList</a></code> &mdash; The <code>IList</code> to copy to.
    646. 

  646.    </td>
    647. 

  647. </tr>
    648. 

  648. <tr>
    649. 

  649. <td class="paramSpacer">&nbsp;</td>
    650. 

  650. </tr>
    651. 

  651. <tr>
    652. 

  652. <td width="20px"></td><td><code><span class="label">filter</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; Function which will be applied to each item in the source list.
    653. 

  653.    </td>
    654. 

  654. </tr>
    655. 

  655. </table>
    656. 

  656. <p></p>
    657. 

  657. <span class="label">Returns</span>
    658. 

  658. <table border="0" cellspacing="0" cellpadding="0">
    659. 

  659. <tr>
    660. 

  660. <td width="20"></td><td><code>uint</code> &mdash; The number of items copied to the list.
    661. 

  661.    </td>
    662. 

  662. </tr>
    663. 

  663. </table>
    664. 

  664. </div>
    665. 

  665. <a name="newArrayList()"></a>
    666. 

  666. <table cellspacing="0" cellpadding="0" class="detailHeader">
    667. 

  667. <tr>
    668. 

  668. <td class="detailHeaderName">newArrayList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    669. 

  669. </tr>
    670. 

  670. </table>
    671. 

  671. <div class="detailBody">
    672. 

  672. <code>public static function newArrayList(... args):<a href="../../collections/ArrayList.html">ArrayList</a></code><p>
    673. 

  673.    Creates, populates and returns a new <code>ArrayList</code> instance.
    674. 

  674.    
    675. 

  675.    </p><p>The arguments may be left out. In that case no item is added to the list.</p>
    676. 

  676.    
    677. 

  677.    <div class='listing'><pre>
    678. 

  678.     var list : ArrayList = Lists.newArrayList(item1, item2, ...);
    679. 

  679.    </pre></div>
    680. 

  680.    
    681. 

  681.    <span class="label">Parameters</span>
    682. 

  682. <table border="0" cellspacing="0" cellpadding="0">
    683. 

  683. <tr>
    684. 

  684. <td width="20px"></td><td><code>... <span class="label">args</span></code> &mdash; List of items to add to the list.
    685. 

  685.    </td>
    686. 

  686. </tr>
    687. 

  687. </table>
    688. 

  688. <p></p>
    689. 

  689. <span class="label">Returns</span>
    690. 

  690. <table border="0" cellspacing="0" cellpadding="0">
    691. 

  691. <tr>
    692. 

  692. <td width="20"></td><td><code><a href="../../collections/ArrayList.html">ArrayList</a></code> &mdash; 
    693. 

  693.                         A new <code>ArrayList</code> instance populated from the given arguments.
    694. 

  694.    
    695. 

  695.                         
    696. 

  696.                      </td>
    697. 

  697. </tr>
    698. 

  698. </table>
    699. 

  699. </div>
    700. 

  700. <a name="newSortedList()"></a>
    701. 

  701. <table cellspacing="0" cellpadding="0" class="detailHeader">
    702. 

  702. <tr>
    703. 

  703. <td class="detailHeaderName">newSortedList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    704. 

  704. </tr>
    705. 

  705. </table>
    706. 

  706. <div class="detailBody">
    707. 

  707. <code>public static function newSortedList(comparator:<a href="../framework/IComparator.html">IComparator</a>, ... args):<a href="../../collections/SortedList.html">SortedList</a></code><p>
    708. 

  708.    Creates, populates and returns a new <code>ArrayList</code> instance.
    709. 

  709.    
    710. 

  710.    </p><p>The arguments may be left out. In that case no item is added to the list.</p>
    711. 

  711.    
    712. 

  712.    <div class='listing'><pre>
    713. 

  713.     var list : ArrayList = Lists.newSortedList(comparator, item1, item2, ...);
    714. 

  714.    </pre></div>
    715. 

  715.    
    716. 

  716.    <span class="label">Parameters</span>
    717. 

  717. <table border="0" cellspacing="0" cellpadding="0">
    718. 

  718. <tr>
    719. 

  719. <td width="20px"></td><td><code><span class="label">comparator</span>:<a href="../framework/IComparator.html">IComparator</a></code> &mdash; List of items to add to the list.
    720. 

  720.    </td>
    721. 

  721. </tr>
    722. 

  722. <tr>
    723. 

  723. <td class="paramSpacer">&nbsp;</td>
    724. 

  724. </tr>
    725. 

  725. <tr>
    726. 

  726. <td width="20px"></td><td><code>... <span class="label">args</span></code> &mdash; The sort criterion.
    727. 

  727.    </td>
    728. 

  728. </tr>
    729. 

  729. </table>
    730. 

  730. <p></p>
    731. 

  731. <span class="label">Returns</span>
    732. 

  732. <table border="0" cellspacing="0" cellpadding="0">
    733. 

  733. <tr>
    734. 

  734. <td width="20"></td><td><code><a href="../../collections/SortedList.html">SortedList</a></code> &mdash; 
    735. 

  735.                         A new <code>SortedList</code> instance populated from the given arguments.
    736. 

  736.    
    737. 

  737.                         
    738. 

  738.                      </td>
    739. 

  739. </tr>
    740. 

  740. </table>
    741. 

  741. </div>
    742. 

  742. <br>
    743. 

  743. <br>
    744. 

  744. <hr>
    745. 

  745. <br>
    746. 

  746. <p></p>
    747. 

  747. <center class="copyright"> 
    748. 

  748. </center>
    749. 

  749. </div>
    750. 

  750. </body>
    751. 

  751. </html>
    752. 

  752. <!-- -->
    753. 

  753.