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

Class EventInSFStringWrapper

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventIn

vrml.eai.field.EventInSFString

org.web3d.vrml.scripting.external.neteai.EventInSFStringWrapper

All Implemented Interfaces:

ExternalEvent

public class EventInSFStringWrapper
extends EventInSFString
implements ExternalEvent

Client side implementation of EventInSFString field. EventIn objects double as buffers for data inbound to the event system.

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

Constructor	Description
EventInSFStringWrapper(int fieldID, FieldAndNodeRequestProcessor requestProcessor, NetworkEventQueue eventQueue)

Method Summary

Modifier and Type	Method	Description
void	doEvent()	The EventIn*Wrapper classes implement doEvent by posting their stored values to the underlying implementation.
boolean	equals(Object other)	Two eventIn's are equal if they point to the same actual node and field
int	getFieldID()	The underlying field ID
int	getType()	The type of the underlying field.
Object	getUserData()	Get the user data that is associated with this eventIn
int	hashCode()	In order to make the event queueing system easier, and since an equals method is required by the specification, compute the hashcode based on the field number and underlying node hashcode.
boolean	isConglomerating()	Is the event conglomerating or non-conglomerating.
void	loadFieldValue(DataInputStream input)
void	setUserData(Object data)	Associate user data with this event.
void	setValue(String value)	Set the string value in the given eventIn.
void	writeFieldValue(DataOutputStream output)

Methods inherited from class vrml.eai.field.BaseField

getType

Methods inherited from class java.lang.Object

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

Constructor Details

EventInSFStringWrapper

public EventInSFStringWrapper(int fieldID,
 FieldAndNodeRequestProcessor requestProcessor,
 NetworkEventQueue eventQueue)

Parameters:

fieldID - The network field ID

requestProcessor - Handler for field services

eventQueue - The queue to send events to

Method Details

doEvent

public void doEvent()

The EventIn*Wrapper classes implement doEvent by posting their stored values to the underlying implementation.

Specified by:

doEvent in interface ExternalEvent

See Also:

• ExternalEvent.doEvent()

equals

public boolean equals(Object other)

Two eventIn's are equal if they point to the same actual node and field

Overrides:

equals in class Object

Parameters:

other - The object to compare against

getFieldID

public int getFieldID()

The underlying field ID

See Also:

• EventWrapper.getFieldID()

hashCode

public int hashCode()

In order to make the event queueing system easier, and since an equals method is required by the specification, compute the hashcode based on the field number and underlying node hashcode.

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

isConglomerating

public boolean isConglomerating()

Description copied from interface: ExternalEvent

Is the event conglomerating or non-conglomerating. Conglomerating events such as the set1Value calls build up in the event buffer.

Specified by:

isConglomerating in interface ExternalEvent

Returns:

whether event is conglomerating or not

See Also:

• ExternalEvent.isConglomerating()

setValue

public void setValue(String value)

Description copied from class: EventInSFString

Set the string value in the given eventIn.

A string is not required to be valid. A null string reference will be considered equivalent to a zero length string resulting in the string being cleared.

Specified by:

setValue in class EventInSFString

Parameters:

value - The string to set.

See Also:

• EventInSFString.setValue(java.lang.String)

setUserData

public void setUserData(Object data)

Description copied from class: EventIn

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.

Specified by:

setUserData in class EventIn

Parameters:

data - The data to associate with this eventIn instance

See Also:

• EventIn.setUserData(java.lang.Object)

getUserData

public Object getUserData()

Description copied from class: EventIn

Get the user data that is associated with this eventIn

Specified by:

getUserData in class EventIn

Returns:

* @see vrml.eai.field.EventIn#getUserData()

loadFieldValue

public void loadFieldValue(DataInputStream input)
                    throws IOException

Throws:

IOException - * @see org.web3d.vrml.scripting.external.neteai.EventWrapper#loadFieldValue(java.io.DataInputStream)

writeFieldValue

public void writeFieldValue(DataOutputStream output)
                     throws IOException

Throws:

IOException - * @see org.web3d.vrml.scripting.external.neteai.EventWrapper#writeFieldValue(java.io.DataOutputStream)

getType

int getType()

The type of the underlying field. Method name chosen to coincide with vrml.eai.field.BaseField.

Returns:

the type of the underlying field