Packagech.capi.data
Interfacepublic interface IList
Implementors ArrayList

Represents a list of data.



Public Properties
 PropertyDefined By
  length : int
[read-only] Defines the number of elements contained in the IList.
IList
Public Methods
 MethodDefined By
  
addElement(element:*):void
Add an element in the IList.
IList
  
addElementAt(element:*, index:int):void
Add an element in the IList at the specified index.
IList
  
clear():void
Removes all the elements contained in this IList.
IList
  
contains(element:*, compare:Function = null):Boolean
Returns true if the specified element is contained in the IList or false otherwise.
IList
  
getElementAt(index:int):*
Get the element at the specified index.
IList
  
getElementIndex(element:*):int
Get the index of the specified element.
IList
  
removeElement(element:*):void
Removes an element from the IList.
IList
  
removeElementAt(index:int):*
Removes the element at the specified index from the IList.
IList
  
toArray():Array
Retrieves an Array from the IList.
IList
Property Detail
lengthproperty
length:int  [read-only]

Defines the number of elements contained in the IList.


Implementation
    public function get length():int
Method Detail
addElement()method
public function addElement(element:*):void

Add an element in the IList.

Parameters

element:* — The element to add.

addElementAt()method 
public function addElementAt(element:*, index:int):void

Add an element in the IList at the specified index.

Parameters

element:* — The element to add.
 
index:int — The index of the element.

clear()method 
public function clear():void

Removes all the elements contained in this IList.

contains()method 
public function contains(element:*, compare:Function = null):Boolean

Returns true if the specified element is contained in the IList or false otherwise.

The comparison function must take two arguments that are issued from the IList and must return a Boolean indicating whetever the two elements are the same or not.

Parameters

element:* — The element to find.
 
compare:Function (default = null) — The comparison function. If null, then the strict equality operator (===) will be used.

Returns
Booleantrue if the element is in the IList.

See also


Example
         var cmp:Function = function(a:Object, b:Object):Boolean
         {
                 return a.aProperty == b.aProperty;
         }
         var isContained:Boolean = myList.contains(myObject, cmp);
         
getElementAt()method 
public function getElementAt(index:int):*

Get the element at the specified index.

Parameters

index:int — The index of the element to get.

Returns
* — The element at the specified index.
getElementIndex()method 
public function getElementIndex(element:*):int

Get the index of the specified element.

Parameters

element:* — The element to find.

Returns
int — The index of the element or -1 if the element is not found.
removeElement()method 
public function removeElement(element:*):void

Removes an element from the IList.

Parameters

element:* — The element to remove.

removeElementAt()method 
public function removeElementAt(index:int):*

Removes the element at the specified index from the IList.

Parameters

index:int — The index of the element to remove.

Returns
* — The removed element.
toArray()method 
public function toArray():Array

Retrieves an Array from the IList.

Returns
Array — An Array containing the objects.