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

Class NodeFieldObject

java.lang.Object

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

org.web3d.vrml.scripting.ecmascript.builtin.NodeFieldObject

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

Direct Known Subclasses:

MFNode, SFNode

public abstract class NodeFieldObject
extends FieldScriptableObject

Extension of the basic scriptable object with some specifics for handling nested field data.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected int	parentFieldIndex	The field index in the parentNode that this belongs to
protected VRMLNodeType	parentNode	The parent node of this field

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

BAD_FORMAT_MSG, dataChanged, INVALID_TYPE_MSG, readOnly, READONLY_MSG, scriptField

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NodeFieldObject(String name)	Construct a new instance of this object using the given name.

Method Summary

Modifier and Type	Method	Description
abstract Object	getChangedFields()	Get the list of fields that have changed.
abstract void	realize()	If the node contains a node instance, check and call its setupFinished if needed.
void	setParentField(VRMLNodeType parent, int fieldIndex)	Set the container node and field information for this node.

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

delete, delete, get, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasChanged, hasInstance, locateFunction, put, put, registerFunction, setParentScope, setPrototype, setReadOnly, setScriptField

Methods inherited from class java.lang.Object

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

Field Details

parentNode

protected VRMLNodeType parentNode

The parent node of this field

parentFieldIndex

protected int parentFieldIndex

The field index in the parentNode that this belongs to

Constructor Details

NodeFieldObject

protected NodeFieldObject(String name)

Construct a new instance of this object using the given name.

Parameters:

name - The name of the scriptable object

Method Details

setParentField

public void setParentField(VRMLNodeType parent,
 int fieldIndex)

Set the container node and field information for this node.

Parameters:

parent - The parent node of this field

fieldIndex - The index of the field that this field wraps

getChangedFields

public abstract Object getChangedFields()

Get the list of fields that have changed. The return value may be either a single NodeFieldData instance or an ArrayList of field data instances if more than one has changed. When called, this is recursive so that all fields and nodes referenced by this node field will be included. If no fields have changed, this will return null. However, that should never happen as the user should always check FieldScriptableObject.hasChanged() which would return false before calling this method.

Returns:

A single NodeFieldData, ArrayList or null

realize

public abstract void realize()

If the node contains a node instance, check and call its setupFinished if needed.