ScriptObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Scripting.ScriptObject

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DUrlObject, Script, X3DScriptNode
```
public class ScriptObject
extends X3DConcreteNode
implements Script
```
X3D node tooltip: [X3DScriptNode] Script contains author-programmed event behaviors for a scene. Define the script input-output event interface by including <field/> elements. Scripting code is embedded in a child CDATA node or (deprecated) in the url field. Optionally supported programming languages are ECMAScript (JavaScript) and Java (via url to a myNode.class file).
- Hint: insert a CDATA block to contain source code embedded within an X3D scene.
- Hint: a contained CDATA block for source code protects whitespace, line breaks, and literal characters (such as & for ampersand character, < for less-than-sign character, and > for greater-than-sign character) from unintended escape-character modifications by XML parsers.
- Warning: strict order is required for contained constructs: first field declarations (if any), then IS/connect statements (if any), and finally CDATA source-code block.
- Hint: X3D Scene Authoring Hints, Scripts
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
- Hint: apply containerField='watchList' when parent node is LoadSensor.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: Script, X3D Tooltips: Script, X3D Scene Authoring Hints: Scripts

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the Script element: Scripting
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static boolean`	`DIRECTOUTPUT_DEFAULT_VALUE` SFBool field named directOutput has default value false (Java syntax) or false (XML syntax).
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_URL` fromField ROUTE name for MFString field named url.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Scripting component level for this element: 1
`static boolean`	`MUSTEVALUATE_DEFAULT_VALUE` SFBool field named mustEvaluate has default value false (Java syntax) or false (XML syntax).
`static java.lang.String`	`NAME` String constant NAME provides name of this element: Script.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_URL` toField ROUTE name for MFString field named url.
`static java.util.ArrayList<java.lang.String>`	`URL_DEFAULT_VALUE` MFString field named url has default value equal to an empty list.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`ScriptObject()` Constructor for ScriptObject to initialize member variables with default values.
`ScriptObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScriptObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`ScriptObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`ScriptObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`ScriptObject`	`addField(fieldObject newField)` Add field to fieldList for this ScriptObject
`ScriptObject`	`addUrl(SFStringObject newValue)` Add singleton SFStringObject value to MFString url field.
`ScriptObject`	`addUrl(java.lang.String newValue)` Add singleton String value to MFString url field.
`ScriptObject`	`appendSourceCode(java.lang.String newSourceText)` Append source code (for example, JavaScript)
`ScriptObject`	`appendSourceCode(java.lang.StringBuilder newSourceText)` Append source code (for example, JavaScript)
`void`	`clearFields()` Clear all fields
`ScriptObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`ScriptObject`	`clearSource()` Clear all contained CDATA source code.
`ScriptObject`	`clearUrl()` Utility method to clear MFString value of url field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`fieldObject`	`findFieldByName(java.lang.String fieldName)` Find contained field statement by name, if present.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getComponent()` Defines X3D component for the Script element: Scripting
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`boolean`	`getDirectOutput()` Provide boolean value from initializeOnly SFBool field named directOutput.
`java.lang.String`	`getElementName()` Provides name of this element: Script
`java.util.ArrayList<fieldObject>`	`getFieldList()` Provide list of fields.
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`boolean`	`getMustEvaluate()` Provide boolean value from initializeOnly SFBool field named mustEvaluate.
`java.lang.String[]`	`getUrl()` Provide array of String results from inputOutput MFString field named url.
`java.util.ArrayList<java.lang.String>`	`getUrlList()` Utility method to get ArrayList value of MFString url field, similar to `getUrl()`.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasField()` Determine whether field(s) are available
`boolean`	`hasField(java.lang.String fieldName)` Determine if field statement is present.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`boolean`	`removeField(fieldObject fieldToRemove)` Remove a field from contained fieldList
`boolean`	`removeField(java.lang.String fieldName)` Remove a field by name from contained fieldList
`ScriptObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`ScriptObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ScriptObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`ScriptObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ScriptObject`	`setDirectOutput(boolean newValue)` Assign boolean value to initializeOnly SFBool field named directOutput.
`ScriptObject`	`setDirectOutput(SFBoolObject newValue)` Assign typed object value to SFBool directOutput field, similar to `setDirectOutput(boolean)`.
`ScriptObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`ScriptObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`ScriptObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ScriptObject`	`setMustEvaluate(boolean newValue)` Assign boolean value to initializeOnly SFBool field named mustEvaluate.
`ScriptObject`	`setMustEvaluate(SFBoolObject newValue)` Assign typed object value to SFBool mustEvaluate field, similar to `setMustEvaluate(boolean)`.
`ScriptObject`	`setSourceCode(java.lang.String newSourceText)` Set new source code (for example, JavaScript).
`ScriptObject`	`setSourceCode(java.lang.String[] newSourceText)` Set new source code (for example, JavaScript).
`ScriptObject`	`setSourceCode(java.lang.StringBuilder newSourceText)` Set new source code (for example, JavaScript).
`ScriptObject`	`setUrl(java.util.ArrayList<java.lang.String> newValue)` Assign ArrayList value of MFString url field, similar to `setUrl(String[])`.
`ScriptObject`	`setUrl(MFStringObject newValue)` Assign typed object value to MFString url field, similar to `setUrl(String[])`.
`ScriptObject`	`setUrl(SFStringObject newValue)` Assign single SFString object value to MFString url field, similar to `setUrl(String[])`.
`ScriptObject`	`setUrl(java.lang.String newValue)` Assign singleton String value to MFString url field, similar to `setUrl(String[])`.
`ScriptObject`	`setUrl(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named url.
`ScriptObject`	`setUSE(ScriptObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`ScriptObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`ScriptObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: Script.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the Script element: Scripting
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Scripting component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - DIRECTOUTPUT_DEFAULT_VALUE
```
public static final boolean DIRECTOUTPUT_DEFAULT_VALUE
```
    SFBool field named directOutput has default value false (Java syntax) or false (XML syntax).
    
    See Also:
    
    Constant Field Values
  - MUSTEVALUATE_DEFAULT_VALUE
```
public static final boolean MUSTEVALUATE_DEFAULT_VALUE
```
    SFBool field named mustEvaluate has default value false (Java syntax) or false (XML syntax).
    
    See Also:
    
    Constant Field Values
  - URL_DEFAULT_VALUE
```
public static final java.util.ArrayList<java.lang.String> URL_DEFAULT_VALUE
```
    MFString field named url has default value equal to an empty list.
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_URL
```
public static final java.lang.String fromField_URL
```
    fromField ROUTE name for MFString field named url.
    
    See Also:
    
    Constant Field Values
  - toField_URL
```
public static final java.lang.String toField_URL
```
    toField ROUTE name for MFString field named url.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ScriptObject
```
public ScriptObject()
```
    Constructor for ScriptObject to initialize member variables with default values.
  - ScriptObject
```
public ScriptObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: Script
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the Script element: Scripting
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getDirectOutput
```
public boolean getDirectOutput()
```
    Provide boolean value from initializeOnly SFBool field named directOutput.
    
    Tooltip: Set directOutput true if Script has field reference(s) of type SFNode/MFNode, and also uses direct access to modify attributes of a referenced node in the Scene.
    - Hint: set directOutput true if Script dynamically establishes or breaks ROUTEs.
    - Hint: directOutput is a browser hint to avoid overoptimizing referenced nodes, since a Script might directly change attribute values in referenced SFNode/MFNode fields, without a ROUTE connecting output events.
    - Hint: directOutput false means Script cannot modify referenced nodes or change ROUTEs.
    Specified by:
    
    getDirectOutput in interface Script
    
    Returns:
    
    value of directOutput field
  - setDirectOutput
```
public ScriptObject setDirectOutput(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named directOutput.
    
    Tooltip: Set directOutput true if Script has field reference(s) of type SFNode/MFNode, and also uses direct access to modify attributes of a referenced node in the Scene. Hint: set directOutput true if Script dynamically establishes or breaks ROUTEs. Hint: directOutput is a browser hint to avoid overoptimizing referenced nodes, since a Script might directly change attribute values in referenced SFNode/MFNode fields, without a ROUTE connecting output events. Hint: directOutput false means Script cannot modify referenced nodes or change ROUTEs.
    
    Specified by:
    
    setDirectOutput in interface Script
    
    Parameters:
    
    newValue - is new value for the directOutput field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDirectOutput
```
public ScriptObject setDirectOutput(SFBoolObject newValue)
```
    Assign typed object value to SFBool directOutput field, similar to setDirectOutput(boolean).
    
    Parameters:
    
    newValue - is new value for the directOutput field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface Script
    
    Specified by:
    
    getMetadata in interface X3DScriptNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public ScriptObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface Script
    
    Specified by:
    
    setMetadata in interface X3DScriptNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public ScriptObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public ScriptObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getMustEvaluate
```
public boolean getMustEvaluate()
```
    Provide boolean value from initializeOnly SFBool field named mustEvaluate.
    
    Tooltip: If mustEvaluate false, then the X3D player may delay sending input events to Script until output events are needed. If mustEvaluate true, then Script must receive input events immediately without any event-aggregation delays.
    - Hint: set mustEvaluate true when sending/receiving values via the network.
    Specified by:
    
    getMustEvaluate in interface Script
    
    Returns:
    
    value of mustEvaluate field
  - setMustEvaluate
```
public ScriptObject setMustEvaluate(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named mustEvaluate.
    
    Tooltip: If mustEvaluate false, then the X3D player may delay sending input events to Script until output events are needed. If mustEvaluate true, then Script must receive input events immediately without any event-aggregation delays. Hint: set mustEvaluate true when sending/receiving values via the network.
    
    Specified by:
    
    setMustEvaluate in interface Script
    
    Parameters:
    
    newValue - is new value for the mustEvaluate field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setMustEvaluate
```
public ScriptObject setMustEvaluate(SFBoolObject newValue)
```
    Assign typed object value to SFBool mustEvaluate field, similar to setMustEvaluate(boolean).
    
    Parameters:
    
    newValue - is new value for the mustEvaluate field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getUrl
```
public java.lang.String[] getUrl()
```
    Provide array of String results from inputOutput MFString field named url.
    
    Tooltip: List of address links for runnable script files.
    - Hint: browsers are not required to support any particular scripting language, but ECMAScript (JavaScript) is widely supported.
    - Hint: equivalent script code written in multiple programming languages can be provided for portability, the first runnable version is chosen at run time.
    - Hint: X3D Scene Authoring Hints, Scripts
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
    - Warning: source code can be placed in url attribute but may be unparsable due to escaping of special characters and elimination of line breaks (causing comments to nullify follow-on code). Use contained CDATA section instead for embedding source code.
    - Hint: if both url field and CDATA section are provided simultaneously, the url field is processed first. This approach allows utilization of update modifications or live queries in external scripts, while still providing reliable script source as a fallback alternative within the model itself.
    - Hint: X3D XML Encoding, 4.3.13 Encapsulating Script node code
      http://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#EncapsulatingScriptNodeCode
    - Hint: MFString arrays can have multiple values, so separate each individual string by quote marks
      "http://www.web3d.org"
      "http://www.web3d.org/about" "etc."
    - Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
    - Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
    - Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
    - Hint: X3D Scene Authoring Hints, urls
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    Specified by:
    
    getUrl in interface X3DUrlObject
    
    Specified by:
    
    getUrl in interface Script
    
    Specified by:
    
    getUrl in interface X3DScriptNode
    
    Returns:
    
    value of url field
  - getUrlList
```
public java.util.ArrayList<java.lang.String> getUrlList()
```
    Utility method to get ArrayList value of MFString url field, similar to getUrl().
    
    Returns:
    
    value of url field
  - setUrl
```
public ScriptObject setUrl(java.lang.String[] newValue)
```
    Assign String array to inputOutput MFString field named url.
    
    Tooltip: List of address links for runnable script files. Hint: browsers are not required to support any particular scripting language, but ECMAScript (JavaScript) is widely supported. Hint: equivalent script code written in multiple programming languages can be provided for portability, the first runnable version is chosen at run time. Hint: X3D Scene Authoring Hints, Scripts http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts Warning: source code can be placed in url attribute but may be unparsable due to escaping of special characters and elimination of line breaks (causing comments to nullify follow-on code). Use contained CDATA section instead for embedding source code. Hint: if both url field and CDATA section are provided simultaneously, the url field is processed first. This approach allows utilization of update modifications or live queries in external scripts, while still providing reliable script source as a fallback alternative within the model itself. Hint: X3D XML Encoding, 4.3.13 Encapsulating Script node code http://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#EncapsulatingScriptNodeCode Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity). Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches. Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    
    Specified by:
    
    setUrl in interface X3DUrlObject
    
    Specified by:
    
    setUrl in interface Script
    
    Specified by:
    
    setUrl in interface X3DScriptNode
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUrl
```
public ScriptObject setUrl(MFStringObject newValue)
```
    Assign typed object value to MFString url field, similar to setUrl(String[]).
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUrl
```
public ScriptObject setUrl(SFStringObject newValue)
```
    Assign single SFString object value to MFString url field, similar to setUrl(String[]).
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUrl
```
public ScriptObject setUrl(java.lang.String newValue)
```
    Assign singleton String value to MFString url field, similar to setUrl(String[]).
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUrl
```
public ScriptObject setUrl(java.util.ArrayList<java.lang.String> newValue)
```
    Assign ArrayList value of MFString url field, similar to setUrl(String[]).
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearUrl
```
public ScriptObject clearUrl()
```
    Utility method to clear MFString value of url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addUrl
```
public ScriptObject addUrl(java.lang.String newValue)
```
    Add singleton String value to MFString url field.
    
    Parameters:
    
    newValue - is new value to add to the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    MFStringObject.cleanupEnumerationValues(String)
  - addUrl
```
public ScriptObject addUrl(SFStringObject newValue)
```
    Add singleton SFStringObject value to MFString url field.
    
    Parameters:
    
    newValue - is new value to add to the url field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    MFStringObject.cleanupEnumerationValues(String)
  - setDEF
```
public final ScriptObject setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: DEF name is needed or else ROUTEs cannot connect Script node interfaces. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface Script
    
    Specified by:
    
    setDEF in interface X3DScriptNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public ScriptObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final ScriptObject setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface Script
    
    Specified by:
    
    setUSE in interface X3DScriptNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public ScriptObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final ScriptObject setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface Script
    
    Specified by:
    
    setCssClass in interface X3DScriptNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public ScriptObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public ScriptObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public ScriptObject setUSE(ScriptObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public ScriptObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ScriptObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ScriptObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)
  - addField
```
public ScriptObject addField(fieldObject newField)
```
    Add field to fieldList for this ScriptObject
    
    Parameters:
    
    newField - is field to add
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - removeField
```
public boolean removeField(fieldObject fieldToRemove)
```
    Remove a field from contained fieldList
    
    Parameters:
    
    fieldToRemove - matching field of interest
    
    Returns:
    
    whether field was removed
    
    See Also:
    
    removeField(String)
  - removeField
```
public boolean removeField(java.lang.String fieldName)
```
    Remove a field by name from contained fieldList
    
    Parameters:
    
    fieldName - matching field of interest
    
    Returns:
    
    whether field was removed
    
    See Also:
    
    removeField(fieldObject)
  - clearFields
```
public void clearFields()
```
    Clear all fields
  - hasField
```
public boolean hasField()
```
    Determine whether field(s) are available
    
    Returns:
    
    whether field(s) are found
  - getFieldList
```
public java.util.ArrayList<fieldObject> getFieldList()
```
    Provide list of fields.
    
    Returns:
    
    value of field list
  - findFieldByName
```
public fieldObject findFieldByName(java.lang.String fieldName)
```
    Find contained field statement by name, if present.
    
    Parameters:
    
    fieldName - is name attribute for field of interest
    
    Returns:
    
    fieldObject reference of interest, null otherwise
  - hasField
```
public boolean hasField(java.lang.String fieldName)
```
    Determine if field statement is present.
    
    Parameters:
    
    fieldName - is name attribute for field of interest
    
    Returns:
    
    whether field is found
  - setSourceCode
```
public ScriptObject setSourceCode(java.lang.String[] newSourceText)
```
    Set new source code (for example, JavaScript). WARNING: be sure to prepend ecmascript: prior to any actual source code.
    
    Parameters:
    
    newSourceText - is source code to set
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setSourceCode
```
public ScriptObject setSourceCode(java.lang.String newSourceText)
```
    Set new source code (for example, JavaScript). WARNING: be sure to prepend ecmascript: prior to any actual source code.
    
    Parameters:
    
    newSourceText - is source code to set
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    X3D Scene Authoring Hints: CDATA Character Data
  - setSourceCode
```
public ScriptObject setSourceCode(java.lang.StringBuilder newSourceText)
```
    Set new source code (for example, JavaScript). WARNING: be sure to prepend ecmascript: prior to any actual source code.
    
    Parameters:
    
    newSourceText - is source to set
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - appendSourceCode
```
public ScriptObject appendSourceCode(java.lang.String newSourceText)
```
    Append source code (for example, JavaScript)
    
    Parameters:
    
    newSourceText - is source to append
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - appendSourceCode
```
public ScriptObject appendSourceCode(java.lang.StringBuilder newSourceText)
```
    Append source code (for example, JavaScript)
    
    Parameters:
    
    newSourceText - is source to append
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - clearSource
```
public ScriptObject clearSource()
```
    Clear all contained CDATA source code.
    
    Returns:
    
    ScriptObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

Class ScriptObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

DIRECTOUTPUT_DEFAULT_VALUE

MUSTEVALUATE_DEFAULT_VALUE

URL_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_METADATA

toField_METADATA

fromField_URL

toField_URL

Constructor Detail

ScriptObject

ScriptObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getDirectOutput

setDirectOutput

setDirectOutput

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getMustEvaluate

setMustEvaluate

setMustEvaluate

getUrl

getUrlList

setUrl

setUrl

setUrl

setUrl

setUrl

clearUrl

addUrl

addUrl

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate

addField

removeField

removeField

clearFields

hasField

getFieldList