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

Class FieldScriptableObject

java.lang.Object

org.web3d.vrml.scripting.ecmascript.builtin.FieldScriptableObject

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

Direct Known Subclasses:

Matrix3, Matrix4, MFBool, MFColor, MFColorRGBA, MFDouble, MFFloat, MFImage, MFInt32, MFRotation, MFString, MFTime, MFVec2d, MFVec2f, MFVec3d, MFVec3f, MFVec4d, MFVec4f, NodeFieldObject, SFColor, SFColorRGBA, SFImage, SFRotation, SFVec2d, SFVec2f, SFVec3d, SFVec3f, SFVec4d, SFVec4f, VrmlMatrix

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

Base representation of all field objects in ecmascript scripting.

All fields must extend this class. All implementations should make sure to set the dataChanged field whenever their internal data state has been modified.

Version:

$Revision: 1.6 $

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 boolean	readOnly	Flag to say this field is read only (directOutput == true)
protected static final String	READONLY_MSG	Error message for when the field is marked readOnly
protected boolean	scriptField	Flag to say this is a script variable and that the readOnly rules are modified somewhat to deal with it.

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldScriptableObject(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)
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)
Object[]	getIds()
org.mozilla.javascript.Scriptable	getParentScope()
org.mozilla.javascript.Scriptable	getPrototype()
boolean	has(int index, org.mozilla.javascript.Scriptable start)
boolean	has(String name, org.mozilla.javascript.Scriptable start)
boolean	hasChanged()	Query this field object to see if it has changed since the last time this method was called.
boolean	hasInstance(org.mozilla.javascript.Scriptable value)
protected org.mozilla.javascript.FunctionObject	locateFunction(String methodName)	Convenience method to locate a function name for this object and create an appropriate Function instance to represent it.
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.
protected void	registerFunction(String name, Object value)	Register a function object with this field type
void	setParentScope(org.mozilla.javascript.Scriptable parent)
void	setPrototype(org.mozilla.javascript.Scriptable proto)	Ignored.
void	setReadOnly()	Set this field to be read only.
void	setScriptField()	Set this field to be a script field.

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

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 (directOutput == true)

scriptField

protected boolean scriptField

Flag to say this is a script variable and that the readOnly rules are modified somewhat to deal with it. It allows direct writing to this field, but does not allow writing to any children field.

Constructor Details

FieldScriptableObject

protected FieldScriptableObject(String name)

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

Parameters:

name - the name of this Scriptable object

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)

Specified by:

getDefaultValue in interface org.mozilla.javascript.Scriptable

has

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

Specified by:

has in interface org.mozilla.javascript.Scriptable

has

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

Specified by:

has in interface org.mozilla.javascript.Scriptable

get

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

Specified by:

get in interface org.mozilla.javascript.Scriptable

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

Specified by:

getIds in interface org.mozilla.javascript.Scriptable

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

Specified by:

getParentScope in interface org.mozilla.javascript.Scriptable

setParentScope

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

Specified by:

setParentScope in interface org.mozilla.javascript.Scriptable

getPrototype

public org.mozilla.javascript.Scriptable getPrototype()

Specified by:

getPrototype in interface org.mozilla.javascript.Scriptable

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

setScriptField

public void setScriptField()

Set this field to be a script field. Once set, cannot be turned off.

setReadOnly

public void setReadOnly()

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

registerFunction

protected void registerFunction(String name,
 Object value)

Register a function object with this field type

Parameters:

name - The name to associate it with

value - The object to keep this as

locateFunction

protected org.mozilla.javascript.FunctionObject locateFunction(String methodName)

Convenience method to locate a function name for this object and create an appropriate Function instance to represent it. It assumes that the name you give it is the normal name and will add a "jsFunction_" prefix to locate that from the method details. There is also the implicit assumption that you have made a check for this name being a valid function for this object before you call this method. If a function object is found for this method, it will automatically be registered and you can also have a copy of it returned to use.

Parameters:

methodName - The real method name to look for

Returns:

The function object corresponding to the munged method name

hasChanged

public boolean hasChanged()

Query this field object to see if it has changed since the last time this method was called. In a single-threaded environment, calling this method twice should return true and then false (assuming that data had changed since the previous calls).

Returns:

true if the data has changed.