ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.utils 

ArrayUtil  - AS3 Flex

Packagemx.utils
Classpublic class ArrayUtil
InheritanceArrayUtil Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The ArrayUtil utility class is an all-static class with methods for working with arrays within Flex. You do not create instances of ArrayUtil; instead you call static methods such as the ArrayUtil.toArray() method.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
[static] Returns the index of the item in the Array.
ArrayUtil
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
[static] Ensures that an Object can be used as an Array.
ArrayUtil
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Method Detail

getItemIndex

()method
public static function getItemIndex(item:Object, source:Array):int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the index of the item in the Array.

Parameters

item:Object — The item to find in the Array.
 
source:Array — The Array to search for the item.

Returns
int — The index of the item, and -1 if the item is not in the list.

toArray

()method 
public static function toArray(obj:Object):Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Ensures that an Object can be used as an Array.

If the Object is already an Array, it returns the object. If the object is not an Array, it returns an Array in which the only element is the Object. As a special case, if the Object is null, it returns an empty Array.

Parameters

obj:Object — Object that you want to ensure is an array.

Returns
Array — An Array. If the original Object is already an Array, the original Array is returned. Otherwise, a new Array whose only element is the Object is returned or an empty Array if the Object was null.