def.js

Class VBArray<T>

java.lang.Object

def.js.Object

def.js.VBArray<T>

public class VBArray<T>
extends Object

Enables reading from a COM safe array, which might have an alternate lower bound, or multiple dimensions.

Field Summary

Fields inherited from class def.js.Object

constructor, prototype

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VBArray()
	VBArray(Object safeArray)

Method Summary

Modifier and Type	Method and Description
double	dimensions() Returns the number of dimensions (1-based).
T	getItem(double dimension1Index, double... dimensionNIndexes) Takes an index for each dimension in the array, and returns the item at the corresponding location.
double	lbound() Returns the smallest available index for a given dimension.
double	lbound(double dimension) Returns the smallest available index for a given dimension.
T[]	toArray() Returns a Javascript array with all the elements in the VBArray.
double	ubound() Returns the largest available index for a given dimension.
double	ubound(double dimension) Returns the largest available index for a given dimension.

Methods inherited from class def.js.Object

$applyStatic, $applyStatic, $delete, $delete, $get, $get, $set, $set, $super, assign, create, create, defineProperties, defineProperty, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, hasOwnProperty, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, propertyIsEnumerable, propertyIsEnumerable, seal, toJSString, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VBArray

public VBArray(Object safeArray)

VBArray

protected VBArray()

Method Detail

dimensions

public double dimensions()

Returns the number of dimensions (1-based).

getItem

public T getItem(double dimension1Index,
                 double... dimensionNIndexes)

Takes an index for each dimension in the array, and returns the item at the corresponding location.

lbound

public double lbound(double dimension)

Returns the smallest available index for a given dimension.

Parameters:

dimension - 1-based dimension (defaults to 1)

ubound

public double ubound(double dimension)

Returns the largest available index for a given dimension.

Parameters:

dimension - 1-based dimension (defaults to 1)

toArray

public T[] toArray()

Returns a Javascript array with all the elements in the VBArray. If there are multiple dimensions, each successive dimension is appended to the end of the array. Example: [[1,2,3],[4,5,6]] becomes [1,2,3,4,5,6]

lbound

public double lbound()

Returns the smallest available index for a given dimension.

Parameters:

dimension - 1-based dimension (defaults to 1)

ubound

public double ubound()

Returns the largest available index for a given dimension.

Parameters:

dimension - 1-based dimension (defaults to 1)