java.lang.Object

org.web3d.x3d.jsail.Layout.LayoutLayerObject

All Implemented Interfaces:: X3DNode, X3DLayerNode, LayoutLayer, X3DPickableObject

public class LayoutLayerObject
extends X3DConcreteNode
implements LayoutLayer

LayoutLayer is a Grouping node that can contain most nodes.

X3D node tooltip: (X3D version 3.2 or later) [X3DLayerNode] LayoutLayer is a Grouping node that can contain most nodes. LayoutLayer content is clipped by the specified viewport node.

Hint: insert a Shape node before adding geometry or Appearance.
Warning: better functional description needed in X3D specification.

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: LayoutLayer, X3D Tooltips: LayoutLayer, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`COMPONENT`	String constant COMPONENT defines X3D component for the LayoutLayer element: Layout
`static java.lang.String`	`containerField_DEFAULT_VALUE`	containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_CHILDREN`	fromField ROUTE name for MFNode field named children.
`static java.lang.String`	`fromField_IS`	fromField ROUTE name for SFNode field named IS.
`static java.lang.String`	`fromField_LAYOUT`	fromField ROUTE name for SFNode field named layout.
`static java.lang.String`	`fromField_METADATA`	fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_OBJECTTYPE`	fromField ROUTE name for MFString field named objectType.
`static java.lang.String`	`fromField_PICKABLE`	fromField ROUTE name for SFBool field named pickable.
`static java.lang.String`	`fromField_VIEWPORT`	fromField ROUTE name for SFNode field named viewport.
`static java.lang.String`	`fromField_VISIBLE`	fromField ROUTE name for SFBool field named visible.
`static ISObject`	`IS_DEFAULT_VALUE`	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
`static X3DLayoutNode`	`LAYOUT_DEFAULT_VALUE`	SFNode field named layout has default value null (Java syntax) or NULL (XML syntax).
`static int`	`LEVEL`	Integer constant LEVEL provides default X3D Layout component level for this element: 1
`static X3DMetadataObject`	`METADATA_DEFAULT_VALUE`	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
`static java.lang.String`	`NAME`	String constant NAME provides name of this element: LayoutLayer.
`static java.lang.String`	`OBJECTTYPE_ALL`	MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).
`static java.util.ArrayList<java.lang.String>`	`OBJECTTYPE_DEFAULT_VALUE`	MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).
`static java.lang.String`	`OBJECTTYPE_NONE`	MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).
`static java.lang.String`	`OBJECTTYPE_TERRAIN`	MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and also may include alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).
`static boolean`	`PICKABLE_DEFAULT_VALUE`	SFBool field named pickable has default value true (Java syntax) or true (XML syntax).
`static java.util.ArrayList<java.lang.String>`	`pickableObjectTypeValues`	List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
`static java.lang.String`	`toField_ADDCHILDREN`	toField ROUTE name for MFNode field named addChildren.
`static java.lang.String`	`toField_CHILDREN`	toField ROUTE name for MFNode field named children.
`static java.lang.String`	`toField_LAYOUT`	toField ROUTE name for SFNode field named layout.
`static java.lang.String`	`toField_METADATA`	toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_OBJECTTYPE`	toField ROUTE name for MFString field named objectType.
`static java.lang.String`	`toField_PICKABLE`	toField ROUTE name for SFBool field named pickable.
`static java.lang.String`	`toField_REMOVECHILDREN`	toField ROUTE name for MFNode field named removeChildren.
`static java.lang.String`	`toField_VIEWPORT`	toField ROUTE name for SFNode field named viewport.
`static java.lang.String`	`toField_VISIBLE`	toField ROUTE name for SFBool field named visible.
`static X3DViewportNode`	`VIEWPORT_DEFAULT_VALUE`	SFNode field named viewport has default value null (Java syntax) or NULL (XML syntax).
`static boolean`	`VISIBLE_DEFAULT_VALUE`	SFBool field named visible has default value true (Java syntax) or true (XML syntax).

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	Description
`LayoutLayerObject()`	Constructor for LayoutLayerObject to initialize member variables with default values.
`LayoutLayerObject(java.lang.String DEFlabel)`	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
`LayoutLayerObject`	`addChild(X3DChildNode newValue)`	Utility method to add single child element to contained list of existing children nodes (if any).
`LayoutLayerObject`	`addChildren(ProtoInstanceObject newValue)`	Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.
`void`	`addChildren(X3DNode newValue)`	Add single node to existing array of children nodes (if any).
`void`	`addChildren(X3DNode[] newValue)`	Add array of children nodes to array of existing nodes (if any).
`LayoutLayerObject`	`addComments(java.lang.String newComment)`	Add comment as CommentsBlock to children field
`LayoutLayerObject`	`addComments(java.lang.String[] newComments)`	Add comments as String[] array to children field
`LayoutLayerObject`	`addComments(CommentsBlock newCommentsBlock)`	Add CommentsBlock to children field
`LayoutLayerObject`	`addObjectType(java.lang.String newValue)`	Add singleton String value to MFString objectType field.
`LayoutLayerObject`	`addObjectType(SFStringObject newValue)`	Add singleton SFStringObject value to MFString objectType field.
`LayoutLayerObject`	`clearChildren()`	Utility method to clear MFNode value of children field.
`LayoutLayerObject`	`clearIS()`	Utility method to clear SFNode value of IS field.
`LayoutLayerObject`	`clearLayout()`	Utility method to clear SFNode value of layout field.
`LayoutLayerObject`	`clearMetadata()`	Utility method to clear SFNode value of metadata field.
`LayoutLayerObject`	`clearObjectType()`	Utility method to clear MFString value of objectType field.
`LayoutLayerObject`	`clearViewport()`	Utility method to clear SFNode value of viewport 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.
`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.
`X3DNode[]`	`getChildren()`	Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
`java.util.ArrayList<X3DNode>`	`getChildrenList()`	Utility method to get ArrayList value of MFNode children field, similar to `getChildren()`.
`java.lang.String`	`getComponent()`	Defines X3D component for the LayoutLayer element: Layout
`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.
`java.lang.String`	`getCssClass()`	Provide String value from inputOutput SFString field named class.
`java.lang.String`	`getDEF()`	Provide String value from inputOutput SFString field named DEF.
`java.lang.String`	`getElementName()`	Provides name of this element: LayoutLayer
`java.lang.String`	`getFieldType(java.lang.String fieldName)`	Indicate type corresponding to given fieldName.
`ISObject`	`getIS()`	Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
`X3DLayoutNode`	`getLayout()`	Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
`X3DMetadataObject`	`getMetadata()`	Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String[]`	`getObjectType()`	Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
`java.util.ArrayList<java.lang.String>`	`getObjectTypeList()`	Utility method to get ArrayList value of MFString objectType field, similar to `getObjectType()`.
`java.lang.String`	`getObjectTypeString()`	Utility method to get String value of MFString objectType field, similar to `getObjectType()`.
`boolean`	`getPickable()`	Provide boolean value from inputOutput SFBool field named pickable.
`java.lang.String`	`getUSE()`	Provide String value from inputOutput SFString field named USE.
`X3DViewportNode`	`getViewport()`	Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
`boolean`	`getVisible()`	Provide boolean value from inputOutput SFBool field named visible.
`boolean`	`hasChildren()`	Indicate whether an object is available for inputOutput MFNode field children.
`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`	`hasIS()`	Indicate whether an object is available for inputOutput SFNode field IS.
`boolean`	`hasLayout()`	Indicate whether an object is available for inputOutput SFNode field layout.
`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.
`boolean`	`hasViewport()`	Indicate whether an object is available for inputOutput SFNode field viewport.
`void`	`initialize()`	Initialize all member variables to default values.
`LayoutLayerObject`	`setChildren(java.util.ArrayList<X3DChildNode> newValue)`	Assign ArrayList value of MFNode children field, similar to `setChildren(X3DNode[])`.
`void`	`setChildren(X3DNode newValue)`	Set single children node, replacing prior array of existing nodes (if any).
`LayoutLayerObject`	`setChildren(X3DNode[] newValue)`	Accessor method to assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
`LayoutLayerObject`	`setCssClass(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named class.
`LayoutLayerObject`	`setCssClass(SFStringObject newValue)`	Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`LayoutLayerObject`	`setDEF(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named DEF.
`LayoutLayerObject`	`setDEF(SFStringObject newValue)`	Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`LayoutLayerObject`	`setIS(ISObject newValue)`	Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
`LayoutLayerObject`	`setLayout(ProtoInstanceObject newValue)`	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field layout.
`LayoutLayerObject`	`setLayout(X3DLayoutNode newValue)`	Accessor method to assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
`LayoutLayerObject`	`setMetadata(ProtoInstanceObject newValue)`	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`LayoutLayerObject`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LayoutLayerObject`	`setObjectType(java.lang.String newValue)`	Assign singleton String value to MFString objectType field, similar to `setObjectType(String[])`.
`LayoutLayerObject`	`setObjectType(java.lang.String[] newValue)`	Accessor method to assign String enumeration array (""ALL"" \| ""NONE"" \| ""TERRAIN"") to inputOutput MFString field named objectType.
`LayoutLayerObject`	`setObjectType(java.util.ArrayList<java.lang.String> newValue)`	Assign ArrayList value of MFString objectType field, similar to `setObjectType(String[])`.
`LayoutLayerObject`	`setObjectType(MFStringObject newValue)`	Assign typed object value to MFString objectType field, similar to `setObjectType(String[])`.
`LayoutLayerObject`	`setObjectType(SFStringObject newValue)`	Assign single SFString object value to MFString objectType field, similar to `setObjectType(String[])`.
`LayoutLayerObject`	`setPickable(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named pickable.
`LayoutLayerObject`	`setPickable(SFBoolObject newValue)`	Assign typed object value to SFBool pickable field, similar to `setPickable(boolean)`.
`LayoutLayerObject`	`setUSE(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named USE.
`LayoutLayerObject`	`setUSE(SFStringObject newValue)`	Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`LayoutLayerObject`	`setUSE(LayoutLayerObject DEFnode)`	Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`LayoutLayerObject`	`setViewport(ProtoInstanceObject newValue)`	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.
`LayoutLayerObject`	`setViewport(X3DViewportNode newValue)`	Accessor method to assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
`LayoutLayerObject`	`setVisible(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named visible.
`LayoutLayerObject`	`setVisible(SFBoolObject newValue)`	Assign typed object value to SFBool visible field, similar to `setVisible(boolean)`.
`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, 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, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Details
- pickableObjectTypeValues
  
  public static final java.util.ArrayList<java.lang.String> pickableObjectTypeValues
  
  List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
  
  Allowed values: ""ALL"", ""NONE"", ""TERRAIN"".
  
  Suggested values for the objectType field in the abstract types X3DPickableObject and X3DPickSensorNode. Unbounded, additional values are possible.
  
  See Also:
  
  https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/picking.html#X3DPickableObject
- OBJECTTYPE_ALL
  
  public static final java.lang.String OBJECTTYPE_ALL
  
  MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).
  
  See Also:
  
  pickableObjectTypeValues, Constant Field Values
- OBJECTTYPE_NONE
  
  public static final java.lang.String OBJECTTYPE_NONE
  
  MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).
  
  See Also:
  
  pickableObjectTypeValues, Constant Field Values
