Package org.web3d.vrml.scripting.ecmascript.x3d

Class ProtoDeclaration

java.lang.Object

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

org.web3d.vrml.scripting.ecmascript.x3d.ProtoDeclaration

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

public class ProtoDeclaration
extends AbstractScriptableObject

ProtoDeclaration prototype object.

Version:

$Revision: 1.5 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.scripting.ecmascript.builtin.AbstractScriptableObject

BAD_FORMAT_MSG, dataChanged, INVALID_TYPE_MSG, JS_FUNCTION_PREFIX, readOnly, READONLY_MSG

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
ProtoDeclaration(VRMLProtoDeclare decl, BasicScene scene)	Construct an ExternProto representation from the given internal representation.

Method Summary

Modifier and Type	Method	Description
Object	get(String name, org.mozilla.javascript.Scriptable start)	Get the value of the named function.
boolean	has(String name, org.mozilla.javascript.Scriptable start)	Check for the named property presence.
SFNode	jsFunction_newInstance()	newInstance() function defined by From table 6.71.
void	put(String name, org.mozilla.javascript.Scriptable start, Object value)	Sets the named property with a new value.

Methods inherited from class org.web3d.vrml.scripting.ecmascript.builtin.AbstractScriptableObject

delete, delete, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, hasInstance, put, setParentScope, setPrototype, setReadOnly

Methods inherited from class java.lang.Object

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

Constructor Details

ProtoDeclaration

public ProtoDeclaration(VRMLProtoDeclare decl,
 BasicScene scene)

Construct an ExternProto representation from the given internal representation.

Parameters:

decl - The declaration to build the Rhino representative from

scene - The scene that owns this decl

Method Details

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

Overrides:

has in class AbstractScriptableObject

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(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

Overrides:

get in class AbstractScriptableObject

Parameters:

name - The variable name

start - The object where the lookup began

Returns:

the corresponding function object or null

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 SFColor(0, 1, 0); then a whole new object is passed to us.

Specified by:

put in interface org.mozilla.javascript.Scriptable

Overrides:

put in class AbstractScriptableObject

Parameters:

name - The name of the property to define

start - The object who's property is being set

value - The value being requested

jsFunction_newInstance

public SFNode jsFunction_newInstance()

newInstance() function defined by From table 6.71.

Returns:

an SFNode created from this new instance