Package org.web3d.x3d.jsail

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
    CLASS_DEFAULT_VALUE
    SFString field named class for CSS has default value equal to an empty string.
    static String
    ID_DEFAULT_VALUE
    SFString field named id for html has default value equal to an empty string.
    protected static String
    NAME
    String constant NAME provides name of this element; overridden by implementing class.
    static String
    STYLE_DEFAULT_VALUE
    SFString field named style for CSS has default value equal to an empty string.
    protected StringBuilder
    validationResult
    Results log of local validation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    X3DConcreteElement()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    X3DConcreteElement
    addComments()
    Debug support: adding empty comment as CommentsBlock to children field has no effect.
    abstract X3DConcreteElement
    addComments​(String newComment)
    Add comment as String to contained commentsList.
    abstract X3DConcreteElement
    addComments​(String[] newComments)
    Add comments as String[] array to contained commentsList.
    abstract X3DConcreteElement
    addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to element
    void
    clearParent()
    Package-protected internal method to clear local reference to parent object, if any.
    X3DConcreteElement
    findAncestorElementByName​(String ancestorElementName)
    Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.
    ProtoBody
    findAncestorProtoBody()
    Find object reference to ancestor ProtoBody, if this node or statement is a child.
    Scene
    findAncestorScene()
    Find object reference to ancestor Scene element, assumes this object is an attached child.
    X3D
    findAncestorX3D()
    Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.
    abstract X3DConcreteElement
    findElementByNameValue​(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.
    abstract X3DConcreteElement
    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.
    abstract X3DConcreteNode
    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
    getComponent()
    Defines X3D component for this element.
    abstract int
    getComponentLevel()
    Provides default X3D component level for this element
    String
    getCssClass()
    Provide String value from inputOutput SFString field named class.
    String
    getCssStyle()
    Provide String value from inputOutput SFString field named style.
    abstract String
    getElementName()
    Provides name of this element.
    abstract String
    getFieldType​(String fieldName)
    Indicate type corresponding to given fieldName.
    String
    getHtmlID()
    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.
    X3DConcreteElement
    getParent()
    Provide object reference to parent X3D node or statement, if any.
    String
    getValidationResult()
    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
    hasAncestorProtoBody()
    Determine whether ancestor ProtoBody element is found, meaning this object is an attached child.
    boolean
    hasAncestorScene()
    Determine whether ancestor Scene element is found, meaning this object is an attached child.
    boolean
    hasAncestorX3D()
    Determine whether ancestor X3D element is found, meaning this object is an attached child.
    boolean
    hasParent()
    Whether parent object exists.
    void
    initialize()
    Initialize all member variables to default values.
    boolean
    isValid()
    Recursive method to determine whether this element is valid.
    protected void
    setConcreteCssClass​(String newValue)
    Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead.
    protected void
    setConcreteCssStyle​(String newValue)
    Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead.
    protected void
    setConcreteHtmlID​(String newValue)
    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.
    String
    toStringClassicVRML()
    Recursive method to provide ClassicVRML string serialization.
    abstract String
    toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    String
    toStringVRML97()
    Recursive method to provide VRML97 string serialization.
    abstract String
    toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    String
    toStringX3D()
    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
    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 java.lang.Object

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