Package org.web3d.vrml.scripting.external.neteai

Interface FieldBroadcaster

All Known Implementing Classes:

GenericFieldBroadcaster

public interface FieldBroadcaster

FieldBroadcaster is the object responsible for turning field changed messages from the network into client side field changed events.

Method Summary

Modifier and Type	Method	Description
boolean	addVrmlEventListener(int fieldID, int fieldType, VrmlEventListener l)	Add a listener for a given field ID.
void	generateFieldBroadcast(int fieldID, DataInputStream dis)	Generate the broadcast of a field changed event for a given field ID.
Object	getUserData(int fieldID)	Get the user data associated with a field
boolean	removeVrmlEventListener(int fieldID, VrmlEventListener l)	Remove a listener for a given field ID
void	setUserData(int fieldID, Object data)	Set the user data associated with a field

Method Details

generateFieldBroadcast

void generateFieldBroadcast(int fieldID,
 DataInputStream dis)
                     throws IOException

Generate the broadcast of a field changed event for a given field ID. Reads the field value off the network and then adds the field to the work list.

Parameters:

fieldID - The network ID of the field which changed

dis - The input stream to read the field value from

Throws:

IOException

removeVrmlEventListener

boolean removeVrmlEventListener(int fieldID,
 VrmlEventListener l)

Remove a listener for a given field ID

Parameters:

fieldID - The network field ID to remove a listener from

l - The listener for the field

Returns:

Was that the last listener for this field ID?

addVrmlEventListener

boolean addVrmlEventListener(int fieldID,
 int fieldType,
 VrmlEventListener l)

Add a listener for a given field ID. Need to specify the field type so that the broadcast system knows what to generate.

Parameters:

fieldID - The network field ID to add a listener for

fieldType - The type of the field

l - The listener for the field

Returns:

Was that the first listener for this field ID?

getUserData

Object getUserData(int fieldID)

Get the user data associated with a field

Parameters:

fieldID - The network ID of the field

Returns:

The user data associated with the field

setUserData

void setUserData(int fieldID,
 Object data)

Set the user data associated with a field

Parameters:

fieldID - The network ID of the field

data - The user data associated the the field