- OBJECTTYPE_TERRAIN
  
  public static final java.lang.String OBJECTTYPE_TERRAIN
  
  MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and also may include alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).
  
  See Also:
  
  pickableObjectTypeValues, Constant Field Values
- NAME
  
  public static final java.lang.String NAME
  
  String constant NAME provides name of this element: LayoutLayer.
  
  See Also:
  
  Constant Field Values
- COMPONENT
  
  public static final java.lang.String COMPONENT
  
  String constant COMPONENT defines X3D component for the LayoutLayer element: Layout
  
  See Also:
  
  Constant Field Values
- LEVEL
  
  public static final int LEVEL
  
  Integer constant LEVEL provides default X3D Layout component level for this element: 1
  
  See Also:
  
  Constant Field Values
- IS_DEFAULT_VALUE
  
  public static final ISObject IS_DEFAULT_VALUE
  
  SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
- LAYOUT_DEFAULT_VALUE
  
  public static final X3DLayoutNode LAYOUT_DEFAULT_VALUE
  
  SFNode field named layout has default value null (Java syntax) or NULL (XML syntax).
- METADATA_DEFAULT_VALUE
  
  public static final X3DMetadataObject METADATA_DEFAULT_VALUE
  
  SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
- OBJECTTYPE_DEFAULT_VALUE
  
  public static final java.util.ArrayList<java.lang.String> OBJECTTYPE_DEFAULT_VALUE
  
  MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).
