Package org.web3d.vrml.scripting.ecmascript.builtin

Class AbstractScriptableObject

java.lang.Object

org.web3d.vrml.scripting.ecmascript.builtin.AbstractScriptableObject

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

Direct Known Subclasses:

Browser, ComponentInfo, ComponentInfoArray, ExternProtoDeclaration, ExternProtoDeclarationArray, FieldDefinitionArray, ProfileInfo, ProfileInfoArray, ProtoDeclaration, ProtoDeclarationArray, Route, RouteArray, X3DConstants, X3DExecutionContext, X3DFieldDefinition

public abstract class AbstractScriptableObject
extends Object
implements org.mozilla.javascript.Scriptable

Base representation of all miscellaneous objects in ecmascript scripting.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BAD_FORMAT_MSG	Error message when given a string that you parse for a number and it is not a valid format.
protected boolean	dataChanged	Flag to be set if the data has changed
protected static final String	INVALID_TYPE_MSG	Error message when a property is being set and it is not a compatible javascript type with what is required.
protected static final String	JS_FUNCTION_PREFIX	The prefix of the name for any function call we dynamically look up
protected boolean	readOnly	Flag to say this field is read only
protected static final String	READONLY_MSG	Error message for when the field is marked readOnly

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptableObject(String name)	Default public constructor required by Rhino for when created by an Ecmascript call.

Method Summary

Modifier and Type	Method	Description
void	delete(int index)	Delete a property.
void	delete(String name)	Delete a property.
Object	get(int index, org.mozilla.javascript.Scriptable start)	Get the variable at the given index.
Object	get(String name, org.mozilla.javascript.Scriptable start)	Get the value of the named function.
String	getClassName()	The class name as defined to the Javascript function.
Object	getDefaultValue(Class hint)	Return a default value for this.
Object[]	getIds()	Get properties.
org.mozilla.javascript.Scriptable	getParentScope()	Fetch the parent scope of this context.
org.mozilla.javascript.Scriptable	getPrototype()	Get the prototype used by this context.
boolean	has(int index, org.mozilla.javascript.Scriptable start)	Check for the indexed property presence.
boolean	has(String name, org.mozilla.javascript.Scriptable start)	Check for the named property presence.
boolean	hasInstance(org.mozilla.javascript.Scriptable value)
void	put(int index, org.mozilla.javascript.Scriptable start, Object value)	Sets a property based on the index.
void	put(String name, org.mozilla.javascript.Scriptable start, Object value)	Sets the named property with a new value.
void	setParentScope(org.mozilla.javascript.Scriptable parent)	Set the parent scope of this object.
void	setPrototype(org.mozilla.javascript.Scriptable proto)	Ignored.
void	setReadOnly()	Set this field to be read only.

Methods inherited from class java.lang.Object

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

Field Details

BAD_FORMAT_MSG

protected static final String BAD_FORMAT_MSG

Error message when given a string that you parse for a number and it is not a valid format. The message assumes that you will tack on the passed in string as part of the message.

See Also:

• Constant Field Values

INVALID_TYPE_MSG

protected static final String INVALID_TYPE_MSG

Error message when a property is being set and it is not a compatible javascript type with what is required.

See Also:

• Constant Field Values

READONLY_MSG

protected static final String READONLY_MSG

Error message for when the field is marked readOnly

See Also:

• Constant Field Values

JS_FUNCTION_PREFIX

protected static final String JS_FUNCTION_PREFIX

The prefix of the name for any function call we dynamically look up

See Also:

• Constant Field Values

dataChanged

protected boolean dataChanged

Flag to be set if the data has changed

readOnly

protected boolean readOnly

Flag to say this field is read only

Constructor Details

AbstractScriptableObject

protected AbstractScriptableObject(String name)

Default public constructor required by Rhino for when created by an Ecmascript call.

Parameters:

name - the class name of the script

Method Details

getClassName

public String getClassName()

The class name as defined to the Javascript function.

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Returns:

the name of this class

getDefaultValue

