Package org.web3d.x3d.jsail.Layout

Class Layout

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Layout.Layout

All Implemented Interfaces:

X3DChildNode, X3DNode, Layout, X3DLayoutNode

public class Layout
extends X3DConcreteNode
implements Layout

Layout node is used as layout field of LayoutLayer and LayoutGroup nodes.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. Layout node tooltip: (X3D version 3.2 or later) [X3DLayoutNode] Layout node is used as layout field of LayoutLayer and LayoutGroup nodes. Layout provides all parameters required to define the size, location and scale of a 2D rectangular region.

• Hint: the align, offset, and offsetUnits fields are used to determine the location of the layout region.

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: Layout
• X3D Tooltips: Layout
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIGN_CENTER_BOTTOM	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"CENTER\" \"BOTTOM\"" (Java syntax) or '"CENTER" "BOTTOM"' (XML syntax).
static final String	ALIGN_CENTER_CENTER	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"CENTER\" \"CENTER\"" (Java syntax) or '"CENTER" "CENTER"' (XML syntax).
static final String	ALIGN_CENTER_TOP	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"CENTER\" \"TOP\"" (Java syntax) or '"CENTER" "TOP"' (XML syntax).
static final ArrayList<String>	ALIGN_DEFAULT_VALUE	MFString field named align has default quoted value new String[] {"CENTER","CENTER"} (Java syntax) or quoted value "CENTER" "CENTER" (XML syntax).
static final String	ALIGN_LEFT_BOTTOM	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"LEFT\" \"BOTTOM\"" (Java syntax) or '"LEFT" "BOTTOM"' (XML syntax).
static final String	ALIGN_LEFT_CENTER	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"LEFT\" \"CENTER\"" (Java syntax) or '"LEFT" "CENTER"' (XML syntax).
static final String	ALIGN_LEFT_TOP	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"LEFT\" \"TOP\"" (Java syntax) or '"LEFT" "TOP"' (XML syntax).
static final String	ALIGN_RIGHT_BOTTOM	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"RIGHT\" \"BOTTOM\"" (Java syntax) or '"RIGHT" "BOTTOM"' (XML syntax).
static final String	ALIGN_RIGHT_CENTER	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"RIGHT\" \"CENTER\"" (Java syntax) or '"RIGHT" "CENTER"' (XML syntax).
static final String	ALIGN_RIGHT_TOP	MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"RIGHT\" \"TOP\"" (Java syntax) or '"RIGHT" "TOP"' (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Layout element: Layout
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_ALIGN	fromField ROUTE name for MFString field named align.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_OFFSET	fromField ROUTE name for MFFloat field named offset.
static final String	fromField_OFFSETUNITS	fromField ROUTE name for MFString field named offsetUnits.
static final String	fromField_SCALEMODE	fromField ROUTE name for MFString field named scaleMode.
static final String	fromField_SIZE	fromField ROUTE name for MFFloat field named size.
static final String	fromField_SIZEUNITS	fromField ROUTE name for MFString field named sizeUnits.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Layout component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: Layout.
static final ArrayList<Float>	OFFSET_DEFAULT_VALUE	MFFloat field named offset has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
static final ArrayList<String>	OFFSETUNITS_DEFAULT_VALUE	MFString field named offsetUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).
static final String	OFFSETUNITS_FRACTION_FRACTION	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
static final String	OFFSETUNITS_FRACTION_PIXEL	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
static final String	OFFSETUNITS_FRACTION_WORLD	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).
static final String	OFFSETUNITS_PIXEL_FRACTION	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
static final String	OFFSETUNITS_PIXEL_PIXEL	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
static final String	OFFSETUNITS_PIXEL_WORLD	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).
static final String	OFFSETUNITS_WORLD_FRACTION	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).
static final String	OFFSETUNITS_WORLD_PIXEL	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).
static final String	OFFSETUNITS_WORLD_WORLD	MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).
static final ArrayList<String>	SCALEMODE_DEFAULT_VALUE	MFString field named scaleMode has default quoted value new String[] {"NONE","NONE"} (Java syntax) or quoted value "NONE" "NONE" (XML syntax).
static final String	SCALEMODE_FRACTION_FRACTION	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
static final String	SCALEMODE_FRACTION_NONE	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"NONE\"" (Java syntax) or '"FRACTION" "NONE"' (XML syntax).
static final String	SCALEMODE_FRACTION_PIXEL	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
static final String	SCALEMODE_FRACTION_STRETCH	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"STRETCH\"" (Java syntax) or '"FRACTION" "STRETCH"' (XML syntax).
static final String	SCALEMODE_NONE_FRACTION	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"FRACTION\"" (Java syntax) or '"NONE" "FRACTION"' (XML syntax).
static final String	SCALEMODE_NONE_NONE	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"NONE\"" (Java syntax) or '"NONE" "NONE"' (XML syntax).
static final String	SCALEMODE_NONE_PIXEL	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"PIXEL\"" (Java syntax) or '"NONE" "PIXEL"' (XML syntax).
static final String	SCALEMODE_NONE_STRETCH	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"STRETCH\"" (Java syntax) or '"NONE" "STRETCH"' (XML syntax).
static final String	SCALEMODE_PIXEL_FRACTION	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
static final String	SCALEMODE_PIXEL_NONE	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"NONE\"" (Java syntax) or '"PIXEL" "NONE"' (XML syntax).
static final String	SCALEMODE_PIXEL_PIXEL	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
static final String	SCALEMODE_PIXEL_STRETCH	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"STRETCH\"" (Java syntax) or '"PIXEL" "STRETCH"' (XML syntax).
static final String	SCALEMODE_STRETCH_FRACTION	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"FRACTION\"" (Java syntax) or '"STRETCH" "FRACTION"' (XML syntax).
static final String	SCALEMODE_STRETCH_NONE	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"NONE\"" (Java syntax) or '"STRETCH" "NONE"' (XML syntax).
static final String	SCALEMODE_STRETCH_PIXEL	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"PIXEL\"" (Java syntax) or '"STRETCH" "PIXEL"' (XML syntax).
static final String	SCALEMODE_STRETCH_STRETCH	MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"STRETCH\"" (Java syntax) or '"STRETCH" "STRETCH"' (XML syntax).
static final ArrayList<Float>	SIZE_DEFAULT_VALUE	MFFloat field named size has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).
static final ArrayList<String>	SIZEUNITS_DEFAULT_VALUE	MFString field named sizeUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).
static final String	SIZEUNITS_FRACTION_FRACTION	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
static final String	SIZEUNITS_FRACTION_PIXEL	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
static final String	SIZEUNITS_FRACTION_WORLD	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).
static final String	SIZEUNITS_PIXEL_FRACTION	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
static final String	SIZEUNITS_PIXEL_PIXEL	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
static final String	SIZEUNITS_PIXEL_WORLD	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).
static final String	SIZEUNITS_WORLD_FRACTION	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).
static final String	SIZEUNITS_WORLD_PIXEL	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).
static final String	SIZEUNITS_WORLD_WORLD	MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).
static final String	toField_ALIGN	toField ROUTE name for MFString field named align.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_OFFSET	toField ROUTE name for MFFloat field named offset.
static final String	toField_OFFSETUNITS	toField ROUTE name for MFString field named offsetUnits.
static final String	toField_SCALEMODE	toField ROUTE name for MFString field named scaleMode.
static final String	toField_SIZE	toField ROUTE name for MFFloat field named size.
static final String	toField_SIZEUNITS	toField ROUTE name for MFString field named sizeUnits.

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
Layout()	Constructor for Layout to initialize member variables with default values.
Layout(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Layout	addAlign(String newValue)	Add singleton String value to MFString align field.
Layout	addAlign(SFString newValue)	Add singleton SFString value to MFString align field.
Layout	addComments(String newComment)	Add comment as String to contained commentsList.
Layout	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
Layout	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
Layout	addOffset(float newValue)	Add singleton float value to MFFloat offset field.
Layout	addOffset(SFFloat newValue)	Add singleton SFFloat value to MFFloat offset field.
Layout	addOffsetUnits(String newValue)	Add singleton String value to MFString offsetUnits field.
Layout	addOffsetUnits(SFString newValue)	Add singleton SFString value to MFString offsetUnits field.
Layout	addScaleMode(String newValue)	Add singleton String value to MFString scaleMode field.
Layout	addScaleMode(SFString newValue)	Add singleton SFString value to MFString scaleMode field.
Layout	addSize(float newValue)	Add singleton float value to MFFloat size field.
Layout	addSize(SFFloat newValue)	Add singleton SFFloat value to MFFloat size field.
Layout	addSizeUnits(String newValue)	Add singleton String value to MFString sizeUnits field.
Layout	addSizeUnits(SFString newValue)	Add singleton SFString value to MFString sizeUnits field.
Layout	clearAlign()	Utility method to clear MFString value of align field.
Layout	clearIS()	Utility method to clear SFNode value of IS field.
Layout	clearMetadata()	Utility method to clear SFNode value of metadata field.
Layout	clearOffset()	Utility method to clear MFFloat value of offset field.
Layout	clearOffsetUnits()	Utility method to clear MFString value of offsetUnits field.
Layout	clearScaleMode()	Utility method to clear MFString value of scaleMode field.
Layout	clearSize()	Utility method to clear MFFloat value of size field.
Layout	clearSizeUnits()	Utility method to clear MFString value of sizeUnits field.
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.
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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
String[]	getAlign()	Provide array of String enumeration results (baseType MFString) ['"LEFT" "BOTTOM"' | '"LEFT" "CENTER"' | '"LEFT" "TOP"' | '"CENTER" "BOTTOM"' | '"CENTER" "CENTER"' | '"CENTER" "TOP"' | '"RIGHT" "BOTTOM"' | '"RIGHT" "CENTER"' | '"RIGHT" "TOP"'] from inputOutput MFString field named align.
ArrayList<String>	getAlignList()	Utility method to get ArrayList value of MFString align field, similar to getAlign().
String	getAlignString()	Utility method to get String value of MFString align field, similar to getAlign().
final String	getComponent()	Defines X3D component for the Layout element: Layout
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: Layout
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getOffset()	Provide array of Float results from inputOutput MFFloat field named offset.
ArrayList<Float>	getOffsetList()	Utility method to get ArrayList value of MFFloat offset field, similar to getOffset().
String	getOffsetString()	Utility method to get String value of MFFloat offset field, similar to getOffset().
String[]	getOffsetUnits()	Provide array of String enumeration results (baseType MFString) ['"WORLD" "WORLD"' | '"WORLD" "FRACTION"' | '"WORLD" "PIXEL"' | '"FRACTION" "WORLD"' | '"FRACTION" "FRACTION"' | '"FRACTION" "PIXEL"' | '"PIXEL" "WORLD"' | '"PIXEL" "FRACTION"' | '"PIXEL" "PIXEL"'] from inputOutput MFString field named offsetUnits.
ArrayList<String>	getOffsetUnitsList()	Utility method to get ArrayList value of MFString offsetUnits field, similar to getOffsetUnits().
String	getOffsetUnitsString()	Utility method to get String value of MFString offsetUnits field, similar to getOffsetUnits().
String[]	getScaleMode()	Provide array of String enumeration results (baseType MFString) ['"NONE" "NONE"' | '"NONE" "FRACTION"' | '"NONE" "STRETCH"' | '"NONE" "PIXEL"' | '"FRACTION" "NONE"' | '"FRACTION" "FRACTION"' | '"FRACTION" "STRETCH"' | '"FRACTION" "PIXEL"' | '"STRETCH" "NONE"' | '"STRETCH" "FRACTION"' | '"STRETCH" "STRETCH"' | '"STRETCH" "PIXEL"' | '"PIXEL" "NONE"' | '"PIXEL" "FRACTION"' | '"PIXEL" "STRETCH"' | '"PIXEL" "PIXEL"'] from inputOutput MFString field named scaleMode.
ArrayList<String>	getScaleModeList()	Utility method to get ArrayList value of MFString scaleMode field, similar to getScaleMode().
String	getScaleModeString()	Utility method to get String value of MFString scaleMode field, similar to getScaleMode().
float[]	getSize()	Provide array of Float results from inputOutput MFFloat field named size.
ArrayList<Float>	getSizeList()	Utility method to get ArrayList value of MFFloat size field, similar to getSize().
String	getSizeString()	Utility method to get String value of MFFloat size field, similar to getSize().
String[]	getSizeUnits()	Provide array of String enumeration results (baseType MFString) ['"WORLD" "WORLD"' | '"WORLD" "FRACTION"' | '"WORLD" "PIXEL"' | '"FRACTION" "WORLD"' | '"FRACTION" "FRACTION"' | '"FRACTION" "PIXEL"' | '"PIXEL" "WORLD"' | '"PIXEL" "FRACTION"' | '"PIXEL" "PIXEL"'] from inputOutput MFString field named sizeUnits.
ArrayList<String>	getSizeUnitsList()	Utility method to get ArrayList value of MFString sizeUnits field, similar to getSizeUnits().
String	getSizeUnitsString()	Utility method to get String value of MFString sizeUnits field, similar to getSizeUnits().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, 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	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
Layout	setAlign(String newValue)	Assign singleton String value to MFString align field, similar to setAlign(String[]).
Layout	setAlign(String[] newValue)	Accessor method to assign String enumeration array (""LEFT" "BOTTOM"" | ""LEFT" "CENTER"" | ""LEFT" "TOP"" | ""CENTER" "BOTTOM"" | ""CENTER" "CENTER"" | ""CENTER" "TOP"" | ""RIGHT" "BOTTOM"" | ""RIGHT" "CENTER"" | ""RIGHT" "TOP"") to inputOutput MFString field named align.
Layout	setAlign(ArrayList<String> newValue)	Assign ArrayList value of MFString align field, similar to setAlign(String[]).
Layout	setAlign(MFString newValue)	Assign typed object value to MFString align field, similar to setAlign(String[]).
Layout	setAlign(SFString newValue)	Assign single SFString object value to MFString align field, similar to setAlign(String[]).
final Layout	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Layout	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Layout	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Layout	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Layout	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Layout	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final Layout	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Layout	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
Layout	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Layout	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Layout	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Layout	setOffset(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOffset(float[]).
Layout	setOffset(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named offset.
Layout	setOffset(int[] newValue)	Assign floating-point array value of MFFloat offset field, similar to setOffset(float[]).
Layout	setOffset(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat offset field, similar to setOffset(float[]).
Layout	setOffset(MFFloat newValue)	Assign typed object value to MFFloat offset field, similar to setOffset(float[]).
Layout	setOffsetUnits(String newValue)	Assign singleton String value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
Layout	setOffsetUnits(String[] newValue)	Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named offsetUnits.
Layout	setOffsetUnits(ArrayList<String> newValue)	Assign ArrayList value of MFString offsetUnits field, similar to setOffsetUnits(String[]).
Layout	setOffsetUnits(MFString newValue)	Assign typed object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
Layout	setOffsetUnits(SFString newValue)	Assign single SFString object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
Layout	setScaleMode(String newValue)	Assign singleton String value to MFString scaleMode field, similar to setScaleMode(String[]).
Layout	setScaleMode(String[] newValue)	Accessor method to assign String enumeration array (""NONE" "NONE"" | ""NONE" "FRACTION"" | ""NONE" "STRETCH"" | ""NONE" "PIXEL"" | ""FRACTION" "NONE"" | ""FRACTION" "FRACTION"" | ""FRACTION" "STRETCH"" | ""FRACTION" "PIXEL"" | ""STRETCH" "NONE"" | ""STRETCH" "FRACTION"" | ""STRETCH" "STRETCH"" | ""STRETCH" "PIXEL"" | ""PIXEL" "NONE"" | ""PIXEL" "FRACTION"" | ""PIXEL" "STRETCH"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named scaleMode.
Layout	setScaleMode(ArrayList<String> newValue)	Assign ArrayList value of MFString scaleMode field, similar to setScaleMode(String[]).
Layout	setScaleMode(MFString newValue)	Assign typed object value to MFString scaleMode field, similar to setScaleMode(String[]).
Layout	setScaleMode(SFString newValue)	Assign single SFString object value to MFString scaleMode field, similar to setScaleMode(String[]).
Layout	setSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).
Layout	setSize(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named size.
Layout	setSize(int[] newValue)	Assign floating-point array value of MFFloat size field, similar to setSize(float[]).
Layout	setSize(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat size field, similar to setSize(float[]).
Layout	setSize(MFFloat newValue)	Assign typed object value to MFFloat size field, similar to setSize(float[]).
Layout	setSizeUnits(String newValue)	Assign singleton String value to MFString sizeUnits field, similar to setSizeUnits(String[]).
Layout	setSizeUnits(String[] newValue)	Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named sizeUnits.
Layout	setSizeUnits(ArrayList<String> newValue)	Assign ArrayList value of MFString sizeUnits field, similar to setSizeUnits(String[]).
Layout	setSizeUnits(MFString newValue)	Assign typed object value to MFString sizeUnits field, similar to setSizeUnits(String[]).
Layout	setSizeUnits(SFString newValue)	Assign single SFString object value to MFString sizeUnits field, similar to setSizeUnits(String[]).
final Layout	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Layout	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
Layout	setUSE(Layout DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Details

ALIGN_LEFT_BOTTOM

public static final String ALIGN_LEFT_BOTTOM

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"LEFT\" \"BOTTOM\"" (Java syntax) or '"LEFT" "BOTTOM"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_LEFT_CENTER

public static final String ALIGN_LEFT_CENTER

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"LEFT\" \"CENTER\"" (Java syntax) or '"LEFT" "CENTER"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_LEFT_TOP

public static final String ALIGN_LEFT_TOP

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"LEFT\" \"TOP\"" (Java syntax) or '"LEFT" "TOP"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_CENTER_BOTTOM

public static final String ALIGN_CENTER_BOTTOM

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"CENTER\" \"BOTTOM\"" (Java syntax) or '"CENTER" "BOTTOM"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_CENTER_CENTER

public static final String ALIGN_CENTER_CENTER

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"CENTER\" \"CENTER\"" (Java syntax) or '"CENTER" "CENTER"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_CENTER_TOP

public static final String ALIGN_CENTER_TOP

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"CENTER\" \"TOP\"" (Java syntax) or '"CENTER" "TOP"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_RIGHT_BOTTOM

public static final String ALIGN_RIGHT_BOTTOM

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"RIGHT\" \"BOTTOM\"" (Java syntax) or '"RIGHT" "BOTTOM"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_RIGHT_CENTER

public static final String ALIGN_RIGHT_CENTER

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"RIGHT\" \"CENTER\"" (Java syntax) or '"RIGHT" "CENTER"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

ALIGN_RIGHT_TOP

public static final String ALIGN_RIGHT_TOP

MFString field named align with X3DUOM simpleType layoutAlignChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"RIGHT\" \"TOP\"" (Java syntax) or '"RIGHT" "TOP"' (XML syntax).

See Also:

• XML Schema: layoutAlignChoices
• Constant Field Values

OFFSETUNITS_WORLD_WORLD

public static final String OFFSETUNITS_WORLD_WORLD

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_WORLD_FRACTION

public static final String OFFSETUNITS_WORLD_FRACTION

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_WORLD_PIXEL

public static final String OFFSETUNITS_WORLD_PIXEL

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_FRACTION_WORLD

public static final String OFFSETUNITS_FRACTION_WORLD

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_FRACTION_FRACTION

public static final String OFFSETUNITS_FRACTION_FRACTION

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_FRACTION_PIXEL

public static final String OFFSETUNITS_FRACTION_PIXEL

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_PIXEL_WORLD

public static final String OFFSETUNITS_PIXEL_WORLD

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_PIXEL_FRACTION

public static final String OFFSETUNITS_PIXEL_FRACTION

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

OFFSETUNITS_PIXEL_PIXEL

public static final String OFFSETUNITS_PIXEL_PIXEL

MFString field named offsetUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SCALEMODE_NONE_NONE

public static final String SCALEMODE_NONE_NONE

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"NONE\"" (Java syntax) or '"NONE" "NONE"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_NONE_FRACTION

public static final String SCALEMODE_NONE_FRACTION

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"FRACTION\"" (Java syntax) or '"NONE" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_NONE_STRETCH

public static final String SCALEMODE_NONE_STRETCH

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"STRETCH\"" (Java syntax) or '"NONE" "STRETCH"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_NONE_PIXEL

public static final String SCALEMODE_NONE_PIXEL

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"NONE\" \"PIXEL\"" (Java syntax) or '"NONE" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_FRACTION_NONE

public static final String SCALEMODE_FRACTION_NONE

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"NONE\"" (Java syntax) or '"FRACTION" "NONE"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_FRACTION_FRACTION

public static final String SCALEMODE_FRACTION_FRACTION

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_FRACTION_STRETCH

public static final String SCALEMODE_FRACTION_STRETCH

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"STRETCH\"" (Java syntax) or '"FRACTION" "STRETCH"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_FRACTION_PIXEL

public static final String SCALEMODE_FRACTION_PIXEL

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_STRETCH_NONE

public static final String SCALEMODE_STRETCH_NONE

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"NONE\"" (Java syntax) or '"STRETCH" "NONE"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_STRETCH_FRACTION

public static final String SCALEMODE_STRETCH_FRACTION

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"FRACTION\"" (Java syntax) or '"STRETCH" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_STRETCH_STRETCH

public static final String SCALEMODE_STRETCH_STRETCH

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"STRETCH\"" (Java syntax) or '"STRETCH" "STRETCH"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_STRETCH_PIXEL

public static final String SCALEMODE_STRETCH_PIXEL

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"STRETCH\" \"PIXEL\"" (Java syntax) or '"STRETCH" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_PIXEL_NONE

public static final String SCALEMODE_PIXEL_NONE

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"NONE\"" (Java syntax) or '"PIXEL" "NONE"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_PIXEL_FRACTION

public static final String SCALEMODE_PIXEL_FRACTION

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_PIXEL_STRETCH

public static final String SCALEMODE_PIXEL_STRETCH

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"STRETCH\"" (Java syntax) or '"PIXEL" "STRETCH"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SCALEMODE_PIXEL_PIXEL

public static final String SCALEMODE_PIXEL_PIXEL

MFString field named scaleMode with X3DUOM simpleType layoutScaleModeChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutScaleModeChoices
• Constant Field Values

SIZEUNITS_WORLD_WORLD

public static final String SIZEUNITS_WORLD_WORLD

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_WORLD_FRACTION

public static final String SIZEUNITS_WORLD_FRACTION

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_WORLD_PIXEL

public static final String SIZEUNITS_WORLD_PIXEL

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_FRACTION_WORLD

public static final String SIZEUNITS_FRACTION_WORLD

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_FRACTION_FRACTION

public static final String SIZEUNITS_FRACTION_FRACTION

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_FRACTION_PIXEL

public static final String SIZEUNITS_FRACTION_PIXEL

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_PIXEL_WORLD

public static final String SIZEUNITS_PIXEL_WORLD

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_PIXEL_FRACTION

public static final String SIZEUNITS_PIXEL_FRACTION

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

SIZEUNITS_PIXEL_PIXEL

public static final String SIZEUNITS_PIXEL_PIXEL

MFString field named sizeUnits with X3DUOM simpleType layoutUnitsChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).

See Also:

• XML Schema: layoutUnitsChoices
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: Layout.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Layout 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

ALIGN_DEFAULT_VALUE

public static final ArrayList<String> ALIGN_DEFAULT_VALUE

MFString field named align has default quoted value new String[] {"CENTER","CENTER"} (Java syntax) or quoted value "CENTER" "CENTER" (XML syntax).

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS 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).

OFFSET_DEFAULT_VALUE

public static final ArrayList<Float> OFFSET_DEFAULT_VALUE

MFFloat field named offset has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

OFFSETUNITS_DEFAULT_VALUE

public static final ArrayList<String> OFFSETUNITS_DEFAULT_VALUE

MFString field named offsetUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).

SCALEMODE_DEFAULT_VALUE

public static final ArrayList<String> SCALEMODE_DEFAULT_VALUE

MFString field named scaleMode has default quoted value new String[] {"NONE","NONE"} (Java syntax) or quoted value "NONE" "NONE" (XML syntax).

SIZE_DEFAULT_VALUE

public static final ArrayList<Float> SIZE_DEFAULT_VALUE

MFFloat field named size has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).

SIZEUNITS_DEFAULT_VALUE

public static final ArrayList<String> SIZEUNITS_DEFAULT_VALUE

MFString field named sizeUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "layout";
containerField_ALLOWED_VALUES = {"layout" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_ALIGN

public static final String fromField_ALIGN

fromField ROUTE name for MFString field named align.

See Also:

• Constant Field Values

toField_ALIGN

public static final String toField_ALIGN

toField ROUTE name for MFString field named align.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_OFFSET

public static final String fromField_OFFSET

fromField ROUTE name for MFFloat field named offset.

See Also:

• Constant Field Values

toField_OFFSET

public static final String toField_OFFSET

toField ROUTE name for MFFloat field named offset.

See Also:

• Constant Field Values

fromField_OFFSETUNITS

public static final String fromField_OFFSETUNITS

fromField ROUTE name for MFString field named offsetUnits.

See Also:

• Constant Field Values

toField_OFFSETUNITS

public static final String toField_OFFSETUNITS

toField ROUTE name for MFString field named offsetUnits.

See Also:

• Constant Field Values

fromField_SCALEMODE

public static final String fromField_SCALEMODE

fromField ROUTE name for MFString field named scaleMode.

See Also:

• Constant Field Values

toField_SCALEMODE

public static final String toField_SCALEMODE

toField ROUTE name for MFString field named scaleMode.

See Also:

• Constant Field Values

fromField_SIZE

public static final String fromField_SIZE

fromField ROUTE name for MFFloat field named size.

See Also:

• Constant Field Values

toField_SIZE

public static final String toField_SIZE

toField ROUTE name for MFFloat field named size.

See Also:

• Constant Field Values

fromField_SIZEUNITS

public static final String fromField_SIZEUNITS

fromField ROUTE name for MFString field named sizeUnits.

See Also:

• Constant Field Values

toField_SIZEUNITS

public static final String toField_SIZEUNITS

toField ROUTE name for MFString field named sizeUnits.

See Also:

• Constant Field Values

Constructor Details

Layout

public Layout()

Constructor for Layout to initialize member variables with default values.

Layout

public Layout(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 String getElementName()

Provides name of this element: Layout

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Layout 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 String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAlign

public String[] getAlign()

Provide array of String enumeration results (baseType MFString) ['"LEFT" "BOTTOM"' | '"LEFT" "CENTER"' | '"LEFT" "TOP"' | '"CENTER" "BOTTOM"' | '"CENTER" "CENTER"' | '"CENTER" "TOP"' | '"RIGHT" "BOTTOM"' | '"RIGHT" "CENTER"' | '"RIGHT" "TOP"'] from inputOutput MFString field named align.

Tooltip: The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT|CENTER|RIGHT) and the second value is for vertical direction (BOTTOM|CENTER|TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM".

• Warning: two values (or possibly one value) only.
• Warning: if the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Available enumeration values for string comparison: LEFT_BOTTOM, LEFT_CENTER, LEFT_TOP, CENTER_BOTTOM, CENTER_CENTER, CENTER_TOP, RIGHT_BOTTOM, RIGHT_CENTER, RIGHT_TOP.

Specified by:

getAlign in interface Layout

Returns:

value of align field

getAlignList

public ArrayList<String> getAlignList()

Utility method to get ArrayList value of MFString align field, similar to getAlign().

Returns:

value of align field

getAlignString

public String getAlignString()

Utility method to get String value of MFString align field, similar to getAlign().

Returns:

value of align field

setAlign

public Layout setAlign(String[] newValue)

Accessor method to assign String enumeration array (""LEFT" "BOTTOM"" | ""LEFT" "CENTER"" | ""LEFT" "TOP"" | ""CENTER" "BOTTOM"" | ""CENTER" "CENTER"" | ""CENTER" "TOP"" | ""RIGHT" "BOTTOM"" | ""RIGHT" "CENTER"" | ""RIGHT" "TOP"") to inputOutput MFString field named align.

Warning: authors can only choose from a strict list of enumeration values (LEFT_BOTTOM, LEFT_CENTER, LEFT_TOP, CENTER_BOTTOM, CENTER_CENTER, CENTER_TOP, RIGHT_BOTTOM, RIGHT_CENTER, RIGHT_TOP).

Tooltip: The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT|CENTER|RIGHT) and the second value is for vertical direction (BOTTOM|CENTER|TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM".

• Warning: two values (or possibly one value) only.
• Warning: if the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setAlign in interface Layout

Parameters:

newValue - is new value for the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAlign

public Layout setAlign(MFString newValue)

Assign typed object value to MFString align field, similar to setAlign(String[]).

Parameters:

newValue - is new value for the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAlign

public Layout setAlign(SFString newValue)

Assign single SFString object value to MFString align field, similar to setAlign(String[]).

Parameters:

newValue - is new value for the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setAlign

public Layout setAlign(String newValue)

Assign singleton String value to MFString align field, similar to setAlign(String[]).

Parameters:

newValue - is new value for the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setAlign

public Layout setAlign(ArrayList<String> newValue)

Assign ArrayList value of MFString align field, similar to setAlign(String[]).

Parameters:

newValue - is new value for the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearAlign

public Layout clearAlign()

Utility method to clear MFString value of align field. This method does not initialize withALIGN_DEFAULT_VALUE.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addAlign

public Layout addAlign(String newValue)

Add singleton String value to MFString align field.

Parameters:

newValue - is new value to add to the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addAlign

public Layout addAlign(SFString newValue)

Add singleton SFString value to MFString align field.

Parameters:

newValue - is new value to add to the align field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getIS

public IS getIS()

Provide IS 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 Layout setIS(IS newValue)

Accessor method to assign IS 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:

Layout - 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 Layout clearIS()

Utility method to clear SFNode value of IS field.

Returns:

Layout - 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()

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface Layout

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DLayoutNode

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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public Layout setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface Layout

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DLayoutNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

Layout - 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public Layout clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public Layout setMetadata(ProtoInstance 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:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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

getOffset

public float[] getOffset()

Provide array of Float results from inputOutput MFFloat field named offset.

Tooltip: (-infinity,+infinity) The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field.

• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.

Specified by:

getOffset in interface Layout

Returns:

value of offset field

getOffsetList

public ArrayList<Float> getOffsetList()

Utility method to get ArrayList value of MFFloat offset field, similar to getOffset().

Returns:

value of offset field

getOffsetString

public String getOffsetString()

Utility method to get String value of MFFloat offset field, similar to getOffset().

Returns:

value of offset field

setOffset

public Layout setOffset(float[] newValue)

Accessor method to assign Float array to inputOutput MFFloat field named offset.

Tooltip: (-infinity,+infinity) The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field.

• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.

Specified by:

setOffset in interface Layout

Parameters:

newValue - is new value for the offset field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOffset

public Layout setOffset(MFFloat newValue)

Assign typed object value to MFFloat offset field, similar to setOffset(float[]).

Parameters:

newValue - is new value for the offset field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOffset

public Layout setOffset(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat offset field, similar to setOffset(float[]).

Parameters:

newValue - is new value for the offset field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearOffset

public Layout clearOffset()

Utility method to clear MFFloat value of offset field. This method does not initialize withOFFSET_DEFAULT_VALUE.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setOffset

public Layout setOffset(int[] newValue)

Assign floating-point array value of MFFloat offset field, similar to setOffset(float[]).

Parameters:

newValue - is new value for the offset field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addOffset

public Layout addOffset(float newValue)

Add singleton float value to MFFloat offset field.

Parameters:

newValue - is new value to add to the offset field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addOffset

public Layout addOffset(SFFloat newValue)

Add singleton SFFloat value to MFFloat offset field.

Parameters:

newValue - is new value to add to the offset field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOffset

public Layout setOffset(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOffset(float[]).

Parameters:

newArray - is new value for field

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getOffsetUnits

public String[] getOffsetUnits()

Provide array of String enumeration results (baseType MFString) ['"WORLD" "WORLD"' | '"WORLD" "FRACTION"' | '"WORLD" "PIXEL"' | '"FRACTION" "WORLD"' | '"FRACTION" "FRACTION"' | '"FRACTION" "PIXEL"' | '"PIXEL" "WORLD"' | '"PIXEL" "FRACTION"' | '"PIXEL" "PIXEL"'] from inputOutput MFString field named offsetUnits.

Tooltip: The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".

• Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Available enumeration values for string comparison: WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL.

Specified by:

getOffsetUnits in interface Layout

Returns:

value of offsetUnits field

getOffsetUnitsList

public ArrayList<String> getOffsetUnitsList()

Utility method to get ArrayList value of MFString offsetUnits field, similar to getOffsetUnits().

Returns:

value of offsetUnits field

getOffsetUnitsString

public String getOffsetUnitsString()

Utility method to get String value of MFString offsetUnits field, similar to getOffsetUnits().

Returns:

value of offsetUnits field

setOffsetUnits

public Layout setOffsetUnits(String[] newValue)

Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named offsetUnits.

Warning: authors can only choose from a strict list of enumeration values (WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL).

Tooltip: The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".

• Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setOffsetUnits in interface Layout

Parameters:

newValue - is new value for the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOffsetUnits

public Layout setOffsetUnits(MFString newValue)

Assign typed object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).

Parameters:

newValue - is new value for the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOffsetUnits

public Layout setOffsetUnits(SFString newValue)

Assign single SFString object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).

Parameters:

newValue - is new value for the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setOffsetUnits

public Layout setOffsetUnits(String newValue)

Assign singleton String value to MFString offsetUnits field, similar to setOffsetUnits(String[]).

Parameters:

newValue - is new value for the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setOffsetUnits

public Layout setOffsetUnits(ArrayList<String> newValue)

Assign ArrayList value of MFString offsetUnits field, similar to setOffsetUnits(String[]).

Parameters:

newValue - is new value for the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearOffsetUnits

public Layout clearOffsetUnits()

Utility method to clear MFString value of offsetUnits field. This method does not initialize withOFFSETUNITS_DEFAULT_VALUE.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addOffsetUnits

public Layout addOffsetUnits(String newValue)

Add singleton String value to MFString offsetUnits field.

Parameters:

newValue - is new value to add to the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addOffsetUnits

public Layout addOffsetUnits(SFString newValue)

Add singleton SFString value to MFString offsetUnits field.

Parameters:

newValue - is new value to add to the offsetUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getScaleMode

public String[] getScaleMode()

Provide array of String enumeration results (baseType MFString) ['"NONE" "NONE"' | '"NONE" "FRACTION"' | '"NONE" "STRETCH"' | '"NONE" "PIXEL"' | '"FRACTION" "NONE"' | '"FRACTION" "FRACTION"' | '"FRACTION" "STRETCH"' | '"FRACTION" "PIXEL"' | '"STRETCH" "NONE"' | '"STRETCH" "FRACTION"' | '"STRETCH" "STRETCH"' | '"STRETCH" "PIXEL"' | '"PIXEL" "NONE"' | '"PIXEL" "FRACTION"' | '"PIXEL" "STRETCH"' | '"PIXEL" "PIXEL"'] from inputOutput MFString field named scaleMode.

Tooltip: The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL".

• Hint: A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION.
• Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle.
• Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale.
• Hint: a value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel.
• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Available enumeration values for string comparison: NONE_NONE, NONE_FRACTION, NONE_STRETCH, NONE_PIXEL, FRACTION_NONE, FRACTION_FRACTION, FRACTION_STRETCH, FRACTION_PIXEL, STRETCH_NONE, STRETCH_FRACTION, STRETCH_STRETCH, STRETCH_PIXEL, PIXEL_NONE, PIXEL_FRACTION, PIXEL_STRETCH, PIXEL_PIXEL.

Specified by:

getScaleMode in interface Layout

Returns:

value of scaleMode field

getScaleModeList

public ArrayList<String> getScaleModeList()

Utility method to get ArrayList value of MFString scaleMode field, similar to getScaleMode().

Returns:

value of scaleMode field

getScaleModeString

public String getScaleModeString()

Utility method to get String value of MFString scaleMode field, similar to getScaleMode().

Returns:

value of scaleMode field

setScaleMode

public Layout setScaleMode(String[] newValue)

Accessor method to assign String enumeration array (""NONE" "NONE"" | ""NONE" "FRACTION"" | ""NONE" "STRETCH"" | ""NONE" "PIXEL"" | ""FRACTION" "NONE"" | ""FRACTION" "FRACTION"" | ""FRACTION" "STRETCH"" | ""FRACTION" "PIXEL"" | ""STRETCH" "NONE"" | ""STRETCH" "FRACTION"" | ""STRETCH" "STRETCH"" | ""STRETCH" "PIXEL"" | ""PIXEL" "NONE"" | ""PIXEL" "FRACTION"" | ""PIXEL" "STRETCH"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named scaleMode.

Warning: authors can only choose from a strict list of enumeration values (NONE_NONE, NONE_FRACTION, NONE_STRETCH, NONE_PIXEL, FRACTION_NONE, FRACTION_FRACTION, FRACTION_STRETCH, FRACTION_PIXEL, STRETCH_NONE, STRETCH_FRACTION, STRETCH_STRETCH, STRETCH_PIXEL, PIXEL_NONE, PIXEL_FRACTION, PIXEL_STRETCH, PIXEL_PIXEL).

Tooltip: The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL".

• Hint: A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION.
• Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle.
• Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale.
• Hint: a value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel.
• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setScaleMode in interface Layout

Parameters:

newValue - is new value for the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setScaleMode

public Layout setScaleMode(MFString newValue)

Assign typed object value to MFString scaleMode field, similar to setScaleMode(String[]).

Parameters:

newValue - is new value for the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setScaleMode

public Layout setScaleMode(SFString newValue)

Assign single SFString object value to MFString scaleMode field, similar to setScaleMode(String[]).

Parameters:

newValue - is new value for the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setScaleMode

public Layout setScaleMode(String newValue)

Assign singleton String value to MFString scaleMode field, similar to setScaleMode(String[]).

Parameters:

newValue - is new value for the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setScaleMode

public Layout setScaleMode(ArrayList<String> newValue)

Assign ArrayList value of MFString scaleMode field, similar to setScaleMode(String[]).

Parameters:

newValue - is new value for the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearScaleMode

public Layout clearScaleMode()

Utility method to clear MFString value of scaleMode field. This method does not initialize withSCALEMODE_DEFAULT_VALUE.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addScaleMode

public Layout addScaleMode(String newValue)

Add singleton String value to MFString scaleMode field.

Parameters:

newValue - is new value to add to the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addScaleMode

public Layout addScaleMode(SFString newValue)

Add singleton SFString value to MFString scaleMode field.

Parameters:

newValue - is new value to add to the scaleMode field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getSize

public float[] getSize()

Provide array of Float results from inputOutput MFFloat field named size.

Tooltip: (0,+infinity) The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values.

• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.

Specified by:

getSize in interface Layout

Returns:

value of size field

getSizeList

public ArrayList<Float> getSizeList()

Utility method to get ArrayList value of MFFloat size field, similar to getSize().

Returns:

value of size field

getSizeString

public String getSizeString()

Utility method to get String value of MFFloat size field, similar to getSize().

Returns:

value of size field

setSize

public Layout setSize(float[] newValue)

Accessor method to assign Float array to inputOutput MFFloat field named size.

Tooltip: (0,+infinity) The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values.

• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.

Specified by:

setSize in interface Layout

Parameters:

newValue - is new value for the size field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSize

public Layout setSize(MFFloat newValue)

Assign typed object value to MFFloat size field, similar to setSize(float[]).

Parameters:

newValue - is new value for the size field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSize

public Layout setSize(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat size field, similar to setSize(float[]).

Parameters:

newValue - is new value for the size field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearSize

public Layout clearSize()

Utility method to clear MFFloat value of size field. This method does not initialize withSIZE_DEFAULT_VALUE.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setSize

public Layout setSize(int[] newValue)

Assign floating-point array value of MFFloat size field, similar to setSize(float[]).

Parameters:

newValue - is new value for the size field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addSize

public Layout addSize(float newValue)

Add singleton float value to MFFloat size field.

Parameters:

newValue - is new value to add to the size field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addSize

public Layout addSize(SFFloat newValue)

Add singleton SFFloat value to MFFloat size field.

Parameters:

newValue - is new value to add to the size field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSize

public Layout setSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).

Parameters:

newArray - is new value for field

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSizeUnits

public String[] getSizeUnits()

Provide array of String enumeration results (baseType MFString) ['"WORLD" "WORLD"' | '"WORLD" "FRACTION"' | '"WORLD" "PIXEL"' | '"FRACTION" "WORLD"' | '"FRACTION" "FRACTION"' | '"FRACTION" "PIXEL"' | '"PIXEL" "WORLD"' | '"PIXEL" "FRACTION"' | '"PIXEL" "PIXEL"'] from inputOutput MFString field named sizeUnits.

Tooltip: The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".

• Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Available enumeration values for string comparison: WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL.

Specified by:

getSizeUnits in interface Layout

Returns:

value of sizeUnits field

getSizeUnitsList

public ArrayList<String> getSizeUnitsList()

Utility method to get ArrayList value of MFString sizeUnits field, similar to getSizeUnits().

Returns:

value of sizeUnits field

getSizeUnitsString

public String getSizeUnitsString()

Utility method to get String value of MFString sizeUnits field, similar to getSizeUnits().

Returns:

value of sizeUnits field

setSizeUnits

public Layout setSizeUnits(String[] newValue)

Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named sizeUnits.

Warning: authors can only choose from a strict list of enumeration values (WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL).

Tooltip: The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".

• Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
• Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setSizeUnits in interface Layout

Parameters:

newValue - is new value for the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSizeUnits

public Layout setSizeUnits(MFString newValue)

Assign typed object value to MFString sizeUnits field, similar to setSizeUnits(String[]).

Parameters:

newValue - is new value for the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSizeUnits

public Layout setSizeUnits(SFString newValue)

Assign single SFString object value to MFString sizeUnits field, similar to setSizeUnits(String[]).

Parameters:

newValue - is new value for the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setSizeUnits

public Layout setSizeUnits(String newValue)

Assign singleton String value to MFString sizeUnits field, similar to setSizeUnits(String[]).

Parameters:

newValue - is new value for the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setSizeUnits

public Layout setSizeUnits(ArrayList<String> newValue)

Assign ArrayList value of MFString sizeUnits field, similar to setSizeUnits(String[]).

Parameters:

newValue - is new value for the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearSizeUnits

public Layout clearSizeUnits()

Utility method to clear MFString value of sizeUnits field. This method does not initialize withSIZEUNITS_DEFAULT_VALUE.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addSizeUnits

public Layout addSizeUnits(String newValue)

Add singleton String value to MFString sizeUnits field.

Parameters:

newValue - is new value to add to the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addSizeUnits

public Layout addSizeUnits(SFString newValue)

Add singleton SFString value to MFString sizeUnits field.

Parameters:

newValue - is new value to add to the sizeUnits field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getDEF

public 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 Layout setDEF(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:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public Layout setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 Layout setUSE(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:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public Layout setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final Layout setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public Layout setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final Layout setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public Layout setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final Layout setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public Layout setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public Layout setUSE(Layout 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:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public Layout addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public Layout addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public Layout addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

Layout - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public 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:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public 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:

• X3D.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 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:

• X3D.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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public 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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)