Class X3DConcreteElement

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
Direct Known Subclasses:
X3DConcreteNode, X3DConcreteStatement

public abstract class X3DConcreteElement extends Object
Topmost abstract parent class for concrete X3D nodes and statements, containing common methods and member variables.

See Also:
X3D Tooltips, X3D Scene Authoring Hints
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
    SFString field named class for CSS has default value equal to an empty string.
    static String
    SFString field named id for html has default value equal to an empty string.
    protected static String
    String constant NAME provides name of this element; overridden by implementing class.
    static String
    SFString field named style for CSS has default value equal to an empty string.
    protected StringBuilder
    Results log of local validation.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Debug support: adding empty comment as CommentsBlock to children field has no effect.
    addComments​(String newComment)
    Add comment as String to contained commentsList.
    addComments​(String[] newComments)
    Add comments as String[] array to contained commentsList.
    addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to element
    void
    Package-protected internal method to clear local reference to parent object, if any.
    findAncestorElementByName​(String ancestorElementName)
    Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.
    Find object reference to ancestor ProtoBody, if this node or statement is a child.
    Find object reference to ancestor Scene element, assumes this object is an attached child.
    Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.
    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.
    findElementByNameValue​(String nameValue, 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.
    findNodeByDEF​(String DEFvalue)
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    abstract String
    getAccessType​(String fieldName)
    Indicate accessType corresponding to given fieldName.
    abstract String
    Defines X3D component for this element.
    abstract int
    Provides default X3D component level for this element
    Provide String value from inputOutput SFString field named class.
    Provide String value from inputOutput SFString field named style.
    abstract String
    Provides name of this element.
    abstract String
    getFieldType​(String fieldName)
    Indicate type corresponding to given fieldName.
    Provide String value from inputOutput SFString field named id.
    static String
    getPackageName​(String className)
    Provide fully qualified package for a given element object, including className.
    Provide object reference to parent X3D node or statement, if any.
    Get output of results from prior validation, if any
    boolean
    hasAncestorElementByName​(String ancestorElementName)
    Determine whether ancestor element (i.e. node or statement) is found, meaning this object is an attached child.
    boolean
    Determine whether ancestor ProtoBody element is found, meaning this object is an attached child.
    boolean
    Determine whether ancestor Scene element is found, meaning this object is an attached child.
    boolean
    Determine whether ancestor X3D element is found, meaning this object is an attached child.
    boolean
    Whether parent object exists.
    void
    Initialize all member variables to default values.
    boolean
    Recursive method to determine whether this element is valid.
    protected void
    Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead.
    protected void
    Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead.
    protected void
    Protected internal superclass method to keep HTML id private, scene authors should use method setHtmlID(newValue) instead.
    void
    setParent​(X3DConcreteElement newParentObject)
    Package-internal method to set parent object reference.
    Recursive method to provide ClassicVRML string serialization.
    abstract String
    toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    Recursive method to provide VRML97 string serialization.
    abstract String
    toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    abstract String
    toStringX3D​(int indentLevel)
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    abstract String
    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 java.lang.Object

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