- PICKABLE_DEFAULT_VALUE
  
  public static final boolean PICKABLE_DEFAULT_VALUE
  
  SFBool field named pickable has default value true (Java syntax) or true (XML syntax).
  
  See Also:
  
  Constant Field Values
- VIEWPORT_DEFAULT_VALUE
  
  public static final X3DViewportNode VIEWPORT_DEFAULT_VALUE
  
  SFNode field named viewport has default value null (Java syntax) or NULL (XML syntax).
- VISIBLE_DEFAULT_VALUE
  
  public static final boolean VISIBLE_DEFAULT_VALUE
  
  SFBool field named visible has default value true (Java syntax) or true (XML syntax).
  
  See Also:
  
  Constant Field Values
- 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
- toField_ADDCHILDREN
  
  public static final java.lang.String toField_ADDCHILDREN
  
  toField ROUTE name for MFNode field named addChildren.
  
  See Also:
  
  Constant Field Values
- fromField_CHILDREN
  
  public static final java.lang.String fromField_CHILDREN
  
  fromField ROUTE name for MFNode field named children.
  
  See Also:
  
  Constant Field Values
- toField_CHILDREN
  
  public static final java.lang.String toField_CHILDREN
  
  toField ROUTE name for MFNode field named children.
  
  See Also:
  
  Constant Field Values
