Class PTArrayUtil

Object
   |
   +--PTArrayUtil

class PTArrayUtil

Static class containing array utility methods.

Usage:	
 	PTArrayUtil.removeElementAt(array, 4);
 

Field Detail

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTArrayUtil

PTArrayUtil()

PTArrayUtil static object constructor

Returns:
New PTArrayUtil object.

isArrayLike

<static> Boolean isArrayLike(arr)

Checks if an object resembles an Array, in that it is a numerically indexed list of objects. Some objects (for example Function.arguments) which have numerically-indexed sub-objects and which have a length property are enough like Array objects that we can use them in PTArrayUtil. This method identifies such objects.

Parameters:
arr - Array to test

Returns:
First element of Array

moveElement

<static> void moveElement(arr,sourceIndex,targetIndex)

Moves an element in an array from one position to another, adjusting positions of other elements

Parameters:
arr - the Array
sourceIndex - the index of the array element to move
targetIndex - where to move the array element to

push

<static> Number push(arr,items)

Adds the arguments as new elements to the end of the Array. Custom implementation of Array.push for MSIE 5.0., which doesn't natively support Array.push().

Parameters:
arr - Array to push
items - Object or array of objects to append.

Returns:
New length of Array

removeElementAt

<static> Object removeElementAt(arr,index)

Remove an element from an array at a given index

Parameters:
arr - Array to test
index - Index of element to remove

Returns:
The removed element

shift

<static> Object shift(arr)

Removes first element of an array and moves other elements down one position, shortening the length of the Array by one. Custom implementation of Array.shift for MSIE 5.0., which doesn't natively support Array.shift().

Parameters:
arr - Array to shift

Returns:
First element of Array

splice

<static> Array splice(arr, start, deleteCount, variableNumberOfOtherArguments)

Inserts elements into an array at a specific index. This is a custom implementation of Array.splice for MSIE 5.0., which doesn't natively support Array.splice().

Parameters:
arr - Array to splice (Array)
start - Start index of splice (integer)
deleteCount - Number of items to remove (integer)
variableNumberOfOtherArguments - Any number of arguments may be passed in here, and all will be splices into the array at the start point.

Returns:
Elements which were removed from the Array