public Object getDefaultValue(Class hint)

Return a default value for this. Return null until we have a better idea.

Specified by:

getDefaultValue in interface org.mozilla.javascript.Scriptable

Returns:

default value for this (Abstract value is null)

has

public boolean has(int index,
 org.mozilla.javascript.Scriptable start)

Check for the indexed property presence. Always returns NOT_FOUND as ECMAScript doesn't support indexed objects.

Specified by:

has in interface org.mozilla.javascript.Scriptable

Returns:

false (NOT_FOUND)

has

public boolean has(String name,
 org.mozilla.javascript.Scriptable start)

Check for the named property presence.

Specified by:

has in interface org.mozilla.javascript.Scriptable

Parameters:

name - name of the script

start - the script corresponding to the given name

Returns:

true if it is a defined eventOut or field

get

public Object get(int index,
 org.mozilla.javascript.Scriptable start)

Get the variable at the given index. Since we don't support integer index values for fields of the script, this always returns NOT_FOUND.

Specified by:

get in interface org.mozilla.javascript.Scriptable

Returns:

NOT_FOUND

get

public Object get(String name,
 org.mozilla.javascript.Scriptable start)

Get the value of the named function. If no function object is registered for this name, the method will return null.

Specified by:

get in interface org.mozilla.javascript.Scriptable

Parameters:

name - The variable name

start - The object where the lookup began

Returns:

the corresponding function object or null

put

public void put(int index,
 org.mozilla.javascript.Scriptable start,
 Object value)

Sets a property based on the index. Since we don't support indexes, this is ignored.

Specified by:

put in interface org.mozilla.javascript.Scriptable

Parameters:

index - The index of the property to set

start - The object who's property is being set

value - The value being requested

put

public void put(String name,
 org.mozilla.javascript.Scriptable start,
 Object value)

Sets the named property with a new value. A put usually means changing the entire property. So, if the property has changed using an operation like e = new SFVec3f(0, 1, 0); then a whole new object is passed to us.

Specified by:

put in interface org.mozilla.javascript.Scriptable

Parameters:

name - The name of the property to define

start - The object who's property is being set

value - The value being requested

delete

public void delete(int index)

Delete a property. There are no dynamic fields, so this does nothing.

Specified by:

delete in interface org.mozilla.javascript.Scriptable

Parameters:

index - The index of the property to delete

delete

public void delete(String name)

Delete a property. There are no dynamic fields, so this does nothing.

Specified by:

delete in interface org.mozilla.javascript.Scriptable

Parameters:

name - The name of the property to delete

getIds

public Object[] getIds()

Get properties. We return an empty array since we define all properties to be DONTENUM.

Specified by:

getIds in interface org.mozilla.javascript.Scriptable

Returns:

EMPTY_IDS

hasInstance

public boolean hasInstance(org.mozilla.javascript.Scriptable value)

Specified by:

hasInstance in interface org.mozilla.javascript.Scriptable

getParentScope

public org.mozilla.javascript.Scriptable getParentScope()

Fetch the parent scope of this context.

Specified by:

getParentScope in interface org.mozilla.javascript.Scriptable

Returns:

parentScope

setParentScope

public void setParentScope(org.mozilla.javascript.Scriptable parent)

Set the parent scope of this object. Should be the global shared instance.

Specified by:

setParentScope in interface org.mozilla.javascript.Scriptable

Parameters:

parent - new value for parentScope

getPrototype

public org.mozilla.javascript.Scriptable getPrototype()

Get the prototype used by this context.

Specified by:

getPrototype in interface org.mozilla.javascript.Scriptable

Returns:

prototype

setPrototype

public void setPrototype(org.mozilla.javascript.Scriptable proto)

Ignored. Set the prototype for this context. The context does not have a prototype that we want the user to play with.

Specified by:

setPrototype in interface org.mozilla.javascript.Scriptable

Parameters:

proto - The prototype definition to use

setReadOnly

public void setReadOnly()

Set this field to be read only. Once set, cannot be turned off.