- fromField_IS
  
  public static final java.lang.String fromField_IS
  
  fromField ROUTE name for SFNode field named IS.
  
  See Also:
  
  Constant Field Values
- fromField_LAYOUT
  
  public static final java.lang.String fromField_LAYOUT
  
  fromField ROUTE name for SFNode field named layout.
  
  See Also:
  
  Constant Field Values
- toField_LAYOUT
  
  public static final java.lang.String toField_LAYOUT
  
  toField ROUTE name for SFNode field named layout.
  
  See Also:
  
  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_OBJECTTYPE
  
  public static final java.lang.String fromField_OBJECTTYPE
  
  fromField ROUTE name for MFString field named objectType.
  
  See Also:
  
  Constant Field Values
- toField_OBJECTTYPE
  
  public static final java.lang.String toField_OBJECTTYPE
  
  toField ROUTE name for MFString field named objectType.
  
  See Also:
  
  Constant Field Values
- fromField_PICKABLE
  
  public static final java.lang.String fromField_PICKABLE
  
  fromField ROUTE name for SFBool field named pickable.
  
  See Also:
  
  Constant Field Values
- toField_PICKABLE
  
  public static final java.lang.String toField_PICKABLE
  
  toField ROUTE name for SFBool field named pickable.
  
  See Also:
  
  Constant Field Values
- toField_REMOVECHILDREN
  
  public static final java.lang.String toField_REMOVECHILDREN
  
  toField ROUTE name for MFNode field named removeChildren.
  
  See Also:
  
  Constant Field Values
- fromField_VIEWPORT
  
  public static final java.lang.String fromField_VIEWPORT
  
  fromField ROUTE name for SFNode field named viewport.
  
  See Also:
  
  Constant Field Values
- toField_VIEWPORT
  
  public static final java.lang.String toField_VIEWPORT
  
  toField ROUTE name for SFNode field named viewport.
  
  See Also:
  
  Constant Field Values
- fromField_VISIBLE
  
  public static final java.lang.String fromField_VISIBLE
  
  fromField ROUTE name for SFBool field named visible.
  
  See Also:
  
  Constant Field Values
- toField_VISIBLE
  
  public static final java.lang.String toField_VISIBLE
  
  toField ROUTE name for SFBool field named visible.
  
  See Also:
  
  Constant Field Values
Constructor Details
- LayoutLayerObject
  
  public LayoutLayerObject()
  
  Constructor for LayoutLayerObject to initialize member variables with default values.
