org.liquidplayer.javascript

Class JSObject

java.lang.Object

org.liquidplayer.javascript.JSValue

org.liquidplayer.javascript.JSObject

Direct Known Subclasses:

JSArrayBuffer, JSContext, JSDataView, JSDate, JSError, JSFunction, JSIterator, JSIterator.Next, JSObjectPropertiesMap, JSRegExp

public class JSObject
extends JSValue

A JavaScript object.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JSObject.jsexport
class	JSObject.Property<T> A JavaScript object property.

Field Summary

Fields

Modifier and Type	Field and Description
static int	JSPropertyAttributeDontDelete Specifies that the delete operation should fail on a property.
static int	JSPropertyAttributeDontEnum Specifies that a property should not be enumerated by JSPropertyEnumerators and JavaScript for...in loops.
static int	JSPropertyAttributeNone Specifies that a property has no special attributes.
static int	JSPropertyAttributeReadOnly Specifies that a property is read-only.

Constructor Summary

Constructors

Constructor and Description
JSObject() Called only by convenience subclasses.
JSObject(JSContext ctx) Creates a new, empty JavaScript object.
JSObject(JSContext ctx, java.lang.Class<?> iface) Creates a new object with function properties set for each method in the defined interface.
JSObject(JSContext ctx, java.util.Map map) Creates a new object with the entries in 'map' set as properties.

Method Summary

Modifier and Type	Method and Description
JSValue	__nullFunc()
boolean	deleteProperty(java.lang.String prop) Deletes a property from the object
JSObject	getThis()
int	hashCode()
boolean	hasProperty(java.lang.String prop) Determines if the object contains a given property
boolean	isConstructor() Determines if the object is a constructor
boolean	isFunction() Determines if the object is a function
JSValue	property(java.lang.String prop) Gets the property named 'prop'
void	property(java.lang.String prop, java.lang.Object value) Sets the value of property 'prop'.
void	property(java.lang.String prop, java.lang.Object val, int attributes) Sets the value of property 'prop'
JSValue	propertyAtIndex(int index) Returns the property at index 'index'.
void	propertyAtIndex(int index, java.lang.Object val) Sets the property at index 'index'.
java.lang.String[]	propertyNames() Gets the list of set property names on the object
JSValue	prototype() Gets the prototype object, if it exists
void	prototype(JSValue proto) Sets the prototype object

Methods inherited from class org.liquidplayer.javascript.JSValue

equals, getContext, isArray, isBoolean, isDate, isEqual, isFloat32Array, isFloat64Array, isInstanceOfConstructor, isInt16Array, isInt32Array, isInt8Array, isNull, isNumber, isObject, isStrictEqual, isString, isTypedArray, isUint16Array, isUint32Array, isUint8Array, isUint8ClampedArray, isUndefined, toBoolean, toFunction, toJSArray, toJSON, toNumber, toObject, toString, valueHash, valueRef

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSPropertyAttributeNone

public static final int JSPropertyAttributeNone

Specifies that a property has no special attributes.

See Also:

Constant Field Values

JSPropertyAttributeReadOnly

public static final int JSPropertyAttributeReadOnly

Specifies that a property is read-only.

See Also:

Constant Field Values

JSPropertyAttributeDontEnum

public static final int JSPropertyAttributeDontEnum

Specifies that a property should not be enumerated by JSPropertyEnumerators and JavaScript for...in loops.

See Also:

Constant Field Values

JSPropertyAttributeDontDelete

public static final int JSPropertyAttributeDontDelete

Specifies that the delete operation should fail on a property.

See Also:

Constant Field Values

Constructor Detail

JSObject

public JSObject(JSContext ctx)

Creates a new, empty JavaScript object. In JS:

 
 var obj = {}; // OR
 var obj = new Object();
 
 

Parameters:

ctx - The JSContext to create the object in

Since:

0.1.0

JSObject

public JSObject()

Called only by convenience subclasses. If you use this, you must set context and valueRef yourself.

Since:

0.1.0

JSObject

public JSObject(JSContext ctx,
                java.lang.Class<?> iface)

Creates a new object with function properties set for each method in the defined interface. In JS:

 
 var obj = {
     func1: function(a)   { alert(a); },
     func2: function(b,c) { alert(b+c); }
 };
 
 

Where func1, func2, etc. are defined in interface 'iface'. This JSObject must implement 'iface'.

Parameters:

ctx - The JSContext to create the object in

iface - The Java Interface defining the methods to expose to JavaScript

Since:

0.1.0

JSObject

public JSObject(JSContext ctx,
                java.util.Map map)

Creates a new object with the entries in 'map' set as properties.

Parameters:

ctx - The JSContext to create object in

map - The map containing the properties

Since:

0.1.0

Method Detail

hasProperty

public boolean hasProperty(java.lang.String prop)

Determines if the object contains a given property

Parameters:

prop - The property to test the existence of

Returns:

true if the property exists on the object, false otherwise

Since:

0.1.0

property

public JSValue property(java.lang.String prop)

Gets the property named 'prop'

Parameters:

prop - The name of the property to fetch

Returns:

The JSValue of the property, or null if it does not exist

Since:

0.1.0

property

public void property(java.lang.String prop,
                     java.lang.Object val,
                     int attributes)

Sets the value of property 'prop'

Parameters:

prop - The name of the property to set

val - The Java object to set. The Java object will be converted to a JavaScript object automatically.

attributes - And OR'd list of JSProperty constants

Since:

0.1.0

property

public void property(java.lang.String prop,
                     java.lang.Object value)

Sets the value of property 'prop'. No JSProperty attributes are set.

Parameters:

prop - The name of the property to set

value - The Java object to set. The Java object will be converted to a JavaScript object automatically.

Since:

0.1.0

deleteProperty

public boolean deleteProperty(java.lang.String prop)

Deletes a property from the object

Parameters:

prop - The name of the property to delete

Returns:

true if the property was deleted, false otherwise

Since:

0.1.0

propertyAtIndex

public JSValue propertyAtIndex(int index)

Returns the property at index 'index'. Used for arrays.

Parameters:

index - The index of the property

Returns:

The JSValue of the property at index 'index'

Since:

0.1.0

propertyAtIndex

public void propertyAtIndex(int index,
                            java.lang.Object val)

Sets the property at index 'index'. Used for arrays.

Parameters:

index - The index of the property to set

val - The Java object to set, will be automatically converted to a JavaScript value

Since:

0.1.0

propertyNames

public java.lang.String[] propertyNames()

Gets the list of set property names on the object

Returns:

A string array containing the property names

Since:

0.1.0

isFunction

public boolean isFunction()

Determines if the object is a function

Returns:

true if the object is a function, false otherwise

Since:

0.1.0

isConstructor

public boolean isConstructor()

Determines if the object is a constructor

Returns:

true if the object is a constructor, false otherwise

Since:

0.1.0

hashCode

public int hashCode()

Overrides:

hashCode in class JSValue

prototype

public JSValue prototype()

Gets the prototype object, if it exists

Returns:

A JSValue referencing the prototype object, or null if none

Since:

0.1.0

prototype

public void prototype(JSValue proto)

Sets the prototype object

Parameters:

proto - The object defining the function prototypes

Since:

0.1.0

getThis

public JSObject getThis()

__nullFunc

public JSValue __nullFunc()