Package vrml.node

Class Node

java.lang.Object

vrml.BaseNode

vrml.node.Node

Direct Known Subclasses:

JSAINode

public abstract class Node
extends BaseNode

This is the basic interface for all VRML nodes. All VRML fields are accessed through the field methods. New nodes are created through the Browser using the load and create methods.

Version:

$Revision: 1.8 $

Author:

Alan Hudson

Field Summary

Fields inherited from class vrml.BaseNode

browser, nodeName, realNode

Constructor Summary

Constructors

Constructor	Description
Node()

Method Summary

Modifier and Type	Method	Description
protected abstract ConstField	createConstField(String name)	Create a constant field that represents an eventOut.
protected abstract Field	createField(String name, boolean checkEventIn)	Create a field given a name.
final Field	getEventIn(String fieldName)	Fetch the named exposed field from this node instance.
final ConstField	getEventOut(String fieldName)	Fetch the named eventOut field from this node instance.
final Field	getExposedField(String fieldName)	Fetch the named exposed field from this node instance.

Methods inherited from class vrml.BaseNode

getBrowser, getImplNode, getType

Methods inherited from class java.lang.Object

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

Constructor Details

Node

public Node()

Method Details

createField

protected abstract Field createField(String name,
 boolean checkEventIn)

Create a field given a name.

Parameters:

name - The name of the field to fetch

checkEventIn - true if we should check for an event in

Returns:

An instance of the field class representing the field

Throws:

InvalidEventInException - The field is not an eventIn

InvalidExposedFieldException - The field is not an exposedField

createConstField

protected abstract ConstField createConstField(String name)

Create a constant field that represents an eventOut.

Parameters:

name - The name of the field to fetch

Returns:

An instance of the field class representing the field

Throws:

InvalidEventInException - The field is not an eventOut

getExposedField

public final Field getExposedField(String fieldName)
                            throws InvalidExposedFieldException

Fetch the named exposed field from this node instance. This method will accept all forms of the set_X, X and X_changed to access the node.

Parameters:

fieldName - The name of the field to fetch

Returns:

An instance of the field class representing the field

Throws:

InvalidExposedFieldException - The field is not an exposedField or not known to this node

getEventIn

public final Field getEventIn(String fieldName)
                       throws InvalidEventInException

Fetch the named exposed field from this node instance. This method will accept all forms of the set_X, and X to access the node for the field declaration being either a real eventOut or just a portion of an exposedField.

Parameters:

fieldName - The name of the field to fetch

Returns:

An instance of the field class representing the field

Throws:

InvalidEventInException - The field is not an eventIn or not known to this node

getEventOut

public final ConstField getEventOut(String fieldName)
                             throws InvalidEventOutException

Fetch the named eventOut field from this node instance. This method will accept forms of the X and X_changed to access the node for the field declaration being either a real eventOut or just a portion of an exposedField.

Parameters:

fieldName - The name of the field to fetch

Returns:

An instance of the field class representing the field

Throws:

InvalidEventOutException - The field is not an eventOut or not known to this node