Package vrml.node

Class Script

java.lang.Object

vrml.BaseNode

vrml.node.Script

public abstract class Script
extends BaseNode

This is the general Script class, to be subclassed by all scripts. Note that the provided methods allow the script author to explicitly throw tailored exceptions in case something goes wrong in the script.

Version:

$Revision: 1.8 $

Author:

Alan Hudson

Field Summary

Fields inherited from class vrml.BaseNode

browser, nodeName, realNode

Constructor Summary

Constructors

Constructor	Description
Script()

Method Summary

Modifier and Type	Method	Description
void	eventsProcessed()	Called after every invocation of processEvents()
protected final Field	getEventIn(String fieldName)	Get an EventIn by name.
protected final Field	getEventOut(String fieldName)	Get an EventOut by name.
protected final Field	getField(String fieldName)	Get a Field by name.
void	initialize()	Called before any event is generated
void	prepareScript(Browser b, Map<String,Field> fields, VRMLNodeType node)	Prepare the script for execution.
void	processEvent(Event event)	Called when there is an Event to be processed
void	processEvents(int count, Event[] events)	Called automatically when the script receives some set of events.
void	shutdown()	Called when the Script node is deleted.

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

Script

public Script()

Method Details

prepareScript

public void prepareScript(Browser b,
 Map<String,Field> fields,
 VRMLNodeType node)

Prepare the script for execution. Should never be called by user code. belongs to a local usage only.

Parameters:

b - The browser reference to use

fields - The mapping of field names to JSAI field instances

node - The real node representing this script

getField

protected final Field getField(String fieldName)
                        throws InvalidFieldException

Get a Field by name.

Parameters:

fieldName - The requested field

Returns:

Throws:

InvalidFieldException - if fieldName isn't a valid field name

getEventOut

protected final Field getEventOut(String fieldName)
                           throws InvalidEventOutException

Get an EventOut by name.

Parameters:

fieldName - The requested eventOut

Returns:

Throws:

InvalidEventOutException - if fieldName isn't a valid name

getEventIn

protected final Field getEventIn(String fieldName)
                          throws InvalidEventInException

Get an EventIn by name.

Parameters:

fieldName - The requested eventIn

Returns:

Throws:

InvalidEventInException - if fieldName isn't a valid name

initialize

public void initialize()

Called before any event is generated

processEvents

public void processEvents(int count,
 Event[] events)

Called automatically when the script receives some set of events. It shall not be called directly except by its subclass.

Parameters:

count - indicates the number of events delivered.

events - The events to process

processEvent

public void processEvent(Event event)

Called when there is an Event to be processed

Parameters:

event - The event to process

eventsProcessed

public void eventsProcessed()

Called after every invocation of processEvents()

shutdown

public void shutdown()

Called when the Script node is deleted.