com.teamdev.jxbrowser.chromium

Class JSArray

java.lang.Object

com.teamdev.jxbrowser.chromium.JSValue

com.teamdev.jxbrowser.chromium.JSObject

com.teamdev.jxbrowser.chromium.JSArray

public class JSArray
extends JSObject

Represents JavaScript Array object. The object represents a "proxy" object to existing JavaScript array. It can reference JavaScript array that was already disposed because the web page where the JavaScript array was initialized has been already unloaded/reloaded. In this case any attempt to use JSArray that references already disposed JavaScript array will cause the IllegalStateException error. To find out whether JavaScript array is still valid use the getContext().isDisposed() method.

Method Summary

Modifier and Type	Method and Description
JSArray	asArray() Casts the current JavaScript object to JSArray type.
JSValue	get(int index) Returns JavaScript value at the given index in the JavaScript array.
boolean	isArray() Indicates whether JavaScript value is an array.
int	length() Returns the number of elements in the array.
boolean	set(int index, java.lang.Object value) Updates/inserts JavaScript value at the given index in the JavaScript array.
java.lang.String	toString()

Methods inherited from class com.teamdev.jxbrowser.chromium.JSObject

asJavaObject, asObject, getContext, getOwnPropertyNames, getProperty, getPropertyNames, hasProperty, isJavaObject, isObject, removeProperty, setProperty, setProperty, toJSONString

Methods inherited from class com.teamdev.jxbrowser.chromium.JSValue

asBoolean, asBooleanObject, asFunction, asNumber, asNumberObject, asString, asStringObject, getBooleanValue, getNumberValue, getStringValue, isBoolean, isBooleanObject, isFunction, isNull, isNumber, isNumberObject, isString, isStringObject, isUndefined

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

length

public int length()

Returns the number of elements in the array.

Returns:

the number of elements in the array.

Throws:

java.lang.IllegalStateException - when array is already disposed or invalid.

get

public JSValue get(int index)

Returns JavaScript value at the given index in the JavaScript array. The index mustn't be negative. Returns "undefined" JavaScript value when the index is out of array bounds (e.g. more than the array size).

Parameters:

index - element position in the array. Must be > 0.

Returns:

JavaScript value at the given position in the JavaScript array.

Throws:

java.lang.IllegalStateException - when array is already disposed or invalid.

java.lang.IllegalArgumentException - when index is negative.

set

public boolean set(int index,
                   java.lang.Object value)

Updates/inserts JavaScript value at the given index in the JavaScript array. The index mustn't be negative. If the index is more than the array size, then array size will be extended, the give value will be inserted at the specified position, the values between the latest item in the array and the new index will be filled with JavaScript "undefined" values (e.g. the undefined "holes" will be created in the array).

Parameters:

index - element position in the array. Must be > 0. Can be more than array size.

value - a new value associated with the property with the given index. Cannot be null or JSObject with a different JavaScript context.

Returns:

true when the given value was successfully inserted at the given index, otherwise returns false.

Throws:

java.lang.IllegalArgumentException - when value is null or represents JSObject with a different JavaScript context.

java.lang.IllegalStateException - when array is already disposed or invalid.

java.lang.IllegalArgumentException - when index is negative.

Since:

6.7

isArray

public boolean isArray()

Description copied from class: JSValue

Indicates whether JavaScript value is an array. If this method returns true, then the value can be casted to JSArray type. For example:

 if (value.isArray()) {
     JSArray array = value.asArray();
 }
 

Overrides:

isArray in class JSValue

Returns:

true when JavaScript value is an array.

asArray

public JSArray asArray()

Description copied from class: JSValue

Casts the current JavaScript object to JSArray type. If the current object doesn't represent an array, the IllegalStateException error is thrown.

Overrides:

asArray in class JSValue

toString

public java.lang.String toString()

Overrides:

toString in class JSObject