Class ScreenFontStyle

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Layout.ScreenFontStyle

All Implemented Interfaces:

X3DNode, ScreenFontStyle, X3DFontStyleNode

public class ScreenFontStyle
extends X3DConcreteNode
implements ScreenFontStyle

ScreenFontStyle is an X3DFontStyleNode defines the size, family, justification, and other styles used within a screen layout.

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. ScreenFontStyle node tooltip: (X3D version 3.2 or later) [X3DFontStyleNode] ScreenFontStyle is an X3DFontStyleNode defines the size, family, justification, and other styles used within a screen layout. ScreenFontStyle renders text so that it appears identical to typical 2D applications by specifying pointSize in points (as in 2D document layout) rather than size in meters. Each glyph of text is rendered as a quadrilateral with a texture applied.

• Hint: first add a Text node as a parent.
• Hint: Wikipedia https://en.wikipedia.org/wiki/Font
• Hint: Wikipedia https://en.wikipedia.org/wiki/Typeface

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ScreenFontStyle element: Layout
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final ArrayList<String>	FAMILY_DEFAULT_VALUE	MFString field named family has default quoted value new String[] {"SERIF"} (Java syntax) or quoted value "SERIF" (XML syntax).
static final String	FAMILY_SANS	Tooltip: default font family for sans-serif font such as Helvetica.
static final String	FAMILY_SERIF	Tooltip: default font family for serif font such as Times-Roman.
static final String	FAMILY_TYPEWRITER	Tooltip: default font family for a fixed-pitch font such as Courier.
static final String	fromField_FAMILY	fromField ROUTE name for MFString field named family.
static final String	fromField_HORIZONTAL	fromField ROUTE name for SFBool field named horizontal.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_JUSTIFY	fromField ROUTE name for MFString field named justify.
static final String	fromField_LANGUAGE	fromField ROUTE name for SFString field named language.
static final String	fromField_LEFTTORIGHT	fromField ROUTE name for SFBool field named leftToRight.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_POINTSIZE	fromField ROUTE name for SFFloat field named pointSize.
static final String	fromField_SPACING	fromField ROUTE name for SFFloat field named spacing.
static final String	fromField_STYLE	fromField ROUTE name for SFString field named style.
static final String	fromField_TOPTOBOTTOM	fromField ROUTE name for SFBool field named topToBottom.
static final boolean	HORIZONTAL_DEFAULT_VALUE	SFBool field named horizontal has default value true (Java syntax) or true (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final 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 final 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 final 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 final 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 final 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 final ArrayList<String>	JUSTIFY_DEFAULT_VALUE	MFString field named justify has default quoted value new String[] {"BEGIN"} (Java syntax) or quoted value "BEGIN" (XML syntax).
static final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final String	LANGUAGE_DEFAULT_VALUE	SFString field named language has default value equal to an empty string.
static final boolean	LEFTTORIGHT_DEFAULT_VALUE	SFBool field named leftToRight has default value true (Java syntax) or true (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Layout component level for this element: 2
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: ScreenFontStyle.
static final float	POINTSIZE_DEFAULT_VALUE	SFFloat field named pointSize has default value 12.0f (Java syntax) or 12.0 (XML syntax).
static final float	SPACING_DEFAULT_VALUE	SFFloat field named spacing has default value 1.0f (Java syntax) or 1.0 (XML syntax).
static final String	STYLE_BOLD	Tooltip: boldface type.
static final String	STYLE_BOLDITALIC	Tooltip: bold and italic type.
static final String	STYLE_DEFAULT_VALUE	SFString field named style has default value "PLAIN" (Java syntax) or PLAIN (XML syntax).
static final String	STYLE_ITALIC	Tooltip: italic type.
static final String	STYLE_PLAIN	Tooltip: default plain type.
static final String	toField_FAMILY	toField ROUTE name for MFString field named family.
static final String	toField_HORIZONTAL	toField ROUTE name for SFBool field named horizontal.
static final String	toField_JUSTIFY	toField ROUTE name for MFString field named justify.
static final String	toField_LANGUAGE	toField ROUTE name for SFString field named language.
static final String	toField_LEFTTORIGHT	toField ROUTE name for SFBool field named leftToRight.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_POINTSIZE	toField ROUTE name for SFFloat field named pointSize.
static final String	toField_SPACING	toField ROUTE name for SFFloat field named spacing.
static final String	toField_STYLE	toField ROUTE name for SFString field named style.
static final String	toField_TOPTOBOTTOM	toField ROUTE name for SFBool field named topToBottom.
static final 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

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, validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ScreenFontStyle	addComments(String newComment)	Add comment as String to contained commentsList.
ScreenFontStyle	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ScreenFontStyle	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ScreenFontStyle	addFamily(String newValue)	Add singleton String value to MFString family field.
ScreenFontStyle	addFamily(SFString newValue)	Add singleton SFString value to MFString family field.
ScreenFontStyle	addJustify(String newValue)	Add singleton String value to MFString justify field.
ScreenFontStyle	addJustify(SFString newValue)	Add singleton SFString value to MFString justify field.
ScreenFontStyle	clearFamily()	Utility method to clear MFString value of family field.
ScreenFontStyle	clearIS()	Utility method to clear SFNode value of IS field.
ScreenFontStyle	clearJustify()	Utility method to clear MFString value of justify field.
ScreenFontStyle	clearMetadata()	Utility method to clear SFNode value of metadata 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.
final String	getComponent()	Defines X3D component for the ScreenFontStyle element: Layout
final int	getComponentLevel()	Provides default X3D component level for this element: 2
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	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: ScreenFontStyle
String[]	getFamily()	Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from inputOutput MFString field named family.
ArrayList<String>	getFamilyList()	Utility method to get ArrayList value of MFString family field, similar to getFamily().
String	getFamilyString()	Utility method to get String value of MFString family field, similar to getFamily().
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
boolean	getHorizontal()	Provide boolean value from inputOutput SFBool field named horizontal.
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.
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 inputOutput MFString field named justify.
ArrayList<String>	getJustifyList()	Utility method to get ArrayList value of MFString justify field, similar to getJustify().
String	getJustifyString()	Utility method to get String value of MFString justify field, similar to getJustify().
String	getLanguage()	Provide String value from inputOutput SFString field named language.
boolean	getLeftToRight()	Provide boolean value from inputOutput SFBool field named leftToRight.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getPointSize()	Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pointSize.
float	getSpacing()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named spacing.
String	getStyle()	Provide String enumeration value (baseType xs:NMTOKEN) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from inputOutput SFString field named style.
boolean	getTopToBottom()	Provide boolean value from inputOutput SFBool field named topToBottom.
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.
final ScreenFontStyle	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ScreenFontStyle	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ScreenFontStyle	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ScreenFontStyle	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ScreenFontStyle	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ScreenFontStyle	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
ScreenFontStyle	setFamily(String newValue)	Assign singleton String value to MFString family field, similar to setFamily(String[]).
ScreenFontStyle	setFamily(String[] newValue)	Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to inputOutput MFString field named family.
ScreenFontStyle	setFamily(ArrayList<String> newValue)	Assign ArrayList value of MFString family field, similar to setFamily(String[]).
ScreenFontStyle	setFamily(MFString newValue)	Assign typed object value to MFString family field, similar to setFamily(String[]).
ScreenFontStyle	setFamily(SFString newValue)	Assign single SFString object value to MFString family field, similar to setFamily(String[]).
ScreenFontStyle	setHorizontal(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named horizontal.
ScreenFontStyle	setHorizontal(SFBool newValue)	Assign typed object value to SFBool horizontal field, similar to setHorizontal(boolean).
final ScreenFontStyle	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ScreenFontStyle	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ScreenFontStyle	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ScreenFontStyle	setJustify(String newValue)	Assign singleton String value to MFString justify field, similar to setJustify(String[]).
ScreenFontStyle	setJustify(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 inputOutput MFString field named justify.
ScreenFontStyle	setJustify(ArrayList<String> newValue)	Assign ArrayList value of MFString justify field, similar to setJustify(String[]).
ScreenFontStyle	setJustify(MFString newValue)	Assign typed object value to MFString justify field, similar to setJustify(String[]).
ScreenFontStyle	setJustify(SFString newValue)	Assign single SFString object value to MFString justify field, similar to setJustify(String[]).
ScreenFontStyle	setLanguage(String newValue)	Accessor method to assign String value to inputOutput SFString field named language.
ScreenFontStyle	setLanguage(SFString newValue)	Assign typed object value to SFString language field, similar to setLanguage(String).
ScreenFontStyle	setLeftToRight(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named leftToRight.
ScreenFontStyle	setLeftToRight(SFBool newValue)	Assign typed object value to SFBool leftToRight field, similar to setLeftToRight(boolean).
ScreenFontStyle	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ScreenFontStyle	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ScreenFontStyle	setPointSize(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPointSize(float).
ScreenFontStyle	setPointSize(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named pointSize.
ScreenFontStyle	setPointSize(SFFloat newValue)	Assign typed object value to SFFloat pointSize field, similar to setPointSize(float).
ScreenFontStyle	setSpacing(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpacing(float).
ScreenFontStyle	setSpacing(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named spacing.
ScreenFontStyle	setSpacing(SFFloat newValue)	Assign typed object value to SFFloat spacing field, similar to setSpacing(float).
ScreenFontStyle	setStyle(String newValue)	Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to inputOutput SFString field named style.
ScreenFontStyle	setStyle(SFString newValue)	Assign typed object value to SFString style field, similar to setStyle(String).
ScreenFontStyle	setTopToBottom(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named topToBottom.
ScreenFontStyle	setTopToBottom(SFBool newValue)	Assign typed object value to SFBool topToBottom field, similar to setTopToBottom(boolean).
final ScreenFontStyle	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ScreenFontStyle	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
ScreenFontStyle	setUSE(ScreenFontStyle 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, getCssStyle, 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

FAMILY_SANS

public static final String FAMILY_SANS

Tooltip: 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).

See Also:

• XML Schema: fontFamilyValues
• Constant Field Values

FAMILY_SERIF

public static final String FAMILY_SERIF

Tooltip: 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).

See Also:

• XML Schema: fontFamilyValues
• Constant Field Values

FAMILY_TYPEWRITER

public static final String FAMILY_TYPEWRITER

Tooltip: 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).

See Also:

• XML Schema: fontFamilyValues
• Constant Field Values

JUSTIFY_MIDDLE

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_MIDDLE_BEGIN

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_MIDDLE_END

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_MIDDLE_FIRST

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_MIDDLE_MIDDLE

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_BEGIN

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_BEGIN_BEGIN

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_BEGIN_END

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_BEGIN_FIRST

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_BEGIN_MIDDLE

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_END

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_END_BEGIN

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_END_END

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_END_FIRST

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_END_MIDDLE

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_FIRST

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_FIRST_BEGIN

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_FIRST_END

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_FIRST_FIRST

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

JUSTIFY_FIRST_MIDDLE

public static final 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).

See Also:

• XML Schema: justifyChoices
• Constant Field Values

STYLE_PLAIN

public static final String STYLE_PLAIN

Tooltip: 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).

See Also:

• XML Schema: fontStyleChoices
• Constant Field Values

STYLE_BOLD

public static final String STYLE_BOLD

Tooltip: 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).

See Also:

• XML Schema: fontStyleChoices
• Constant Field Values

STYLE_ITALIC

public static final String STYLE_ITALIC

Tooltip: 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).

See Also:

• XML Schema: fontStyleChoices
• Constant Field Values

STYLE_BOLDITALIC

public static final String STYLE_BOLDITALIC

Tooltip: 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).

See Also:

• XML Schema: fontStyleChoices
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: ScreenFontStyle.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

See Also:

• Constant Field Values

FAMILY_DEFAULT_VALUE

public static final ArrayList<String> FAMILY_DEFAULT_VALUE

MFString 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_VALUE

SFBool field named horizontal has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

JUSTIFY_DEFAULT_VALUE

public static final ArrayList<String> JUSTIFY_DEFAULT_VALUE

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

LANGUAGE_DEFAULT_VALUE

public static final String LANGUAGE_DEFAULT_VALUE

SFString 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_VALUE

SFBool field named leftToRight has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

POINTSIZE_DEFAULT_VALUE

public static final float POINTSIZE_DEFAULT_VALUE

SFFloat field named pointSize has default value 12.0f (Java syntax) or 12.0 (XML syntax).

See Also:

• Constant Field Values

SPACING_DEFAULT_VALUE

public static final float SPACING_DEFAULT_VALUE

SFFloat 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 String STYLE_DEFAULT_VALUE

SFString 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_VALUE

SFBool field named topToBottom has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

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 = "fontStyle";
containerField_ALLOWED_VALUES = {"fontStyle" }; 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_FAMILY

public static final String fromField_FAMILY

fromField ROUTE name for MFString field named family.

See Also:

• Constant Field Values

toField_FAMILY

public static final String toField_FAMILY

toField ROUTE name for MFString field named family.

See Also:

• Constant Field Values

fromField_HORIZONTAL

public static final String fromField_HORIZONTAL

fromField ROUTE name for SFBool field named horizontal.

See Also:

• Constant Field Values

toField_HORIZONTAL

public static final String toField_HORIZONTAL

toField ROUTE name for SFBool field named horizontal.

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_JUSTIFY

public static final String fromField_JUSTIFY

fromField ROUTE name for MFString field named justify.

See Also:

• Constant Field Values

toField_JUSTIFY

public static final String toField_JUSTIFY

toField ROUTE name for MFString field named justify.

See Also:

• Constant Field Values

fromField_LANGUAGE

public static final String fromField_LANGUAGE

fromField ROUTE name for SFString field named language.

See Also:

• Constant Field Values

toField_LANGUAGE

public static final String toField_LANGUAGE

toField ROUTE name for SFString field named language.

See Also:

• Constant Field Values

fromField_LEFTTORIGHT

public static final String fromField_LEFTTORIGHT

fromField ROUTE name for SFBool field named leftToRight.

See Also:

• Constant Field Values

toField_LEFTTORIGHT

public static final String toField_LEFTTORIGHT

toField ROUTE name for SFBool field named leftToRight.

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_POINTSIZE

public static final String fromField_POINTSIZE

fromField ROUTE name for SFFloat field named pointSize.

See Also:

• Constant Field Values

toField_POINTSIZE

public static final String toField_POINTSIZE

toField ROUTE name for SFFloat field named pointSize.

See Also:

• Constant Field Values

fromField_SPACING

public static final String fromField_SPACING

fromField ROUTE name for SFFloat field named spacing.

See Also:

• Constant Field Values

toField_SPACING

public static final String toField_SPACING

toField ROUTE name for SFFloat field named spacing.

See Also:

• Constant Field Values

fromField_STYLE

public static final String fromField_STYLE

fromField ROUTE name for SFString field named style.

See Also:

• Constant Field Values

toField_STYLE

public static final String toField_STYLE

toField ROUTE name for SFString field named style.

See Also:

• Constant Field Values

fromField_TOPTOBOTTOM

public static final String fromField_TOPTOBOTTOM

fromField ROUTE name for SFBool field named topToBottom.

See Also:

• Constant Field Values

toField_TOPTOBOTTOM

public static final String toField_TOPTOBOTTOM

toField ROUTE name for SFBool field named topToBottom.

See Also:

• Constant Field Values

Constructor Details

ScreenFontStyle

public ScreenFontStyle()

Constructor for ScreenFontStyle to initialize member variables with default values.

ScreenFontStyle

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ScreenFontStyle 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: 2

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

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

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

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

getFamily

public String[] getFamily()

Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from inputOutput 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Available enumeration values for string comparison: SANS, SERIF, TYPEWRITER.

Specified by:

getFamily in interface ScreenFontStyle

Returns:

value of family field

getFamilyList

public ArrayList<String> getFamilyList()

Utility method to get ArrayList value of MFString family field, similar to getFamily().

Returns:

value of family field

getFamilyString

public String getFamilyString()

Utility method to get String value of MFString family field, similar to getFamily().

Returns:

value of family field

setFamily

public ScreenFontStyle setFamily(String[] newValue)

Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to inputOutput 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setFamily in interface ScreenFontStyle

Parameters:

newValue - is new value for the family field.

Returns:

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

setFamily

public ScreenFontStyle setFamily(MFString newValue)

Assign typed object value to MFString family field, similar to setFamily(String[]).

Parameters:

newValue - is new value for the family field.

Returns:

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

setFamily

public ScreenFontStyle setFamily(SFString newValue)

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

Parameters:

newValue - is new value for the family field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setFamily

public ScreenFontStyle setFamily(String newValue)

Assign singleton String value to MFString family field, similar to setFamily(String[]).

Parameters:

newValue - is new value for the family field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setFamily

public ScreenFontStyle setFamily(ArrayList<String> newValue)

Assign ArrayList value of MFString family field, similar to setFamily(String[]).

Parameters:

newValue - is new value for the family field.

Returns:

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

clearFamily

public ScreenFontStyle clearFamily()

Utility method to clear MFString value of family field. This method does not initialize withFAMILY_DEFAULT_VALUE.

Returns:

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

addFamily

public ScreenFontStyle addFamily(String newValue)

Add singleton String value to MFString family field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addFamily

public ScreenFontStyle addFamily(SFString newValue)

Add singleton SFString value to MFString family field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getHorizontal

public boolean getHorizontal()

Provide boolean value from inputOutput 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

getHorizontal in interface ScreenFontStyle

Returns:

value of horizontal field

setHorizontal

public ScreenFontStyle setHorizontal(boolean newValue)

Accessor method to assign boolean value to inputOutput 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setHorizontal in interface ScreenFontStyle

Parameters:

newValue - is new value for the horizontal field.

Returns:

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

setHorizontal

public ScreenFontStyle setHorizontal(SFBool newValue)

Assign typed object value to SFBool horizontal field, similar to setHorizontal(boolean).

Parameters:

newValue - is new value for the horizontal field.

Returns:

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

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

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

ScreenFontStyle - 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 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 inputOutput MFString field named justify.

Tooltip: The justify field determines horizontal and vertical alignment of 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

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 interface ScreenFontStyle

Returns:

value of justify field

getJustifyList

public ArrayList<String> getJustifyList()

Utility method to get ArrayList value of MFString justify field, similar to getJustify().

Returns:

value of justify field

getJustifyString

public String getJustifyString()

Utility method to get String value of MFString justify field, similar to getJustify().

Returns:

value of justify field

setJustify

public ScreenFontStyle setJustify(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 inputOutput 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 horizontal and vertical alignment of 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setJustify in interface ScreenFontStyle

Parameters:

newValue - is new value for the justify field.

Returns:

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

setJustify

public ScreenFontStyle setJustify(MFString newValue)

Assign typed object value to MFString justify field, similar to setJustify(String[]).

Parameters:

newValue - is new value for the justify field.

Returns:

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

setJustify

public ScreenFontStyle setJustify(SFString newValue)

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

Parameters:

newValue - is new value for the justify field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setJustify

public ScreenFontStyle setJustify(String newValue)

Assign singleton String value to MFString justify field, similar to setJustify(String[]).

Parameters:

newValue - is new value for the justify field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setJustify

public ScreenFontStyle setJustify(ArrayList<String> newValue)

Assign ArrayList value of MFString justify field, similar to setJustify(String[]).

Parameters:

newValue - is new value for the justify field.

Returns:

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

clearJustify

public ScreenFontStyle clearJustify()

Utility method to clear MFString value of justify field. This method does not initialize withJUSTIFY_DEFAULT_VALUE.

Returns:

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

addJustify

public ScreenFontStyle addJustify(String newValue)

Add singleton String value to MFString justify field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addJustify

public ScreenFontStyle addJustify(SFString newValue)

Add singleton SFString value to MFString justify field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getLanguage

public String getLanguage()

Provide String value from inputOutput 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 https://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
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

getLanguage in interface ScreenFontStyle

Returns:

value of language field

setLanguage

public ScreenFontStyle setLanguage(String newValue)

Accessor method to assign String value to inputOutput 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 https://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
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setLanguage in interface ScreenFontStyle

Parameters:

newValue - is new value for the language field.

Returns:

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

setLanguage

public ScreenFontStyle setLanguage(SFString newValue)

Assign typed object value to SFString language field, similar to setLanguage(String).

Parameters:

newValue - is new value for the language field.

Returns:

ScreenFontStyle - 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 inputOutput SFBool field named leftToRight.

Tooltip: Whether text direction is left-to-right (true) or right-to-left (false).

• Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

getLeftToRight in interface ScreenFontStyle

Returns:

value of leftToRight field

setLeftToRight

public ScreenFontStyle setLeftToRight(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named leftToRight.

Tooltip: Whether text direction is left-to-right (true) or right-to-left (false).

• Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setLeftToRight in interface ScreenFontStyle

Parameters:

newValue - is new value for the leftToRight field.

Returns:

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

setLeftToRight

public ScreenFontStyle setLeftToRight(SFBool newValue)

Assign typed object value to SFBool leftToRight field, similar to setLeftToRight(boolean).

Parameters:

newValue - is new value for the leftToRight field.

Returns:

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

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 ScreenFontStyle

Specified by:

getMetadata in interface X3DFontStyleNode

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 ScreenFontStyle 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 ScreenFontStyle

Specified by:

setMetadata in interface X3DFontStyleNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

ScreenFontStyle - 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 ScreenFontStyle clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

ScreenFontStyle - 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

getPointSize

public float getPointSize()

Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pointSize.

Tooltip: (0,+infinity) pointSize field specifies the size of text in points. Nominal height (in local coordinate system) of text glyphs, also sets default spacing between adjacent lines of text.

• Hint: pointSize replaces the size field of the FontStyle node.
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

getPointSize in interface ScreenFontStyle

Returns:

value of pointSize field

setPointSize

public ScreenFontStyle setPointSize(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named pointSize.

Tooltip: (0,+infinity) pointSize field specifies the size of text in points. Nominal height (in local coordinate system) of text glyphs, also sets default spacing between adjacent lines of text.

• Hint: pointSize replaces the size field of the FontStyle node.
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setPointSize in interface ScreenFontStyle

Parameters:

newValue - is new value for the pointSize field.

Returns:

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

setPointSize

public ScreenFontStyle setPointSize(SFFloat newValue)

Assign typed object value to SFFloat pointSize field, similar to setPointSize(float).

Parameters:

newValue - is new value for the pointSize field.

Returns:

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

setPointSize

public ScreenFontStyle setPointSize(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPointSize(float).

Parameters:

newValue - is new value for field

Returns:

ScreenFontStyle - 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 inputOutput SFFloat field named spacing.

Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text.

• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

getSpacing in interface ScreenFontStyle

Returns:

value of spacing field

setSpacing

public ScreenFontStyle setSpacing(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named spacing.

Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text.

• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setSpacing in interface ScreenFontStyle

Parameters:

newValue - is new value for the spacing field.

Returns:

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

setSpacing

public ScreenFontStyle setSpacing(SFFloat newValue)

Assign typed object value to SFFloat spacing field, similar to setSpacing(float).

Parameters:

newValue - is new value for the spacing field.

Returns:

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

setSpacing

public ScreenFontStyle setSpacing(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpacing(float).

Parameters:

newValue - is new value for field

Returns:

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

getStyle

public String getStyle()

Provide String enumeration value (baseType xs:NMTOKEN) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from inputOutput SFString field named style.

Tooltip: Pick one of four values for text style (PLAIN|BOLD|ITALIC|BOLDITALIC).

• Warning: overloaded name for CSS style attribute.
• 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
• Hint: overlapping functionality with CSS style attribute provides a "best of both worlds" approach. The style attribute provides an inline block of CSS source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
• Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
• Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
• Hint: CSS Snapshot https://www.w3.org/TR/css-2018
• Hint: https://www.w3.org/TR/css-style-attr
• Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets

Available enumeration values for string comparison: PLAIN, BOLD, ITALIC, BOLDITALIC.

Specified by:

getStyle in interface ScreenFontStyle

Returns:

value of style field

setStyle

public ScreenFontStyle setStyle(String newValue)

Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to inputOutput 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 (PLAIN|BOLD|ITALIC|BOLDITALIC).

• Warning: overloaded name for CSS style attribute.
• 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
• Hint: overlapping functionality with CSS style attribute provides a "best of both worlds" approach. The style attribute provides an inline block of CSS source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
• Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
• Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
• Hint: CSS Snapshot https://www.w3.org/TR/css-2018
• Hint: https://www.w3.org/TR/css-style-attr
• Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets

Specified by:

setStyle in interface ScreenFontStyle

Parameters:

newValue - is new value for the style field.

Returns:

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

setStyle

public ScreenFontStyle setStyle(SFString newValue)

Assign typed object value to SFString style field, similar to setStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setCssStyle

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

ScreenFontStyle - 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 ScreenFontStyle setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String). This attribute is only functional if the X3D model is loaded within an HTML page.

Parameters:

newValue - is new value for the style field.

Returns:

ScreenFontStyle - 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

getTopToBottom

public boolean getTopToBottom()

Provide boolean value from inputOutput 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

getTopToBottom in interface ScreenFontStyle

Returns:

value of topToBottom field

setTopToBottom

public ScreenFontStyle setTopToBottom(boolean newValue)

Accessor method to assign boolean value to inputOutput 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.

Specified by:

setTopToBottom in interface ScreenFontStyle

Parameters:

newValue - is new value for the topToBottom field.

Returns:

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

setTopToBottom

public ScreenFontStyle setTopToBottom(SFBool newValue)

Assign typed object value to SFBool topToBottom field, similar to setTopToBottom(boolean).

Parameters:

newValue - is new value for the topToBottom field.

Returns:

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

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

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

setDEF

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

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

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

setUSE

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

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

setUSE

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

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

addComments

public ScreenFontStyle addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ScreenFontStyle - 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 ScreenFontStyle addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ScreenFontStyle addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ScreenFontStyle - 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)