• Home
• net.jangaroo
• jangaroo-runtime
• 2.0.19
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

jangaroo-runtime.2.0.19.source-code.Vector$object.as Maven / Gradle / Ivy

package {


/**
 * The Vector class lets you access and manipulate a vector - an array whose elements all have the same data type. The data type of a Vector's elements is known as the Vector's base type. The base type can be any class, including built in classes and custom classes. The base type is specified when declaring a Vector variable as well as when creating an instance by calling the class constructor.
 * 
As with an Array, you can use the array access operator ([]) to set or retrieve the value of a Vector element. Several Vector methods also provide mechanisms for setting and retrieving element values. These include push(), pop(), shift(), unshift(), and others. The properties and methods of a Vector object are similar - in most cases identical - to the properties and methods of an Array. In most cases where you would use an Array in which all the elements have the same data type, a Vector instance is preferable. However, Vector instances are dense arrays, meaning it must have a value (or null) in each index. Array instances don't have this same restriction.
 * 
The Vector's base type is specified using postfix type parameter syntax. Type parameter syntax is a sequence consisting of a dot (.), left angle bracket (<), class name, then a right angle bracket (>), as shown in this example:
 * 
In the first line of the example, the variable v is declared as a Vector.<String> instance. In other words, it represents a Vector (an array) that can only hold String instances and from which only String instances can be retrieved. The second line constructs an instance of the same Vector type (that is, a Vector whose elements are all String objects) and assigns it to v.
 *  *  var v:Vector.<String>;
 *  v = new Vector.<String>();
 * 
 * 
A variable declared with the Vector.<T> data type can only store a Vector instance that is constructed with the same base type T. For example, a Vector that's constructed by calling new Vector.<String>() can't be assigned to a variable that's declared with the Vector. data type. The base types must match exactly. For example, the following code doesn't compile because the object's base type isn't the same as the variable's declared base type (even though Sprite is a subclass of DisplayObject):
 *  *  // This code doesn't compile even though Sprite is a DisplayObject subclass
 *  var v:Vector.<DisplayObject> = new Vector.<Sprite>();
 * 
 * 
To convert a Vector with base type T to a Vector of a superclass of T, use the Vector() global function.
 * 
In addition to the data type restriction, the Vector class has other restrictions that distinguish it from the Array class:
 * 

 * 
A Vector is a dense array. Unlike an Array, which may have values in indices 0 and 7 even if there are no values in positions 1 through 6, a Vector must have a value (or null) in each index.
 * 
A Vector can optionally be fixed-length, meaning the number of elements it contains can't change.
 * 
Access to a Vector's elements is bounds-checked. You can never read a value from an index greater than the final element (length - 1). You can never set a value with an index more than one beyond the current final index (in other words, you can only set a value at an existing index or at index [length]).
 * 
As a result of its restrictions, a Vector has three primary benefits over an Array instance whose elements are all instances of a single class:
 * 

 * 
Performance: array element access and iteration are much faster when using a Vector instance than they are when using an Array.
 * 
Type safety: in strict mode the compiler can identify data type errors. Examples of data type errors include assigning a value of the incorrect data type to a Vector or expecting the wrong data type when reading a value from a Vector. Note, however, that when using the push() method or unshift() method to add values to a Vector, the arguments' data types are not checked at compile time. Instead, they are checked at run time.
 * 
Reliability: runtime range checking (or fixed-length checking) increases reliability significantly over Arrays.
 * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/operators.html#array_access
 * @see Vector()
 * @see Array
 *
 */
[Native]
public final dynamic class Vector$object {

  /**
   * Indicates whether the length property of the Vector can be changed. If the value is true, the length property can't be changed. This means the following operations are not allowed when fixed is true:
   * 

   * 
setting the length property directly
   * 
assigning a value to index position length
   * 
calling a method that changes the length property, including:
   * 

   * 
pop()
   * 
push()
   * 
shift()
   * 
unshift()
   * 
splice() (if the splice() call changes the length of the Vector).
   */
  public native function get fixed():Boolean;

  /**
   * @private
   */
  public native function set fixed(value:Boolean):void;

  /**
   * The range of valid indices available in the Vector. A Vector instance has index positions up to but not including the length value.
   * 
Every Vector element always has a value that is either an instance of the base type or null. When the length property is set to a value that's larger than its previous value, additional elements are created and populated with the default value appropriate to the base type (null for reference types).
   * 
When the length property is set to a value that's smaller than its previous value, all the elements at index positions greater than or equal to the new length value are removed from the Vector.
   * @throws RangeError If this property is changed while fixed is true.
   * @throws RangeError If this property is set to a value larger than the maximum allowable index (232).
   *
   */
  public native function get length():uint;

  /**
   * @private
   */
  public native function set length(value:uint):void;

  /**
   * Creates a Vector with the specified base type.
   * 
When calling the Vector.<T>() constructor, specify the base type using type parameter syntax. Type parameter syntax is a sequence consisting of a dot (.), left angle bracket (<), class name, then a right angle bracket (>), as shown in this example:
   *    *      var v:Vector.<String> = new Vector.<String>();
   *     
   * 
To create a Vector instance from an Array or another Vector (such as one with a different base type), use the Vector() global function.
   * 
To create a pre-populated Vector instance, use the following syntax instead of using the parameters specified below:
   *    *      // var v:Vector.<T> = new <T>[E0, ..., En-1 ,];
   *      // For example:
   *      var v:Vector.<int> = new <int>[0,1,2,];
   *     
   * 
The following information applies to this syntax:
   * 

   * 
It is supported in Flash Professional CS5 and later, Flash Builder 4 and later, and Flex 4 and later.
   * 
The trailing comma is optional.
   * 
Empty items in the array are not supported; a statement such as var v:Vector.<int> = new <int>[0,,2,] throws a compiler error.
   * 
You can't specify a default length for the Vector instance. Instead, the length is the same as the number of elements in the initialization list.
   * 
You can't specify whether the Vector instance has a fixed length. Instead, use the fixed property.
   * 
Data loss or errors can occur if items passed as values don't match the specified type. For example:
   * 

   *    *      var v:Vector.<int> = new <int>[4.2]; // compiler error when running in strict mode
   *      trace(v[0]); //returns 4 when not running in strict mode
   *     
   * @param length The initial length (number of elements) of the Vector. If this parameter is greater than zero, the specified number of Vector elements are created and populated with the default value appropriate to the base type (null for reference types).
   * @param fixed Whether the Vector's length is fixed (true) or can be changed (false). This value can also be set using the fixed property.
   *
   * @see #fixed
   * @see Vector()
   *
   */
  public native function Vector$object(length:uint = 0, fixed:Boolean = false);

  /**
   * Concatenates the elements specified in the parameters with the elements in the Vector and creates a new Vector. If the parameters specify a Vector, the elements of that Vector are concatenated. If you don't pass any parameters, the new Vector is a duplicate (shallow clone) of the original Vector.
   * @param args One or more values of the base type of this Vector to be concatenated in a new Vector.
   *
   * @return A Vector with the same base type as this Vector that contains the elements from this Vector followed by elements from the parameters.
   *
   * @throws TypeError If any argument is not an instance of the base type and can't be converted to the base type.
   *
   */
  public native function concat(... rest):Vector$object;

  /**
   * Executes a test function on each item in the Vector until an item is reached that returns false for the specified function. You use this method to determine whether all items in a Vector meet a criterion, such as having values less than a particular number.
   * 
For this method, the second parameter, thisObject, must be null if the first parameter, callback, is a method closure. That is the most common way of using this method.
   * 
However, suppose you create a function on a frame on the main timeline using Flash Professional, but you want it to be called in a different this context:
   * 
    function myFunction(item:T, index:int, vector:Vector.<T>):Boolean {
   // your code here
   }
   
   * 
Suppose you then use the every() method on a Vector called myVector:
   * 
    myVector.every(myFunction, someObject);
   
   * 
Because myFunction is a member of the main class of the SWF file, it cannot be executed in a different this context. Flash runtimes throw an exception when this code runs. You can avoid this runtime error by assigning the function to a variable, as follows:
   * 
    var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
   //your code here
   };
   myVector.every(myFunction, someObject);
   
   * @param callback The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:
   * 
function callback(item:T, index:int, vector:Vector.<T>):Boolean {
   // your code here
   }
   
   * 
The callback function should return a Boolean value.
   * @param thisObject The object that the identifer this in the callback function refers to when the function is called.
   *
   * @return A Boolean value of true if the specified function returns true when called on all items in the Vector; otherwise, false.
   *
   * @see #some()
   *
   */
  public native function every(checker:Function, thisObj:Object = null):Boolean;

  /**
   * Executes a test function on each item in the Vector and returns a new Vector containing all items that return true for the specified function. If an item returns false, it is not included in the result Vector. The base type of the return Vector matches the base type of the Vector on which the method is called.
   * 
For this method, the second parameter, thisObject, must be null if the first parameter, callback, is a method closure. That is the most common way of using this method.
   * 
However, suppose you create a function on a frame on the main timeline using Flash Professional, but you want it to be called in a different this context:
   * 
     function myFunction(item:T, index:int, vector:Vector.<T>):Boolean {
   // your code here
   }
   
   * 
Suppose you then use the filter() method on a Vector called myVector:
   * 
     var result:Vector.<T> = myVector.filter(myFunction, someObject);
   
   * 
Because myFunction is a member of the main class of the SWF file, it cannot be executed in a different this context. Flash runtimes throw an exception when this code runs. You can avoid this runtime error by assigning the function to a variable, as follows:
   * 
     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
   //your code here
   };
   myVector.filter(myFunction, someObject);
   
   * @param callback The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:
   * 
function callback(item:T, index:int, vector:Vector.<T>):Boolean;
   * @param thisObject The object that the identifer this in the callback function refers to when the function is called.
   *
   * @return A new Vector that contains all items from the original Vector for which the callback function returned true.
   *
   * @see #map()
   *
   */
  public native function filter(callback:Function, thisObject:Object = null):Vector$object;

  /**
   * Executes a function on each item in the Vector.
   * 
For this method, the second parameter, thisObject, must be null if the first parameter, callback, is a method closure. That is the most common way of using this method.
   * 
However, suppose you create a function on a frame on the main timeline using Flash Professional, but you want it to be called in a different this context:
   * 
     function myFunction(item:T, index:int, vector:Vector.<T>):void {
   // your code here
   }
   
   * 
Suppose you then use the forEach() method on a Vector called myVector:
   * 
     myVector.forEach(myFunction, someObject);
   
   * 
Because myFunction is a member of the main class of the SWF file, it cannot be executed in a different this context. Flash runtimes throw an exception when this code runs. You can avoid this runtime error by assigning the function to a variable, as follows:
   * 
     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):void {
   //your code here
   };
   myVector.forEach(myFunction, someObject);
   
   * @param callback The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:
   * 
function callback(item:T, index:int, vector:Vector.<T>):void;
   * 
Any return value from the function call is discarded.
   * @param thisObject The object that the identifer this in the callback function refers to when the function is called.
   *
   */
  public native function forEach(callback:Function, thisObject:Object = null):void;

  /**
   * Searches for an item in the Vector and returns the index position of the item. The item is compared to the Vector elements using strict equality (===).
   * @param searchElement The item to find in the Vector.
   * @param fromIndex The location in the Vector from which to start searching for the item. If this parameter is negative, it is treated as length + fromIndex, meaning the search starts -fromIndex items from the end and searches from that position forward to the end of the Vector.
   *
   * @return A zero-based index position of the item in the Vector. If the searchElement argument is not found, the return value is -1.
   *
   * @see #lastIndexOf()
   * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/operators.html#strict_equality
   *
   */
  public native function indexOf(searchElement:Object, fromIndex:int = 0):int;

  /**
   * Converts the elements in the Vector to strings, inserts the specified separator between the elements, concatenates them, and returns the resulting string. A nested Vector is always separated by a comma (,), not by the separator passed to the join() method.
   * @param sep A character or string that separates Vector elements in the returned string. If you omit this parameter, a comma is used as the default separator.
   *
   * @return A string consisting of the elements of the Vector converted to strings and separated by the specified string.
   *
   * @see String#split()
   *
   */
  public native function join(sep:String = ","):String;

  /**
   * Searches for an item in the Vector, working backward from the specified index position, and returns the index position of the matching item. The item is compared to the Vector elements using strict equality (===).
   * @param searchElement The item to find in the Vector.
   * @param fromIndex The location in the Vector from which to start searching for the item. The default is the maximum allowable index value, meaning that the search starts at the last item in the Vector.
   * 
If this parameter is negative, it is treated as length + fromIndex, meaning the search starts -fromIndex items from the end and searches from that position backward to index 0.
   *
   * @return A zero-based index position of the item in the Vector. If the searchElement argument is not found, the return value is -1.
   *
   * @see #indexOf()
   * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/operators.html#strict_equality
   *
   */
  public native function lastIndexOf(searchElement:Object, fromIndex:int = 0x7fffffff):int;

  /**
   * Executes a function on each item in the Vector, and returns a new Vector of items corresponding to the results of calling the function on each item in this Vector. The result Vector has the same base type and length as the original Vector. The element at index i in the result Vector is the result of the call on the element at index i in the original Vector.
   * 
For this method, the second parameter, thisObject, must be null if the first parameter, callback, is a method closure. That is the most common way of using this method.
   * 
However, suppose you create a function on a frame on the main timeline, using Flash Professional but you want it to be called in a different this context:
   * 
     function myFunction(item:Object, index:int, vector:Vector.<T>):T {
   // your code here
   }
   
   * 
Suppose you then use the map() method on a Vector called myVector:
   * 
     myVector.map(myFunction, someObject);
   
   * 
Because myFunction is a member of the main class of the SWF file, it cannot be executed in a different this context. Flash runtimes throw an exception when this code runs. You can avoid this runtime error by assigning the function to a variable, as follows:
   * 
     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):void {
   //your code here
   };
   myVector.map(myFunction, someObject);
   
   * @param callback The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:
   * 
function callback(item:T, index:int, vector:Vector.<T>):T;
   * @param thisObject The object that the identifer this in the callback function refers to when the function is called.
   *
   * @return A new Vector that contains the results of calling the function on each item in this Vector. The result Vector has the same base type and length as the original.
   *
   * @see #filter()
   *
   */
  public native function map(callback:Function, thisObject:Object = null):Vector$object;

  /**
   * Removes the last element from the Vector and returns that element. The length property of the Vector is decreased by one when this function is called.
   * @return The value of the last element in the specified Vector.
   *
   * @throws RangeError If this method is called while fixed is true.
   *
   * @see #push()
   * @see #shift()
   * @see #unshift()
   *
   */
  public native function pop():Object;

  /**
   * Adds one or more elements to the end of the Vector and returns the new length of the Vector.
   * 
Because this function can accept multiple arguments, the data type of the arguments is not checked at compile time even in strict mode. However, if an argument is passed that is not an instance of the base type, an exception occurs at run time.
   * @param args One or more values to append to the Vector.
   *
   * @return The length of the Vector after the new elements are added.
   *
   * @throws TypeError If any argument is not an instance of the base type T of the Vector.
   * @throws RangeError If this method is called while fixed is true.
   *
   * @see #pop()
   * @see #shift()
   * @see #unshift()
   *
   */
  public native function push(...args):uint;

  /**
   * Reverses the order of the elements in the Vector. This method alters the Vector on which it is called.
   * @return The Vector with the elements in reverse order.
   *
   */
  public native function reverse():Vector$object;

  /**
   * Removes the first element from the Vector and returns that element. The remaining Vector elements are moved from their original position, i, to i - 1.
   * @return The first element in the Vector.
   *
   * @throws RangeError If fixed is true.
   *
   * @see #pop()
   * @see #push()
   * @see #unshift()
   *
   */
  public native function shift():Object;

  /**
   * Returns a new Vector that consists of a range of elements from the original Vector, without modifying the original Vector. The returned Vector includes the startIndex element and all elements up to, but not including, the endIndex element.
   * 
If you don't pass any parameters, the new Vector is a duplicate (shallow clone) of the original Vector. If you pass a value of 0 for both parameters, a new, empty Vector is created of the same type as the original Vector.
   * @param startIndex A number specifying the index of the starting point for the slice. If startIndex is a negative number, the starting point begins at the end of the Vector, where -1 is the last element.
   * @param endIndex A number specifying the index of the ending point for the slice. If you omit this parameter, the slice includes all elements from the starting point to the end of the Vector. If endIndex is a negative number, the ending point is specified from the end of the Vector, where -1 is the last element.
   *
   * @return a Vector that consists of a range of elements from the original Vector.
   *
   */
  public native function slice(startIndex:int = 0, endIndex:Number = 16777215):Vector$object;

  /**
   * Executes a test function on each item in the Vector until an item is reached that returns true. Use this method to determine whether any items in a Vector meet a criterion, such as having a value less than a particular number.
   * 
For this method, the second parameter, thisObject, must be null if the first parameter, callback, is a method closure. That is the most common way of using this method.
   * 
However, suppose you create a function on a frame on the main timeline, but you want it to be called in a different this context:
   * 
     function myFunction(item:Object, index:int, vector:Vector.<T>):Boolean {
   // your code here
   }
   
   * 
Suppose you then use the some() method on a Vector called myVector:
   * 
     myVector.some(myFunction, someObject);
   
   * 
Because myFunction is a member of the main class of the SWF file, it cannot be executed in a different this context. Flash runtimes throw an exception when this code runs. You can avoid this runtime error by assigning the function to a variable, as follows:
   * 
     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
   //your code here
   };
   myVector.some(myFunction, someObject);
   
   * @param callback The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:
   * 
function callback(item:T, index:int, vector:Vector.<T>):Boolean
   * 
The callback function should return a Boolean value.
   * @param thisObject The object that the identifer this in the callback function refers to when the function is called.
   *
   * @return A Boolean value of true if any items in the Vector return true for the specified function; otherwise, false.
   *
   * @see #every()
   *
   */
  public native function some(callback:Function, thisObject:Object = null):Boolean;

  /**
   * Sorts the elements in the Vector. This method sorts according to the function provided as the compareFunction parameter.
   * @param compareFunction A comparison method that determines the behavior of the sort.
   * 
The specified method must take two arguments of the base type (T) of the Vector and return a Number:
   *    * function compare(x:T, y:T):Number {}
   * 
The logic of the compareFunction function is that, given two elements x and y, the function returns one of the following three values:
   * 

   * 
a negative number, if x should appear before y in the sorted sequence
   * 
0, if x equals y
   * 
a positive number, if x should appear after y in the sorted sequence
   *
   * @return This Vector, with elements in the new order.
   *
   */
  public native function sort(compareFunction:Function):Vector$object;

  /**
   * Adds elements to and removes elements from the Vector. This method modifies the Vector without making a copy.
   * 
Note: To override this method in a subclass of Vector, use ...args for the parameters, as this example shows:
   * 
     public override function splice(...args) {
   // your statements here
   }
   
   * @param startIndex An integer that specifies the index of the element in the Vector where the insertion or deletion begins. You can use a negative integer to specify a position relative to the end of the Vector (for example, -1 for the last element of the Vector).
   * @param deleteCount An integer that specifies the number of elements to be deleted. This number includes the element specified in the startIndex parameter. If you do not specify a value for the deleteCount parameter, the method deletes all of the values from the startIndex element to the last element in the Vector. (The default value is uint.MAX_VALUE.) If the value is 0, no elements are deleted.
   * @param items An optional list of one or more comma-separated values to insert into the Vector at the position specified in the startIndex parameter.
   *
   * @return a Vector containing the elements that were removed from the original Vector.
   *
   * @throws RangeError If the startIndex and deleteCount arguments specify an index to be deleted that's outside the Vector's bounds.
   * @throws RangeError If this method is called while fixed is true and the splice() operation changes the length of the Vector.
   *
   */
  public native function splice(startIndex:int, deleteCount:uint = 4294967295, ...items):Vector$object;

  /**
   * Returns a string that represents the elements in the specified Vector. Every element in the Vector, starting with index 0 and ending with the highest index, is converted to a concatenated string and separated by commas. In the ActionScript 3.0 implementation, this method returns the same value as the Vector.toString() method.
   * @return A string of Vector elements.
   *
   * @see #toString()
   *
   */
  public native function toLocaleString():String;

  /**
   * Returns a string that represents the elements in the Vector. Every element in the Vector, starting with index 0 and ending with the highest index, is converted to a concatenated string and separated by commas. To specify a custom separator, use the Vector.join() method.
   * @return A string of Vector elements.
   *
   * @see String#split()
   * @see #join()
   *
   */
  public native function toString():String;

  /**
   * Adds one or more elements to the beginning of the Vector and returns the new length of the Vector. The other elements in the Vector are moved from their original position, i, to i + the number of new elements.
   * 
Because this function can accept multiple arguments, the data type of the arguments is not checked at compile time even in strict mode. However, if an argument is passed that is not an instance of the base type, an exception occurs at run time.
   * @param args One or more instances of the base type of the Vector to be inserted at the beginning of the Vector.
   *
   * @return An integer representing the new length of the Vector.
   *
   * @throws TypeError If any argument is not an instance of the base type T of the Vector.
   * @throws RangeError If this method is called while fixed is true.
   *
   * @see #pop()
   * @see #push()
   * @see #shift()
   *
   */
  public native function unshift(...args):uint;
}
}