- LayoutLayerObject
  
  public LayoutLayerObject(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 Details
- getElementName
  
  public final java.lang.String getElementName()
  
  Provides name of this element: LayoutLayer
  
  Specified by:
  
  getElementName in class X3DConcreteElement
  
  Returns:
  
  name of this element
- getComponent
  
  public final java.lang.String getComponent()
  
  Defines X3D component for the LayoutLayer element: Layout
  
  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
- getChildren
  
  public X3DNode[] getChildren()
  Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
  
  Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
  
  Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
  
  Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
  
  Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  Specified by:
  
  getChildren in interface LayoutLayer
  
  Returns:
  
  value of children field
  
  See Also:
  
  X3DChildNode
- getChildrenList
  
  public java.util.ArrayList<X3DNode> getChildrenList()
  
  Utility method to get ArrayList value of MFNode children field, similar to getChildren().
  
  Returns:
  
  value of children field
- setChildren
  
  public LayoutLayerObject setChildren(X3DNode[] newValue)
  Accessor method to assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
  
  Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
  
  Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
  
  Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  Specified by:
  
  setChildren in interface LayoutLayer
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setChildren
  
  public LayoutLayerObject setChildren(java.util.ArrayList<X3DChildNode> newValue)
  
  Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  public void addChildren(X3DNode newValue)
  
  Add single node to existing array of children nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.
  
  Parameters:
  
  newValue - is new value to be appended the children field.
- addChildren
  
  public LayoutLayerObject addChildren(ProtoInstanceObject newValue)
  
  Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
  
  Parameters:
  
  newValue - is new value to be appended the parts field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChild
  
  public LayoutLayerObject addChild(X3DChildNode newValue)
  
  Utility method to add single child element to contained list of existing children nodes (if any).
  
  Parameters:
  
  newValue - is new node value to be appended the children field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  public void addChildren(X3DNode[] newValue)
  
  Add array of children nodes to array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  addChildren in interface LayoutLayer
  
  Parameters:
  
  newValue - is new value array to be appended the children field.
- setChildren
  
  public void setChildren(X3DNode newValue)
  
  Set single children node, replacing prior array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.
  
  Specified by:
  
  setChildren in interface LayoutLayer
  
  Parameters:
  
  newValue - is new node for the children field (restricted to X3DChildNode)
- clearChildren
  
  public LayoutLayerObject clearChildren()
  
  Utility method to clear MFNode value of children field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- hasChildren
  
  public boolean hasChildren()
  
  Indicate whether an object is available for inputOutput MFNode field children.
  
  Returns:
  
  whether a properly typed node or ProtoInstance array or CommentsBlock is available.
  
  See Also:
  
  getChildren()
- addComments
  
  public LayoutLayerObject addComments(java.lang.String newComment)
  
  Add comment as CommentsBlock to children field
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComment - initial value
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public LayoutLayerObject addComments(java.lang.String[] newComments)
  
  Add comments as String[] array to children field
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComments - array of comments
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public LayoutLayerObject addComments(CommentsBlock newCommentsBlock)
  
  Add CommentsBlock to children field
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newCommentsBlock - block of comments to add
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIS
  
  public ISObject getIS()
  
  Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
  
  Specified by:
  
  getIS in class X3DConcreteNode
  
  Returns:
  
  value of IS field
  
  See Also:
  
  X3D Tooltips: IS, X3D Tooltips: connect
- setIS
  
  public LayoutLayerObject setIS(ISObject newValue)
  
  Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
  
  Specified by:
  
  setIS in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the IS field.
  
  Returns:
  
  LayoutLayerObject - 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
- clearIS
  
  public LayoutLayerObject clearIS()
  
  Utility method to clear SFNode value of IS field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- hasIS
  
  public boolean hasIS()
  
  Indicate whether an object is available for inputOutput SFNode field IS.
  
  Returns:
  
  whether a concrete statement or CommentsBlock is available.
  
  See Also:
  
  getIS()
- getLayout
  
  public X3DLayoutNode getLayout()
  
  Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
  
  Specified by:
  
  getLayout in interface LayoutLayer
  
  Returns:
  
  value of layout field
  
  See Also:
  
  Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parentâ€™s layout region, and also to scale the contents of the LayoutGroup. *
- setLayout
  
  public LayoutLayerObject setLayout(X3DLayoutNode newValue)
  
  Accessor method to assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
  
  Specified by:
  
  setLayout in interface LayoutLayer
  
  Parameters:
  
  newValue - is new value for the layout field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parentâ€™s layout region, and also to scale the contents of the LayoutGroup. *
- clearLayout
  
  public LayoutLayerObject clearLayout()
  
  Utility method to clear SFNode value of layout field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setLayout
  
  public LayoutLayerObject setLayout(ProtoInstanceObject newValue)
  
  Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field layout.
  
  Parameters:
  
  newValue - is new value for the layout field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  setLayout(X3DLayoutNode)
- hasLayout
  
  public boolean hasLayout()
  
  Indicate whether an object is available for inputOutput SFNode field layout.
  
  Returns:
  
  whether a properly typed node or ProtoInstance or CommentsBlock is available.
  
  See Also:
  
  getLayout(), getLayoutProtoInstance()
- getMetadata
  
  public X3DMetadataObject getMetadata()
  
  Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Specified by:
  
  getMetadata in interface LayoutLayer
  
  Specified by:
  
  getMetadata in interface X3DLayerNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  
  public LayoutLayerObject setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in interface LayoutLayer
  
  Specified by:
  
  setMetadata in interface X3DLayerNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- clearMetadata
  
  public LayoutLayerObject clearMetadata()
  
  Utility method to clear SFNode value of metadata field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setMetadata
  
  public LayoutLayerObject 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:
  
  LayoutLayerObject - 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
- getObjectType
  
  public java.lang.String[] getObjectType()
  
  Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
  
  Available enumeration values for string comparison: ALL, NONE, TERRAIN.
  
  Specified by:
  
  getObjectType in interface LayoutLayer
  
  Specified by:
  
  getObjectType in interface X3DLayerNode
  
  Returns:
  
  value of objectType field
- getObjectTypeList
  
  public java.util.ArrayList<java.lang.String> getObjectTypeList()
  
  Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().
  
  Returns:
  
  value of objectType field
- getObjectTypeString
  
  public java.lang.String getObjectTypeString()
  
  Utility method to get String value of MFString objectType field, similar to getObjectType().
  
  Returns:
  
  value of objectType field
- setObjectType
  
  public LayoutLayerObject setObjectType(java.lang.String[] newValue)
  
  Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
  
  Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL, NONE, TERRAIN).
  
  Specified by:
  
  setObjectType in interface LayoutLayer
  
  Specified by:
  
  setObjectType in interface X3DLayerNode
  
  Parameters:
  
  newValue - is new value for the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setObjectType
  
  public LayoutLayerObject setObjectType(MFStringObject newValue)
  
  Assign typed object value to MFString objectType field, similar to setObjectType(String[]).
  
  Parameters:
  
  newValue - is new value for the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setObjectType
  
  public LayoutLayerObject setObjectType(SFStringObject newValue)
  
  Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).
  
  Parameters:
  
  newValue - is new value for the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFStringObject.cleanupEnumerationValues(String)
