org.web3d.x3d.sai

Interface MFString

All Superinterfaces:

MField, X3DField

All Known Implementing Classes:

MFStringObject

public interface MFString
extends MField

MFString is an array of SFString values, each "quoted" and separated by whitespace. Individual SFString array values are optionally separated by commas.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: B.4.34, SAI Abstract Specification: SAIString, X3D Abstract Specification: 5.3.14 SFString and MFString, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String newValue) Places a new value at the end of the existing value array, increasing the field length accordingly.
java.lang.String	get1Value(int index) Get an individual value from the existing field array.
void	getValue(java.lang.String[] valueDestination) Write out the current value of this field into the external valueDestination array.
void	insertValue(int index, java.lang.String newValue) Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
void	set1Value(int index, java.lang.String newValue) Replace a single value at the appropriate location in the existing value array.
void	setValue(int numStrings, java.lang.String[] newValue) Assign a new value to this field.

Methods inherited from interface org.web3d.x3d.sai.MField

clear, remove, size

Methods inherited from interface org.web3d.x3d.sai.X3DField

addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener

Method Detail

getValue

void getValue(java.lang.String[] valueDestination)

Write out the current value of this field into the external valueDestination array.

Parameters:

valueDestination - The array to be filled in with current field values.

Throws:

java.lang.ArrayIndexOutOfBoundsException - The provided valueDestination array was too small.

get1Value

java.lang.String get1Value(int index)

Get an individual value from the existing field array.

If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

Parameters:

index - is position of selected value in current array

Returns:

The selected value

Throws:

java.lang.ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.

setValue

void setValue(int numStrings,
              java.lang.String[] newValue)

Assign a new value to this field.

Parameters:

numStrings - The number of strings in the newValue array

newValue - The newValue array of strings to set

set1Value

void set1Value(int index,
               java.lang.String newValue)

Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.

Parameters:

index - is position of selected value in current array

newValue - provides new value to apply

append

void append(java.lang.String newValue)

Places a new value at the end of the existing value array, increasing the field length accordingly.

Parameters:

newValue - The newValue to append

insertValue

void insertValue(int index,
                 java.lang.String newValue)

Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.

Parameters:

index - The position for the inserted value in the current array

newValue - The newValue to insert