Package vrml.eai.field

Class EventOut

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

Direct Known Subclasses:

EventOutMField, EventOutSFBool, EventOutSFColor, EventOutSFFloat, EventOutSFImage, EventOutSFInt32, EventOutSFNode, EventOutSFRotation, EventOutSFString, EventOutSFTime, EventOutSFVec2f, EventOutSFVec3f

public abstract class EventOut
extends BaseField

A VRML eventOut class. Represents the VRML read only access type.

The user can encapsulate data and associate that with this field. The user can register themselves as listeners for the output of this event changing by adding themselves as a VRMLEvent listener.

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	EventOut(int type)	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract void	addVrmlEventListener(VrmlEventListener l)	Add a listener for changes in this eventOut.
abstract Object	getUserData()	Get the user data that is associated with this eventOut
abstract void	removeVrmlEventListener(VrmlEventListener l)	Remove a listener for changes in this eventOut.
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

EventOut

protected EventOut(int type)

Construct an instance of this class.

Parameters:

type - The type of the field

Method Details

addVrmlEventListener

public abstract void addVrmlEventListener(VrmlEventListener l)

Add a listener for changes in this eventOut.

Parameters:

l - The listener to add

removeVrmlEventListener

public abstract void removeVrmlEventListener(VrmlEventListener l)

Remove a listener for changes in this eventOut.

Parameters:

l - The listener to remove

setUserData

public abstract void setUserData(Object data)

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

Parameters:

data - The data to associate with this eventOut instance

getUserData

public abstract Object getUserData()

Get the user data that is associated with this eventOut

Returns:

The user data, if any, associated with this eventOut