- setObjectType
  
  public LayoutLayerObject setObjectType(java.lang.String newValue)
  
  Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).
  
  Parameters:
  
  newValue - is new value for the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFStringObject.cleanupEnumerationValues(String)
- setObjectType
  
  public LayoutLayerObject setObjectType(java.util.ArrayList<java.lang.String> newValue)
  
  Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).
  
  Parameters:
  
  newValue - is new value for the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- clearObjectType
  
  public LayoutLayerObject clearObjectType()
  
  Utility method to clear MFString value of objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addObjectType
  
  public LayoutLayerObject addObjectType(java.lang.String newValue)
  
  Add singleton String value to MFString objectType field.
  
  Parameters:
  
  newValue - is new value to add to the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFStringObject.cleanupEnumerationValues(String)
- addObjectType
  
  public LayoutLayerObject addObjectType(SFStringObject newValue)
  
  Add singleton SFStringObject value to MFString objectType field.
  
  Parameters:
  
  newValue - is new value to add to the objectType field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFStringObject.cleanupEnumerationValues(String)
- getPickable
  
  public boolean getPickable()
  
  Provide boolean value from inputOutput SFBool field named pickable.
  
  Tooltip: pickable determines whether pick traversal is performed for this layer. *
  
  Specified by:
  
  getPickable in interface LayoutLayer
  
  Specified by:
  
  getPickable in interface X3DLayerNode
  
  Specified by:
  
  getPickable in interface X3DPickableObject
  
  Returns:
  
  value of pickable field
