ProtoDeclareObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteStatement
  - - org.web3d.x3d.jsail.Core.ProtoDeclareObject

All Implemented Interfaces:

X3DChildNode, X3DNode
```
public class ProtoDeclareObject
extends X3DConcreteStatement
implements X3DChildNode
```
ProtoDeclare defines new Prototype nodes. Nested ProtoDeclares and ProtoInstances are allowed by the specification. This concrete class represents an X3D ProtoDeclare statement.

X3D statement tooltip: [X3D statement] ProtoDeclare is a Prototype Declaration, defining a new node made up of other node(s). ProtoDeclare contains ProtoInterface and ProtoBody statements.
- Hint: ProtoInterface contains field interfaces using the <field> tag, then ProtoBody contains the X3D nodes making up this prototype.
- Hint: initial scene node in a ProtoDeclare/ProtoBody statement determines this prototype's node type.
- Hint: ProtoDeclare is a definition only, add corresponding ProtoInstance nodes later in a scene to create new node instances.
- Hint: Nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare/ProtoBody.
- Warning: a ProtoInstance node may not be instantiated inside its own ProtoDeclare or ExternProtoDeclare declaration (i.e. recursive prototypes are illegal).
- Hint: X3D Scene Authoring Hints, Inlines and Prototypes
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
- Hint: X3D Architecture 7.2.5.8 PROTO statement
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#PROTOStatement
See Also:

