Package vrml.eai.field

Class EventIn

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventIn

Direct Known Subclasses:

EventInMFColor, EventInMFFloat, EventInMFInt32, EventInMFNode, EventInMFRotation, EventInMFString, EventInMFTime, EventInMFVec2f, EventInMFVec3f, EventInSFBool, EventInSFColor, EventInSFFloat, EventInSFImage, EventInSFInt32, EventInSFNode, EventInSFRotation, EventInSFString, EventInSFTime, EventInSFVec2f, EventInSFVec3f

public abstract class EventIn
extends BaseField

A VRML eventIn class. Represents the VRML write only access type.

The user can associate data and also listen for events on this eventIn. These events are notified to the listener at the time that they arrive at the field. This allows the addition of extra features like monitoring a particular field for certain values being set (e.g. for debugging purposes) without having to know every single node that has a ROUTE to this eventIn.

Version:

1.0 7th March 1998

Field Summary

Fields inherited from class vrml.eai.field.BaseField

fieldType, MFColor, MFFloat, MFInt32, MFNode, MFRotation, MFString, MFTime, MFVec2f, MFVec3f, SFBool, SFColor, SFFloat, SFImage, SFInt32, SFNode, SFRotation, SFString, SFTime, SFVec2f, SFVec3f, UNSET_FIELD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventIn(int type)	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract Object	getUserData()	Get the user data that is associated with this eventIn
abstract void	setUserData(Object data)	Associate user data with this event.

Methods inherited from class vrml.eai.field.BaseField

getType

Methods inherited from class java.lang.Object

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

Constructor Details

EventIn

protected EventIn(int type)

Construct an instance of this class.

Parameters:

type - The type of the field

Method Details

setUserData

public abstract void setUserData(Object data)

Associate user data with this event. Whenever an event is generated on this eventIn. this data will be available with the Event through its getData method.

Parameters:

data - The data to associate with this eventIn instance

getUserData

public abstract Object getUserData()

Get the user data that is associated with this eventIn

Returns:

The user data, if any, associated with this eventIn