Package vrml.eai

Class Node

java.lang.Object

vrml.eai.Node

Direct Known Subclasses:

EAINode, NetEAINode

public abstract class Node
extends Object

The representation of the VRML node as a java class. This is the basic node class that all nodes represent.

Version:

1.1 17th June 1998

Constructor Summary

Constructors

Constructor	Description
Node()

Method Summary

Modifier and Type	Method	Description
abstract void	dispose()	Dispose of this node's resources.
abstract EventIn	getEventIn(String name)	Get an eventIn for this node.
abstract EventOut	getEventOut(String name)	Get an eventOut for this node.
abstract String	getType()	Get the type of this node.

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

getType

public abstract String getType()
                        throws InvalidNodeException

Get the type of this node. The string returned should be the name of the VRML node or the name of the proto instance this node represents.

Returns:

The type of this node.

Throws:

InvalidNodeException - The node has had it's resources disposed of

getEventIn

public abstract EventIn getEventIn(String name)
                            throws InvalidEventInException,
InvalidNodeException

Get an eventIn for this node.

If the basic field required is an exposedField you can use either the standard name (such as translation) or you can use the set_ modifier (such as set_translation).

Parameters:

name - The name of the eventIn that is required

Returns:

A reference to the eventIn requested.

Throws:

InvalidEventInException - The named eventIn does not exist for this node.

InvalidNodeException - The node has had it's resources disposed of

getEventOut

public abstract EventOut getEventOut(String name)
                              throws InvalidEventOutException,
InvalidNodeException

Get an eventOut for this node.

If the basic field required is an exposedField you can use either the standard name (such as translation) or you can use the _changed modifier (such as translation_changed).

Parameters:

name - The name of the eventIn that is required

Returns:

A reference to the eventIn requested.

Throws:

InvalidEventOutException - The named eventIn does not exist for this node.

InvalidNodeException - The node has had it's resources disposed of

dispose

public abstract void dispose()
                      throws InvalidNodeException

Dispose of this node's resources. This is used to indicate to the browser that the java side of the application does not require the resources represented by this node. The browser is now free to do what it likes with the node.

This in no way implies that the browser is to remove this node from the scene graph, only that the java applet is no longer interested in this particular node through this reference.

Once this method has been called, any further calls to methods of this instance of the class is will generate an InvalidNodeException.

Throws:

InvalidNodeException - The node is no longer valid and can't be disposed of again.