X3D Abstract Specification: ProtoDeclare, X3D Tooltips: ProtoDeclare, X3D Scene Authoring Hints: InlinesPrototypes

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPINFO_DEFAULT_VALUE` SFString field named appinfo has default value equal to an empty string.
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the ProtoDeclare element: Core
`static java.lang.String`	`DOCUMENTATION_DEFAULT_VALUE` SFString field named documentation has default value equal to an empty string.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Core component level for this element: 2
`static java.lang.String`	`NAME` String constant NAME provides name of this element: ProtoDeclare.
`static java.lang.String`	`NAME_DEFAULT_VALUE` SFString field named name has default value equal to an empty string.

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

Constructor Summary

Constructors
Constructor and Description
`ProtoDeclareObject()` Constructor for ProtoDeclareObject to initialize member variables with default values.
`ProtoDeclareObject(java.lang.String prototypeName)` Utility constructor that assigns ProtoDeclareObject name after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ProtoDeclareObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`ProtoDeclareObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`ProtoDeclareObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`ProtoDeclareObject`	`clearProtoBody()` Utility method to clear SFNode value of ProtoBody field.
`ProtoDeclareObject`	`clearProtoInterface()` Utility method to clear SFNode value of ProtoInterface 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 in contained ProtoInterface.
`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`	`getAppinfo()` Provide String value from inputOutput SFString field named appinfo.
`java.lang.String`	`getComponent()` Defines X3D component for the ProtoDeclare element: Core
`int`	`getComponentLevel()` Provides default X3D component level for this element: 2
`java.lang.String`	`getContainerFieldDefault()` Utility method that provides default containerField value for initial node in ProtoDeclare.
`java.lang.String`	`getDocumentation()` Provide String value from inputOutput SFString field named documentation.
`java.lang.String`	`getElementName()` Provides name of this element: ProtoDeclare
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`X3DMetadataObject`	`getMetadata()` Deprecated.
`java.lang.String`	`getName()` Provide String value from inputOutput SFString field named name.
`java.lang.String`	`getNodeType()` This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody, where local copy is maintained in ProtoBody primaryNode.
`ProtoBodyObject`	`getProtoBody()` Provide ProtoBodyObject instance (using a properly typed node) from inputOutput SFNode field ProtoBody.
`ProtoInterfaceObject`	`getProtoInterface()` Provide ProtoInterfaceObject instance (using a properly typed node) from inputOutput SFNode field ProtoInterface.
`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(java.lang.String fieldName)` Determine if field statement is present in contained ProtoInterface.
`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.
`boolean`	`hasProtoBody()` Indicate whether an object is available for inputOutput SFNode field ProtoBody.
`boolean`	`hasProtoInterface()` Indicate whether an object is available for inputOutput SFNode field ProtoInterface.
`void`	`initialize()` Initialize all member variables to default values.
`ProtoDeclareObject`	`setAppinfo(SFStringObject newValue)` Assign typed object value to SFString appinfo field, similar to `setAppinfo(String)`.
`ProtoDeclareObject`	`setAppinfo(java.lang.String newValue)` Assign String value to inputOutput SFString field named appinfo.
`ProtoDeclareObject`	`setCssClass(java.lang.String newValue)` Deprecated.
`ProtoDeclareObject`	`setDEF(java.lang.String newValue)` Deprecated.
`ProtoDeclareObject`	`setDocumentation(SFStringObject newValue)` Assign typed object value to SFString documentation field, similar to `setDocumentation(String)`.
`ProtoDeclareObject`	`setDocumentation(java.lang.String newValue)` Assign String value to inputOutput SFString field named documentation.
`ProtoDeclareObject`	`setMetadata(X3DMetadataObject newValue)` Deprecated.
`ProtoDeclareObject`	`setName(SFStringObject newValue)` Assign typed object value to SFString name field, similar to `setName(String)`.
`ProtoDeclareObject`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`ProtoDeclareObject`	`setProtoBody(ProtoBodyObject newValue)` Assign ProtoBodyObject instance (using a properly typed node) to inputOutput SFNode field ProtoBody.
`ProtoDeclareObject`	`setProtoInterface(ProtoInterfaceObject newValue)` Assign ProtoInterfaceObject instance (using a properly typed node) to inputOutput SFNode field ProtoInterface.
`ProtoDeclareObject`	`setUSE(java.lang.String newValue)` Deprecated.
`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.X3DConcreteStatement
isNode, isStatement

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: ProtoDeclare.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the ProtoDeclare element: Core
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Core component level for this element: 2
    
    See Also:
    
    Constant Field Values
  - APPINFO_DEFAULT_VALUE
```
public static final java.lang.String APPINFO_DEFAULT_VALUE
```
    SFString field named appinfo has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - DOCUMENTATION_DEFAULT_VALUE
```
public static final java.lang.String DOCUMENTATION_DEFAULT_VALUE
```
    SFString field named documentation has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - NAME_DEFAULT_VALUE
```
public static final java.lang.String NAME_DEFAULT_VALUE
```
    SFString field named name has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProtoDeclareObject
```
public ProtoDeclareObject()
```
    Constructor for ProtoDeclareObject to initialize member variables with default values.
  - ProtoDeclareObject
```
public ProtoDeclareObject(java.lang.String prototypeName)
```
    Utility constructor that assigns ProtoDeclareObject name after initializing member variables with default values.
    
    Parameters:
    
    prototypeName - initial name for this ProtoDeclareObject statement
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: ProtoDeclare
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the ProtoDeclare element: Core
    
    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: 2
    
    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 statement
    
    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 statement
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteStatement
  - getAppinfo
```
public java.lang.String getAppinfo()
```
    Provide String value from inputOutput SFString field named appinfo.
    
    Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *
    
    Returns:
    
    value of appinfo field
  - setAppinfo
```
public ProtoDeclareObject setAppinfo(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named appinfo.
    
    Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag.
    
    Parameters:
    
    newValue - is new value for the appinfo field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setAppinfo
```
public ProtoDeclareObject setAppinfo(SFStringObject newValue)
```
    Assign typed object value to SFString appinfo field, similar to setAppinfo(String).
    
    Parameters:
    
    newValue - is new value for the appinfo field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDocumentation
```
public java.lang.String getDocumentation()
```
    Provide String value from inputOutput SFString field named documentation.
    
    Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *
    
    Returns:
    
    value of documentation field
  - setDocumentation
```
public ProtoDeclareObject setDocumentation(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named documentation.
    
    Tooltip: Documentation url for further information, similar to XML Schema documentation tag.
    
    Parameters:
    
    newValue - is new value for the documentation field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDocumentation
```
public ProtoDeclareObject setDocumentation(SFStringObject newValue)
```
    Assign typed object value to SFString documentation field, similar to setDocumentation(String).
    
    Parameters:
    
    newValue - is new value for the documentation field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getName
```
public java.lang.String getName()
```
    Provide String value from inputOutput SFString field named name.
    
    Tooltip: name of this prototype being declared.
    - 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
    Returns:
    
    value of name field
  - setName
```
public final ProtoDeclareObject setName(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named name.
    
    Tooltip: name of this prototype being declared. 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
    
    @see X3D Scene Authoring Hints: Naming Conventions
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setName
```
public ProtoDeclareObject setName(SFStringObject newValue)
```
    Assign typed object value to SFString name field, similar to setName(String).
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getProtoBody
```
public ProtoBodyObject getProtoBody()
```
    Provide ProtoBodyObject instance (using a properly typed node) from inputOutput SFNode field ProtoBody.
    
    Tooltip: Include one ProtoBody statements after the ProtoInterface statement. *
    
    Returns:
    
    value of ProtoBody field
  - setProtoBody
```
public ProtoDeclareObject setProtoBody(ProtoBodyObject newValue)
```
    Assign ProtoBodyObject instance (using a properly typed node) to inputOutput SFNode field ProtoBody.
    
    Tooltip: Include one ProtoBody statements after the ProtoInterface statement.
    
    Parameters:
    
    newValue - is new value for the ProtoBody field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearProtoBody
```
public ProtoDeclareObject clearProtoBody()
```
    Utility method to clear SFNode value of ProtoBody field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasProtoBody
```
public boolean hasProtoBody()
```
    Indicate whether an object is available for inputOutput SFNode field ProtoBody.
    
    Returns:
    
    whether a concrete statement or CommentsBlock is available.
    
    See Also:
    
    getProtoBody()
  - getProtoInterface
```
public ProtoInterfaceObject getProtoInterface()
```
    Provide ProtoInterfaceObject instance (using a properly typed node) from inputOutput SFNode field ProtoInterface.
    
    Tooltip: Include an optional ProtoInterface statement if this ProtoDeclare has field declarations. *
    
    Returns:
    
    value of ProtoInterface field
  - setProtoInterface
```
public ProtoDeclareObject setProtoInterface(ProtoInterfaceObject newValue)
```
    Assign ProtoInterfaceObject instance (using a properly typed node) to inputOutput SFNode field ProtoInterface.
    
    Tooltip: Include an optional ProtoInterface statement if this ProtoDeclare has field declarations.
    
    Parameters:
    
    newValue - is new value for the ProtoInterface field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearProtoInterface
```
public ProtoDeclareObject clearProtoInterface()
```
    Utility method to clear SFNode value of ProtoInterface field.
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasProtoInterface
```
public boolean hasProtoInterface()
```
    Indicate whether an object is available for inputOutput SFNode field ProtoInterface.
    
    Returns:
    
    whether a concrete statement or CommentsBlock is available.
    
    See Also:
    
    getProtoInterface()
  - getNodeType
```
public java.lang.String getNodeType()
```
    This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody, where local copy is maintained in ProtoBody primaryNode.
    
    Returns:
    
    name of X3D node corresponding to node type for this ProtoDeclareObject statement
    
    See Also:
    
    X3D Abstract Specification: 4.4.4.3 PROTO definition semantics, ProtoBodyObject.getNodeType(), ExternProtoDeclareObject.getNodeType(), ProtoInstanceObject.getNodeType(), SceneObject
  - getContainerFieldDefault
```
public java.lang.String getContainerFieldDefault()
```
    Utility method that provides default containerField value for initial node in ProtoDeclare. Hint: ProtoInstance containerField is important for determining parent-child node relationships.
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3DConcreteNode.setContainerFieldOverride(String), X3D Tooltips: ProtoInstance.containerField, X3D Scene Authoring Hints: containerField
  - findFieldByName
```
public fieldObject findFieldByName(java.lang.String fieldName)
```
    Find contained field statement by name, if present in contained ProtoInterface.
    
    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 in contained ProtoInterface.
    
    Parameters:
    
    fieldName - is name attribute for field of interest
    
    Returns:
    
    whether field is found
  - addComments
```
public ProtoDeclareObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ProtoDeclareObject 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:
    
    ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ProtoDeclareObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    ProtoDeclareObject - 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)
  - getMetadata
```
@Deprecated
public X3DMetadataObject getMetadata()
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    null, this method is deprecated and has no effect
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
@Deprecated
public ProtoDeclareObject setMetadata(X3DMetadataObject newValue)
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - ignored
    
    Returns:
    
    unmodified object, this method is deprecated and has no effect
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setDEF
```
@Deprecated
public ProtoDeclareObject setDEF(java.lang.String newValue)
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - ignored
    
    Returns:
    
    unmodified object, this method is deprecated and has no effect
  - setUSE
```
@Deprecated
public ProtoDeclareObject setUSE(java.lang.String newValue)
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - ignored
    
    Returns:
    
    unmodified object, this method is deprecated and has no effect
  - setCssClass
```
@Deprecated
public ProtoDeclareObject setCssClass(java.lang.String newValue)
```
    Deprecated.
    
    Description copied from interface: X3DChildNode
    
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DChildNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Class ProtoDeclareObject

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

APPINFO_DEFAULT_VALUE

DOCUMENTATION_DEFAULT_VALUE

NAME_DEFAULT_VALUE

Constructor Detail

ProtoDeclareObject

ProtoDeclareObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getAppinfo

setAppinfo

setAppinfo

getDocumentation

setDocumentation

setDocumentation

getName

setName

setName

getProtoBody

setProtoBody

clearProtoBody

hasProtoBody

getProtoInterface

setProtoInterface

clearProtoInterface

hasProtoInterface

getNodeType

getContainerFieldDefault

findFieldByName

hasField

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate

getMetadata

setMetadata

setDEF

setUSE

setCssClass