Package org.web3d.x3d.jsail.Text
Class FontStyleObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Text.FontStyleObject
- All Implemented Interfaces:
X3DNode
,FontStyle
,X3DFontStyleNode
public class FontStyleObject extends X3DConcreteNode implements FontStyle
FontStyle is an X3DFontStyleNode that defines the size, family, justification, and other styles used by Text nodes.
X3D node tooltip: [X3DFontStyleNode] FontStyle is an X3DFontStyleNode that defines the size, family, justification, and other styles used by Text nodes.
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.
X3D node tooltip: [X3DFontStyleNode] FontStyle is an X3DFontStyleNode that defines the size, family, justification, and other styles used by Text nodes.
- Hint: full internationalization (i18n) and localization (l10n) features are available for any written language.
- Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: first add a Text node as a parent node for FontStyle.
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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the FontStyle element: Textstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.util.ArrayList<java.lang.String>
FAMILY_DEFAULT_VALUE
MFString field named family has default quoted value new String[] {"SERIF"} (Java syntax) or quoted value "SERIF" (XML syntax).static java.lang.String
FAMILY_SANS
Tooltip: default font family for sans-serif font such as Helvetica.static java.lang.String
FAMILY_SERIF
Tooltip: default font family for serif font such as Times-Roman.static java.lang.String
FAMILY_TYPEWRITER
Tooltip: default font family for a fixed-pitch font such as Courier.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static boolean
HORIZONTAL_DEFAULT_VALUE
SFBool field named horizontal has default value true (Java syntax) or true (XML syntax).static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
JUSTIFY_BEGIN
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "BEGIN" (Java syntax) or '"BEGIN"' (XML syntax).static java.lang.String
JUSTIFY_BEGIN_BEGIN
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"BEGIN\"" (Java syntax) or '"BEGIN" "BEGIN"' (XML syntax).static java.lang.String
JUSTIFY_BEGIN_END
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"END\"" (Java syntax) or '"BEGIN" "END"' (XML syntax).static java.lang.String
JUSTIFY_BEGIN_FIRST
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"FIRST\"" (Java syntax) or '"BEGIN" "FIRST"' (XML syntax).static java.lang.String
JUSTIFY_BEGIN_MIDDLE
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"MIDDLE\"" (Java syntax) or '"BEGIN" "MIDDLE"' (XML syntax).static java.util.ArrayList<java.lang.String>
JUSTIFY_DEFAULT_VALUE
MFString field named justify has default quoted value new String[] {"BEGIN"} (Java syntax) or quoted value "BEGIN" (XML syntax).static java.lang.String
JUSTIFY_END
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "END" (Java syntax) or '"END"' (XML syntax).static java.lang.String
JUSTIFY_END_BEGIN
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"BEGIN\"" (Java syntax) or '"END" "BEGIN"' (XML syntax).static java.lang.String
JUSTIFY_END_END
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"END\"" (Java syntax) or '"END" "END"' (XML syntax).static java.lang.String
JUSTIFY_END_FIRST
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"FIRST\"" (Java syntax) or '"END" "FIRST"' (XML syntax).static java.lang.String
JUSTIFY_END_MIDDLE
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"MIDDLE\"" (Java syntax) or '"END" "MIDDLE"' (XML syntax).static java.lang.String
JUSTIFY_FIRST
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "FIRST" (Java syntax) or '"FIRST"' (XML syntax).static java.lang.String
JUSTIFY_FIRST_BEGIN
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"BEGIN\"" (Java syntax) or '"FIRST" "BEGIN"' (XML syntax).static java.lang.String
JUSTIFY_FIRST_END
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"END\"" (Java syntax) or '"FIRST" "END"' (XML syntax).static java.lang.String
JUSTIFY_FIRST_FIRST
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"FIRST\"" (Java syntax) or '"FIRST" "FIRST"' (XML syntax).static java.lang.String
JUSTIFY_FIRST_MIDDLE
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"MIDDLE\"" (Java syntax) or '"FIRST" "MIDDLE"' (XML syntax).static java.lang.String
JUSTIFY_MIDDLE
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "MIDDLE" (Java syntax) or '"MIDDLE"' (XML syntax).static java.lang.String
JUSTIFY_MIDDLE_BEGIN
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"BEGIN\"" (Java syntax) or '"MIDDLE" "BEGIN"' (XML syntax).static java.lang.String
JUSTIFY_MIDDLE_END
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"END\"" (Java syntax) or '"MIDDLE" "END"' (XML syntax).static java.lang.String
JUSTIFY_MIDDLE_FIRST
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"FIRST\"" (Java syntax) or '"MIDDLE" "FIRST"' (XML syntax).static java.lang.String
JUSTIFY_MIDDLE_MIDDLE
MFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"MIDDLE\"" (Java syntax) or '"MIDDLE" "MIDDLE"' (XML syntax).static java.lang.String
LANGUAGE_DEFAULT_VALUE
SFString field named language has default value equal to an empty string.static boolean
LEFTTORIGHT_DEFAULT_VALUE
SFBool field named leftToRight has default value true (Java syntax) or true (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Text component level for this element: 1static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: FontStyle.static float
SIZE_DEFAULT_VALUE
SFFloat field named size has default value 1.0f (Java syntax) or 1.0 (XML syntax).static float
SPACING_DEFAULT_VALUE
SFFloat field named spacing has default value 1.0f (Java syntax) or 1.0 (XML syntax).static java.lang.String
STYLE_BOLD
Tooltip: boldface type.static java.lang.String
STYLE_BOLDITALIC
Tooltip: bold and italic type.static java.lang.String
STYLE_DEFAULT_VALUE
SFString field named style has default value "PLAIN" (Java syntax) or PLAIN (XML syntax).static java.lang.String
STYLE_ITALIC
Tooltip: italic type.static java.lang.String
STYLE_PLAIN
Tooltip: default plain type.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static boolean
TOPTOBOTTOM_DEFAULT_VALUE
SFBool field named topToBottom has default value true (Java syntax) or true (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description FontStyleObject()
Constructor for FontStyleObject to initialize member variables with default values.FontStyleObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description FontStyleObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.FontStyleObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.FontStyleObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.FontStyleObject
addFamily(java.lang.String newValue)
Add singleton String value to MFString family field.FontStyleObject
addFamily(SFStringObject newValue)
Add singleton SFStringObject value to MFString family field.FontStyleObject
addJustify(java.lang.String newValue)
Add singleton String value to MFString justify field.FontStyleObject
addJustify(SFStringObject newValue)
Add singleton SFStringObject value to MFString justify field.FontStyleObject
clearFamily()
Utility method to clear MFString value of family field.FontStyleObject
clearIS()
Utility method to clear SFNode value of IS field.FontStyleObject
clearJustify()
Utility method to clear MFString value of justify field.FontStyleObject
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.String
getComponent()
Defines X3D component for the FontStyle element: Textint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: FontStylejava.lang.String[]
getFamily()
Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from initializeOnly MFString field named family.java.util.ArrayList<java.lang.String>
getFamilyList()
Utility method to get ArrayList value of MFString family field, similar togetFamily()
.java.lang.String
getFamilyString()
Utility method to get String value of MFString family field, similar togetFamily()
.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.boolean
getHorizontal()
Provide boolean value from initializeOnly SFBool field named horizontal.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.java.lang.String[]
getJustify()
Provide array of String enumeration results (baseType MFString) ['"MIDDLE"' | '"MIDDLE" "BEGIN"' | '"MIDDLE" "END"' | '"MIDDLE" "FIRST"' | '"MIDDLE" "MIDDLE"' | '"BEGIN"' | '"BEGIN" "BEGIN"' | '"BEGIN" "END"' | '"BEGIN" "FIRST"' | '"BEGIN" "MIDDLE"' | '"END"' | '"END" "BEGIN"' | '"END" "END"' | '"END" "FIRST"' | '"END" "MIDDLE"' | '"FIRST"' | '"FIRST" "BEGIN"' | '"FIRST" "END"' | '"FIRST" "FIRST"' | '"FIRST" "MIDDLE"'] from initializeOnly MFString field named justify.java.util.ArrayList<java.lang.String>
getJustifyList()
Utility method to get ArrayList value of MFString justify field, similar togetJustify()
.java.lang.String
getJustifyString()
Utility method to get String value of MFString justify field, similar togetJustify()
.java.lang.String
getLanguage()
Provide String value from initializeOnly SFString field named language.boolean
getLeftToRight()
Provide boolean value from initializeOnly SFBool field named leftToRight.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
getSize()
Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named size.float
getSpacing()
Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named spacing.java.lang.String
getStyle()
Provide String enumeration value (baseType xs:NMTOKEN) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from initializeOnly SFString field named style.boolean
getTopToBottom()
Provide boolean value from initializeOnly SFBool field named topToBottom.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.FontStyleObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.FontStyleObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.FontStyleObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.FontStyleObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.FontStyleObject
setFamily(java.lang.String newValue)
Assign singleton String value to MFString family field, similar tosetFamily(String[])
.FontStyleObject
setFamily(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to initializeOnly MFString field named family.FontStyleObject
setFamily(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString family field, similar tosetFamily(String[])
.FontStyleObject
setFamily(MFStringObject newValue)
Assign typed object value to MFString family field, similar tosetFamily(String[])
.FontStyleObject
setFamily(SFStringObject newValue)
Assign single SFString object value to MFString family field, similar tosetFamily(String[])
.FontStyleObject
setHorizontal(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named horizontal.FontStyleObject
setHorizontal(SFBoolObject newValue)
Assign typed object value to SFBool horizontal field, similar tosetHorizontal(boolean)
.FontStyleObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.FontStyleObject
setJustify(java.lang.String newValue)
Assign singleton String value to MFString justify field, similar tosetJustify(String[])
.FontStyleObject
setJustify(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""MIDDLE"" | ""MIDDLE" "BEGIN"" | ""MIDDLE" "END"" | ""MIDDLE" "FIRST"" | ""MIDDLE" "MIDDLE"" | ""BEGIN"" | ""BEGIN" "BEGIN"" | ""BEGIN" "END"" | ""BEGIN" "FIRST"" | ""BEGIN" "MIDDLE"" | ""END"" | ""END" "BEGIN"" | ""END" "END"" | ""END" "FIRST"" | ""END" "MIDDLE"" | ""FIRST"" | ""FIRST" "BEGIN"" | ""FIRST" "END"" | ""FIRST" "FIRST"" | ""FIRST" "MIDDLE"") to initializeOnly MFString field named justify.FontStyleObject
setJustify(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString justify field, similar tosetJustify(String[])
.FontStyleObject
setJustify(MFStringObject newValue)
Assign typed object value to MFString justify field, similar tosetJustify(String[])
.FontStyleObject
setJustify(SFStringObject newValue)
Assign single SFString object value to MFString justify field, similar tosetJustify(String[])
.FontStyleObject
setLanguage(java.lang.String newValue)
Accessor method to assign String value to initializeOnly SFString field named language.FontStyleObject
setLanguage(SFStringObject newValue)
Assign typed object value to SFString language field, similar tosetLanguage(String)
.FontStyleObject
setLeftToRight(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named leftToRight.FontStyleObject
setLeftToRight(SFBoolObject newValue)
Assign typed object value to SFBool leftToRight field, similar tosetLeftToRight(boolean)
.FontStyleObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.FontStyleObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.FontStyleObject
setSize(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSize(float)
.FontStyleObject
setSize(float newValue)
Accessor method to assign float value to initializeOnly SFFloat field named size.FontStyleObject
setSize(SFFloatObject newValue)
Assign typed object value to SFFloat size field, similar tosetSize(float)
.FontStyleObject
setSpacing(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpacing(float)
.FontStyleObject
setSpacing(float newValue)
Accessor method to assign float value to initializeOnly SFFloat field named spacing.FontStyleObject
setSpacing(SFFloatObject newValue)
Assign typed object value to SFFloat spacing field, similar tosetSpacing(float)
.FontStyleObject
setStyle(java.lang.String newValue)
Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to initializeOnly SFString field named style.FontStyleObject
setStyle(SFStringObject newValue)
Assign typed object value to SFString style field, similar tosetStyle(String)
.FontStyleObject
setTopToBottom(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named topToBottom.FontStyleObject
setTopToBottom(SFBoolObject newValue)
Assign typed object value to SFBool topToBottom field, similar tosetTopToBottom(boolean)
.FontStyleObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.FontStyleObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.FontStyleObject
setUSE(FontStyleObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
FAMILY_SANS
public static final java.lang.String FAMILY_SANSTooltip: default font family for sans-serif font such as Helvetica. MFString field named family with X3DUOM simpleType fontFamilyValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SANS" (Java syntax) or '"SANS"' (XML syntax). -
FAMILY_SERIF
public static final java.lang.String FAMILY_SERIFTooltip: default font family for serif font such as Times-Roman. MFString field named family with X3DUOM simpleType fontFamilyValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SERIF" (Java syntax) or '"SERIF"' (XML syntax). -
FAMILY_TYPEWRITER
public static final java.lang.String FAMILY_TYPEWRITERTooltip: default font family for a fixed-pitch font such as Courier. MFString field named family with X3DUOM simpleType fontFamilyValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "TYPEWRITER" (Java syntax) or '"TYPEWRITER"' (XML syntax). -
JUSTIFY_MIDDLE
public static final java.lang.String JUSTIFY_MIDDLEMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "MIDDLE" (Java syntax) or '"MIDDLE"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_MIDDLE_BEGIN
public static final java.lang.String JUSTIFY_MIDDLE_BEGINMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"BEGIN\"" (Java syntax) or '"MIDDLE" "BEGIN"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_MIDDLE_END
public static final java.lang.String JUSTIFY_MIDDLE_ENDMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"END\"" (Java syntax) or '"MIDDLE" "END"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_MIDDLE_FIRST
public static final java.lang.String JUSTIFY_MIDDLE_FIRSTMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"FIRST\"" (Java syntax) or '"MIDDLE" "FIRST"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_MIDDLE_MIDDLE
public static final java.lang.String JUSTIFY_MIDDLE_MIDDLEMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"MIDDLE\"" (Java syntax) or '"MIDDLE" "MIDDLE"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_BEGIN
public static final java.lang.String JUSTIFY_BEGINMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "BEGIN" (Java syntax) or '"BEGIN"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_BEGIN_BEGIN
public static final java.lang.String JUSTIFY_BEGIN_BEGINMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"BEGIN\"" (Java syntax) or '"BEGIN" "BEGIN"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_BEGIN_END
public static final java.lang.String JUSTIFY_BEGIN_ENDMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"END\"" (Java syntax) or '"BEGIN" "END"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_BEGIN_FIRST
public static final java.lang.String JUSTIFY_BEGIN_FIRSTMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"FIRST\"" (Java syntax) or '"BEGIN" "FIRST"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_BEGIN_MIDDLE
public static final java.lang.String JUSTIFY_BEGIN_MIDDLEMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"MIDDLE\"" (Java syntax) or '"BEGIN" "MIDDLE"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_END
public static final java.lang.String JUSTIFY_ENDMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "END" (Java syntax) or '"END"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_END_BEGIN
public static final java.lang.String JUSTIFY_END_BEGINMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"BEGIN\"" (Java syntax) or '"END" "BEGIN"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_END_END
public static final java.lang.String JUSTIFY_END_ENDMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"END\"" (Java syntax) or '"END" "END"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_END_FIRST
public static final java.lang.String JUSTIFY_END_FIRSTMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"FIRST\"" (Java syntax) or '"END" "FIRST"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_END_MIDDLE
public static final java.lang.String JUSTIFY_END_MIDDLEMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"END\" \"MIDDLE\"" (Java syntax) or '"END" "MIDDLE"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_FIRST
public static final java.lang.String JUSTIFY_FIRSTMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "FIRST" (Java syntax) or '"FIRST"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_FIRST_BEGIN
public static final java.lang.String JUSTIFY_FIRST_BEGINMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"BEGIN\"" (Java syntax) or '"FIRST" "BEGIN"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_FIRST_END
public static final java.lang.String JUSTIFY_FIRST_ENDMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"END\"" (Java syntax) or '"FIRST" "END"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_FIRST_FIRST
public static final java.lang.String JUSTIFY_FIRST_FIRSTMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"FIRST\"" (Java syntax) or '"FIRST" "FIRST"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
JUSTIFY_FIRST_MIDDLE
public static final java.lang.String JUSTIFY_FIRST_MIDDLEMFString field named justify with X3DUOM simpleType justifyChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"MIDDLE\"" (Java syntax) or '"FIRST" "MIDDLE"' (XML syntax).- See Also:
- XML Schema: justifyChoices, Constant Field Values
-
STYLE_PLAIN
public static final java.lang.String STYLE_PLAINTooltip: default plain type. SFString field named style with X3DUOM simpleType fontStyleChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "PLAIN" (Java syntax) or PLAIN (XML syntax). -
STYLE_BOLD
public static final java.lang.String STYLE_BOLDTooltip: boldface type. SFString field named style with X3DUOM simpleType fontStyleChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "BOLD" (Java syntax) or BOLD (XML syntax). -
STYLE_ITALIC
public static final java.lang.String STYLE_ITALICTooltip: italic type. SFString field named style with X3DUOM simpleType fontStyleChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ITALIC" (Java syntax) or ITALIC (XML syntax). -
STYLE_BOLDITALIC
public static final java.lang.String STYLE_BOLDITALICTooltip: bold and italic type. SFString field named style with X3DUOM simpleType fontStyleChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "BOLDITALIC" (Java syntax) or BOLDITALIC (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: FontStyle.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the FontStyle element: Text- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Text component level for this element: 1- See Also:
- Constant Field Values
-
FAMILY_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> FAMILY_DEFAULT_VALUEMFString field named family has default quoted value new String[] {"SERIF"} (Java syntax) or quoted value "SERIF" (XML syntax). -
HORIZONTAL_DEFAULT_VALUE
public static final boolean HORIZONTAL_DEFAULT_VALUESFBool field named horizontal has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
JUSTIFY_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> JUSTIFY_DEFAULT_VALUEMFString field named justify has default quoted value new String[] {"BEGIN"} (Java syntax) or quoted value "BEGIN" (XML syntax). -
LANGUAGE_DEFAULT_VALUE
public static final java.lang.String LANGUAGE_DEFAULT_VALUESFString field named language has default value equal to an empty string.- See Also:
- Constant Field Values
-
LEFTTORIGHT_DEFAULT_VALUE
public static final boolean LEFTTORIGHT_DEFAULT_VALUESFBool field named leftToRight has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
SIZE_DEFAULT_VALUE
public static final float SIZE_DEFAULT_VALUESFFloat field named size has default value 1.0f (Java syntax) or 1.0 (XML syntax).- See Also:
- Constant Field Values
-
SPACING_DEFAULT_VALUE
public static final float SPACING_DEFAULT_VALUESFFloat field named spacing has default value 1.0f (Java syntax) or 1.0 (XML syntax).- See Also:
- Constant Field Values
-
STYLE_DEFAULT_VALUE
public static final java.lang.String STYLE_DEFAULT_VALUESFString field named style has default value "PLAIN" (Java syntax) or PLAIN (XML syntax).- See Also:
- Constant Field Values
-
TOPTOBOTTOM_DEFAULT_VALUE
public static final boolean TOPTOBOTTOM_DEFAULT_VALUESFBool field named topToBottom has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
-
Constructor Details
-
FontStyleObject
public FontStyleObject()Constructor for FontStyleObject to initialize member variables with default values. -
FontStyleObject
public FontStyleObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: FontStyle- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the FontStyle element: Text- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getFamily
public java.lang.String[] getFamily()Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from initializeOnly MFString field named family.
Tooltip: Array of quoted font family names in preference order, browsers use the first supported family.- Hint: example family array might be "Times" "SERIF"
- Warning: font family support often varies.
- Hint: values with guaranteed support include "SERIF" "SANS" "TYPEWRITER".
- Hint: SERIF and SANS are variable-width fonts (for example, Times Roman and Arial).
- Hint: TYPEWRITER is a fixed-width font (for example, Courier).
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Fontfamilyandstyle for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Available enumeration values for string comparison:SANS
,SERIF
,TYPEWRITER
. -
getFamilyList
public java.util.ArrayList<java.lang.String> getFamilyList()Utility method to get ArrayList value of MFString family field, similar togetFamily()
.- Returns:
- value of family field
-
getFamilyString
public java.lang.String getFamilyString()Utility method to get String value of MFString family field, similar togetFamily()
.- Returns:
- value of family field
-
setFamily
Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to initializeOnly MFString field named family.
Hint: authors have option to choose from an extendible list of predefined enumeration values (SANS
,SERIF
,TYPEWRITER
).
Tooltip: Array of quoted font family names in preference order, browsers use the first supported family.- Hint: example family array might be "Times" "SERIF"
- Warning: font family support often varies.
- Hint: values with guaranteed support include "SERIF" "SANS" "TYPEWRITER".
- Hint: SERIF and SANS are variable-width fonts (for example, Times Roman and Arial).
- Hint: TYPEWRITER is a fixed-width font (for example, Courier).
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Fontfamilyandstyle for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
setFamily
in interfaceFontStyle
- Parameters:
newValue
- is new value for the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFamily
Assign typed object value to MFString family field, similar tosetFamily(String[])
.- Parameters:
newValue
- is new value for the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFamily
Assign single SFString object value to MFString family field, similar tosetFamily(String[])
.- Parameters:
newValue
- is new value for the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setFamily
Assign singleton String value to MFString family field, similar tosetFamily(String[])
.- Parameters:
newValue
- is new value for the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setFamily
Assign ArrayList value of MFString family field, similar tosetFamily(String[])
.- Parameters:
newValue
- is new value for the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearFamily
Utility method to clear MFString value of family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addFamily
Add singleton String value to MFString family field.- Parameters:
newValue
- is new value to add to the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addFamily
Add singleton SFStringObject value to MFString family field.- Parameters:
newValue
- is new value to add to the family field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getHorizontal
public boolean getHorizontal()Provide boolean value from initializeOnly SFBool field named horizontal.
Tooltip: Whether text direction is horizontal (true) or vertical (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
getHorizontal
in interfaceFontStyle
- Returns:
- value of horizontal field
-
setHorizontal
Accessor method to assign boolean value to initializeOnly SFBool field named horizontal.
Tooltip: Whether text direction is horizontal (true) or vertical (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
setHorizontal
in interfaceFontStyle
- Parameters:
newValue
- is new value for the horizontal field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setHorizontal
Assign typed object value to SFBool horizontal field, similar tosetHorizontal(boolean)
.- Parameters:
newValue
- is new value for the horizontal field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
FontStyleObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
FontStyleObject
- 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()
-
getJustify
public java.lang.String[] getJustify()Provide array of String enumeration results (baseType MFString) ['"MIDDLE"' | '"MIDDLE" "BEGIN"' | '"MIDDLE" "END"' | '"MIDDLE" "FIRST"' | '"MIDDLE" "MIDDLE"' | '"BEGIN"' | '"BEGIN" "BEGIN"' | '"BEGIN" "END"' | '"BEGIN" "FIRST"' | '"BEGIN" "MIDDLE"' | '"END"' | '"END" "BEGIN"' | '"END" "END"' | '"END" "FIRST"' | '"END" "MIDDLE"' | '"FIRST"' | '"FIRST" "BEGIN"' | '"FIRST" "END"' | '"FIRST" "FIRST"' | '"FIRST" "MIDDLE"'] from initializeOnly MFString field named justify.
Tooltip: The justify field determines alignment of the above text layout relative to the origin of the object coordinate system.- Hint: preferred value is usually justify=' "MIDDLE" "MIDDLE" ' for centered justification horizontally and vertically.
- Warning: exactly two string values are provided for major and minor axis alignment.
- Warning: do not use illegal values such as LEFT RIGHT TOP BOTTOM or CENTER.
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification for details.
Available enumeration values for string comparison:MIDDLE
,MIDDLE_BEGIN
,MIDDLE_END
,MIDDLE_FIRST
,MIDDLE_MIDDLE
,BEGIN
,BEGIN_BEGIN
,BEGIN_END
,BEGIN_FIRST
,BEGIN_MIDDLE
,END
,END_BEGIN
,END_END
,END_FIRST
,END_MIDDLE
,FIRST
,FIRST_BEGIN
,FIRST_END
,FIRST_FIRST
,FIRST_MIDDLE
.- Specified by:
getJustify
in interfaceFontStyle
- Returns:
- value of justify field
-
getJustifyList
public java.util.ArrayList<java.lang.String> getJustifyList()Utility method to get ArrayList value of MFString justify field, similar togetJustify()
.- Returns:
- value of justify field
-
getJustifyString
public java.lang.String getJustifyString()Utility method to get String value of MFString justify field, similar togetJustify()
.- Returns:
- value of justify field
-
setJustify
Accessor method to assign String enumeration array (""MIDDLE"" | ""MIDDLE" "BEGIN"" | ""MIDDLE" "END"" | ""MIDDLE" "FIRST"" | ""MIDDLE" "MIDDLE"" | ""BEGIN"" | ""BEGIN" "BEGIN"" | ""BEGIN" "END"" | ""BEGIN" "FIRST"" | ""BEGIN" "MIDDLE"" | ""END"" | ""END" "BEGIN"" | ""END" "END"" | ""END" "FIRST"" | ""END" "MIDDLE"" | ""FIRST"" | ""FIRST" "BEGIN"" | ""FIRST" "END"" | ""FIRST" "FIRST"" | ""FIRST" "MIDDLE"") to initializeOnly MFString field named justify.
Warning: authors can only choose from a strict list of enumeration values (MIDDLE
,MIDDLE_BEGIN
,MIDDLE_END
,MIDDLE_FIRST
,MIDDLE_MIDDLE
,BEGIN
,BEGIN_BEGIN
,BEGIN_END
,BEGIN_FIRST
,BEGIN_MIDDLE
,END
,END_BEGIN
,END_END
,END_FIRST
,END_MIDDLE
,FIRST
,FIRST_BEGIN
,FIRST_END
,FIRST_FIRST
,FIRST_MIDDLE
).
Tooltip: The justify field determines alignment of the above text layout relative to the origin of the object coordinate system.- Hint: preferred value is usually justify=' "MIDDLE" "MIDDLE" ' for centered justification horizontally and vertically.
- Warning: exactly two string values are provided for major and minor axis alignment.
- Warning: do not use illegal values such as LEFT RIGHT TOP BOTTOM or CENTER.
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification for details.
- Specified by:
setJustify
in interfaceFontStyle
- Parameters:
newValue
- is new value for the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJustify
Assign typed object value to MFString justify field, similar tosetJustify(String[])
.- Parameters:
newValue
- is new value for the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJustify
Assign single SFString object value to MFString justify field, similar tosetJustify(String[])
.- Parameters:
newValue
- is new value for the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setJustify
Assign singleton String value to MFString justify field, similar tosetJustify(String[])
.- Parameters:
newValue
- is new value for the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setJustify
Assign ArrayList value of MFString justify field, similar tosetJustify(String[])
.- Parameters:
newValue
- is new value for the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearJustify
Utility method to clear MFString value of justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addJustify
Add singleton String value to MFString justify field.- Parameters:
newValue
- is new value to add to the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addJustify
Add singleton SFStringObject value to MFString justify field.- Parameters:
newValue
- is new value to add to the justify field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getLanguage
public java.lang.String getLanguage()Provide String value from initializeOnly SFString field named language.
Tooltip: Language codes consist of a primary code and a (possibly empty) series of subcodes. [ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved for language abbreviations. Two-letter primary codes include en (English), fr (French), de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese), ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur (Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see ISO639.2 Codes for the Representation of Names of Languages http://www.loc.gov/standards/iso639-2/php/code_list.php
- Hint: see RFC3066 Tags for the Identification of Languages http://tools.ietf.org/html/rfc3066
- Hint: see ISO3166 or http://xml.coverpages.org/languageIdentifiers.html
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
getLanguage
in interfaceFontStyle
- Returns:
- value of language field
-
setLanguage
Accessor method to assign String value to initializeOnly SFString field named language.
Tooltip: Language codes consist of a primary code and a (possibly empty) series of subcodes. [ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved for language abbreviations. Two-letter primary codes include en (English), fr (French), de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese), ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur (Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see ISO639.2 Codes for the Representation of Names of Languages http://www.loc.gov/standards/iso639-2/php/code_list.php
- Hint: see RFC3066 Tags for the Identification of Languages http://tools.ietf.org/html/rfc3066
- Hint: see ISO3166 or http://xml.coverpages.org/languageIdentifiers.html
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
setLanguage
in interfaceFontStyle
- Parameters:
newValue
- is new value for the language field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLanguage
Assign typed object value to SFString language field, similar tosetLanguage(String)
.- Parameters:
newValue
- is new value for the language field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getLeftToRight
public boolean getLeftToRight()Provide boolean value from initializeOnly SFBool field named leftToRight.- Specified by:
getLeftToRight
in interfaceFontStyle
- Returns:
- value of leftToRight field
-
setLeftToRight
Accessor method to assign boolean value to initializeOnly SFBool field named leftToRight.- Specified by:
setLeftToRight
in interfaceFontStyle
- Parameters:
newValue
- is new value for the leftToRight field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLeftToRight
Assign typed object value to SFBool leftToRight field, similar tosetLeftToRight(boolean)
.- Parameters:
newValue
- is new value for the leftToRight field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceFontStyle
- Specified by:
getMetadata
in interfaceX3DFontStyleNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceFontStyle
- Specified by:
setMetadata
in interfaceX3DFontStyleNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getSize
public float getSize()Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named size.
Tooltip: (0,+infinity) Nominal height (in local coordinate system) of text glyphs Also sets default spacing between adjacent lines of text. * -
setSize
Accessor method to assign float value to initializeOnly SFFloat field named size.
Tooltip: (0,+infinity) Nominal height (in local coordinate system) of text glyphs Also sets default spacing between adjacent lines of text. *- Specified by:
setSize
in interfaceFontStyle
- Parameters:
newValue
- is new value for the size field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSize
Assign typed object value to SFFloat size field, similar tosetSize(float)
.- Parameters:
newValue
- is new value for the size field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSize
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSize(float)
.- Parameters:
newValue
- is new value for field- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSpacing
public float getSpacing()Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named spacing.
Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text. *- Specified by:
getSpacing
in interfaceFontStyle
- Returns:
- value of spacing field
-
setSpacing
Accessor method to assign float value to initializeOnly SFFloat field named spacing.
Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text. *- Specified by:
setSpacing
in interfaceFontStyle
- Parameters:
newValue
- is new value for the spacing field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpacing
Assign typed object value to SFFloat spacing field, similar tosetSpacing(float)
.- Parameters:
newValue
- is new value for the spacing field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpacing
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpacing(float)
.- Parameters:
newValue
- is new value for field- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStyle
public java.lang.String getStyle()Provide String enumeration value (baseType xs:NMTOKEN) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from initializeOnly SFString field named style.
Tooltip: Pick one of four values for text style.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Fontfamilyandstyle for details.
Available enumeration values for string comparison:PLAIN
,BOLD
,ITALIC
,BOLDITALIC
. -
setStyle
Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to initializeOnly SFString field named style.
Warning: authors can only choose from a strict list of enumeration values (PLAIN
,BOLD
,ITALIC
,BOLDITALIC
).
Tooltip: Pick one of four values for text style.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Fontfamilyandstyle for details.
- Specified by:
setStyle
in interfaceFontStyle
- Parameters:
newValue
- is new value for the style field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStyle
Assign typed object value to SFString style field, similar tosetStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTopToBottom
public boolean getTopToBottom()Provide boolean value from initializeOnly SFBool field named topToBottom.
Tooltip: Whether text direction is top-to-bottom (true) or bottom-to-top (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
getTopToBottom
in interfaceFontStyle
- Returns:
- value of topToBottom field
-
setTopToBottom
Accessor method to assign boolean value to initializeOnly SFBool field named topToBottom.
Tooltip: Whether text direction is top-to-bottom (true) or bottom-to-top (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Specified by:
setTopToBottom
in interfaceFontStyle
- Parameters:
newValue
- is new value for the topToBottom field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTopToBottom
Assign typed object value to SFBool topToBottom field, similar tosetTopToBottom(boolean)
.- Parameters:
newValue
- is new value for the topToBottom field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
FontStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-