- setPickable
  
  public LayoutLayerObject setPickable(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named pickable.
  
  Tooltip: pickable determines whether pick traversal is performed for this layer. *
  
  Specified by:
  
  setPickable in interface LayoutLayer
  
  Specified by:
  
  setPickable in interface X3DLayerNode
  
  Specified by:
  
  setPickable in interface X3DPickableObject
  
  Parameters:
  
  newValue - is new value for the pickable field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setPickable
  
  public LayoutLayerObject setPickable(SFBoolObject newValue)
  
  Assign typed object value to SFBool pickable field, similar to setPickable(boolean).
  
  Parameters:
  
  newValue - is new value for the pickable field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getViewport
  
  public X3DViewportNode getViewport()
  
  Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
  
  Specified by:
  
  getViewport in interface LayoutLayer
  
  Specified by:
  
  getViewport in interface X3DLayerNode
  
  Returns:
  
  value of viewport field
  
  See Also:
  
  Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
- setViewport
  
  public LayoutLayerObject setViewport(X3DViewportNode newValue)
  
  Accessor method to assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
  
  Specified by:
  
  setViewport in interface LayoutLayer
  
  Specified by:
  
  setViewport in interface X3DLayerNode
  
  Parameters:
  
  newValue - is new value for the viewport field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
- clearViewport
  
  public LayoutLayerObject clearViewport()
  
  Utility method to clear SFNode value of viewport field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setViewport
  
  public LayoutLayerObject setViewport(ProtoInstanceObject newValue)
  
  Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.
  
  Parameters:
  
  newValue - is new value for the viewport field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  setViewport(X3DViewportNode)
- hasViewport
  
  public boolean hasViewport()
  
  Indicate whether an object is available for inputOutput SFNode field viewport.
  
  Returns:
  
  whether a properly typed node or ProtoInstance or CommentsBlock is available.
  
  See Also:
  
  getViewport(), getViewportProtoInstance()
- getVisible
  
  public boolean getVisible()
  
  Provide boolean value from inputOutput SFBool field named visible.
  
  Specified by:
  
  getVisible in interface LayoutLayer
  
  Specified by:
  
  getVisible in interface X3DLayerNode
  
  Returns:
  
  value of visible field
- setVisible
  
  public LayoutLayerObject setVisible(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named visible.
  
  Specified by:
  
  setVisible in interface LayoutLayer
  
  Specified by:
  
  setVisible in interface X3DLayerNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setVisible
  
  public LayoutLayerObject setVisible(SFBoolObject newValue)
  
  Assign typed object value to SFBool visible field, similar to setVisible(boolean).
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDEF
  
  public java.lang.String getDEF()
  Provide String value from inputOutput SFString field named DEF.
  
  Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
  
  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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  Overrides:
  
  getDEF in class X3DConcreteNode
  
  Returns:
  
  value of DEF field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setDEF
  
  public final LayoutLayerObject setDEF(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named DEF.
  
  Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
  
  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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  Note that setting the DEF value clears the USE value.
  Specified by:
  
  setDEF in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the DEF field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDEF
  
  public LayoutLayerObject 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:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getUSE
  
  public java.lang.String getUSE()
  Provide String value from 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.
  Overrides:
  
  getUSE in class X3DConcreteNode
  
  Returns:
  
  value of USE field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setUSE
  
  public final LayoutLayerObject setUSE(java.lang.String newValue)
  Accessor method to 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 class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the USE field.
  
  Returns:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public LayoutLayerObject 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:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getCssClass
  
  public java.lang.String getCssClass()
  Provide String value from 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
  Overrides:
  
  getCssClass in class X3DConcreteNode
  
  Returns:
  
  value of class field
  
  See Also:
  
  W3C Cascading Style Sheets
- setCssClass
  
  public final LayoutLayerObject setCssClass(java.lang.String newValue)
  Accessor method to 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 class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  LayoutLayerObject - 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 LayoutLayerObject 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:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public LayoutLayerObject setUSE(LayoutLayerObject 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:
  
  LayoutLayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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, X3D Canonicalization (C14N) Tool
- 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)

Class LayoutLayerObject