Package vrml.eai.field

Class EventOutMFString

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutMField

vrml.eai.field.EventOutMFString

Direct Known Subclasses:

EventOutMFStringWrapper

public abstract class EventOutMFString
extends EventOutMField

VRML eventOut class for MFString.

Strings are represented using standard java.lang.String representations. The implementation of this class will provide any necessary conversions to the UTF8 format required for VRML support.

Version:

1.0 30 April 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	EventOutMFString()	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract String	get1Value(int index)	Get a particular string value in the given eventOut array.
abstract String[]	getValue()	Get the value of the array of strings.
abstract void	getValue(String[] value)	Write the value of the array of the strings to the given array.

Methods inherited from class vrml.eai.field.EventOutMField

size

Methods inherited from class vrml.eai.field.EventOut

addVrmlEventListener, getUserData, removeVrmlEventListener, setUserData

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

EventOutMFString

protected EventOutMFString()

Construct an instance of this class. The superclass constructor is called with the type MFString

Method Details

getValue

public abstract String[] getValue()

Get the value of the array of strings. Individual elements in the string array may be null depending on the implementation of the browser and whether it maintains null references

Returns:

The array of strings.

See Also:

• EventInMFString.setValue(java.lang.String[])

getValue

public abstract void getValue(String[] value)

Write the value of the array of the strings to the given array. Individual elements in the string array may be null depending on the implementation of the browser and whether it maintains null references.

Parameters:

value - The string array to be filled in

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small

get1Value

public abstract String get1Value(int index)

Get a particular string value in the given eventOut array.

If the index is out of the bounds of the current array of data values an ArrayIndexOutOfBoundsException will be generated. If the array reference was null when set, an empty string will be returned to the caller.

Parameters:

index - The position to get the string value from

Returns:

The string value

Throws:

ArrayIndexOutOfBoundsException - The index value was out of bounds of the current array.

See Also:

• EventInMFString.set1Value(int, java.lang.String)