Class X3DConcreteStatement

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteStatement

Direct Known Subclasses:

CommentsBlock, component, connect, EXPORT, ExternProtoDeclare, field, fieldValue, head, IMPORT, IS, meta, ProtoBody, ProtoDeclare, ProtoInterface, ROUTE, Scene, unit, X3D

public abstract class X3DConcreteStatement
extends X3DConcreteElement

Abstract parent class for concrete X3D statements, containing common methods and member variables.

See Also:

• X3D Tooltips
• X3D Scene Authoring Hints

Field Summary

Fields inherited from class X3DConcreteElement

NAME, validationResult

Modifier and Type	Field	Description
protected static final String	NAME	String constant NAME provides name of this element; overridden by implementing class.
protected StringBuilder	validationResult	Results log of local validation.

Constructor Summary

Constructors

Constructor	Description
X3DConcreteStatement()

Method Summary

Modifier and Type	Method	Description
void	initialize()	Initialize all member variables to default values.
static final boolean	isNode()	Utility method to indicate whether this element is an X3D Graphics node (implementing X3DConcreteNode), returns false.
static final boolean	isStatement()	Utility method to indicate whether this element is an X3D Graphics statement (implementing X3DConcreteStatement), returns true.

Methods inherited from class X3DConcreteElement

addComments, addComments, addComments, addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, findElementByNameValue, findElementByNameValue, findNodeByDEF, getAccessType, getComponent, getComponentLevel, getCssClass, getCssClassDefault, getCssStyle, getCssStyleDefault, getElementName, getFieldType, getHtmlId, getHtmlIdDefault, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlId, setParent, toStringClassicVRML, toStringClassicVRML, toStringVRML97, toStringVRML97, toStringX3D, toStringX3D, validate

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.
static final String	getCssClassDefault()	Public SFString accessor for field named class for CSS has default value equal to an empty string.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
static final String	getCssStyleDefault()	Public SFString accessor for field named style for CSS has default value equal to an empty string.
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 final String	getHtmlIdDefault()	Public SFString accessor for field named id for html has default value equal to an empty string.
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.
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 Object

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

Constructor Details

X3DConcreteStatement

public X3DConcreteStatement()

Method Details

isNode

public static final boolean isNode()

Utility method to indicate whether this element is an X3D Graphics node (implementing X3DConcreteNode), returns false.

Returns:

whether this element is an X3D Graphics node: false

See Also:

• X3D Abstract Specification: 7.2.5 Abstract X3D structure
• X3D Abstract Specification, Terms and definitions: node

isStatement

public static final boolean isStatement()

Utility method to indicate whether this element is an X3D Graphics statement (implementing X3DConcreteStatement), returns true. (Does not include CommentsBlock objects.)

Returns:

whether this element is an X3D Graphics statement: true

See Also:

• CommentsBlock
• X3D Abstract Specification: 7.2.5 Abstract X3D structure

initialize

public void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteElement