Class ScreenFontStyleObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Layout.ScreenFontStyleObject
All Implemented Interfaces:
X3DNode, ScreenFontStyle, X3DFontStyleNode

public class ScreenFontStyleObject
extends X3DConcreteNode
implements ScreenFontStyle
ScreenFontStyle is an X3DFontStyleNode defines the size, family, justification, and other styles used within a screen layout.

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

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 java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the ScreenFontStyle element: Layout
    static java.lang.String containerField_DEFAULT_VALUE
    containerField describes typical field relationship of a node to its parent.
    static java.util.ArrayList<java.lang.String> FAMILY_DEFAULT_VALUE
    MFString field named family has default quoted value new String[] {"SERIF"} (Java syntax) or quoted value "SERIF" (XML syntax).
    static java.lang.String FAMILY_SANS
    MFString field named family with X3DUOM baseType fontFamilyValues is an array that can include this quoted enumeration value (and also may include alternate values) "SANS" (Java syntax) or '"SANS"' (XML syntax).
    static java.lang.String FAMILY_SERIF
    MFString field named family with X3DUOM baseType fontFamilyValues is an array that can include this quoted enumeration value (and also may include alternate values) "SERIF" (Java syntax) or '"SERIF"' (XML syntax).
    static java.lang.String FAMILY_TYPEWRITER
    MFString field named family with X3DUOM baseType fontFamilyValues is an array that can include this quoted enumeration value (and also may include alternate values) "TYPEWRITER" (Java syntax) or '"TYPEWRITER"' (XML syntax).
    static java.util.ArrayList<java.lang.String> fontFamilyValues
    List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
    static java.util.ArrayList<java.lang.String> fontStyleChoices
    List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
    static java.lang.String fromField_IS
    fromField ROUTE name for SFNode field named IS.
    static java.lang.String fromField_METADATA
    fromField ROUTE name for SFNode field named metadata.
    static boolean HORIZONTAL_DEFAULT_VALUE
    SFBool field named horizontal has default value true (Java syntax) or true (XML syntax).
    static ISObject IS_DEFAULT_VALUE
    SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String JUSTIFY_BEGIN
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "BEGIN" (Java syntax) or '"BEGIN"' (XML syntax).
    static java.lang.String JUSTIFY_BEGIN_BEGIN
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"BEGIN\"" (Java syntax) or '"BEGIN" "BEGIN"' (XML syntax).
    static java.lang.String JUSTIFY_BEGIN_END
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"END\"" (Java syntax) or '"BEGIN" "END"' (XML syntax).
    static java.lang.String JUSTIFY_BEGIN_FIRST
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"FIRST\"" (Java syntax) or '"BEGIN" "FIRST"' (XML syntax).
    static java.lang.String JUSTIFY_BEGIN_MIDDLE
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"BEGIN\" \"MIDDLE\"" (Java syntax) or '"BEGIN" "MIDDLE"' (XML syntax).
    static java.util.ArrayList<java.lang.String> JUSTIFY_DEFAULT_VALUE
    MFString field named justify has default quoted value new String[] {"BEGIN"} (Java syntax) or quoted value "BEGIN" (XML syntax).
    static java.lang.String JUSTIFY_END
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "END" (Java syntax) or '"END"' (XML syntax).
    static java.lang.String JUSTIFY_END_BEGIN
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"END\" \"BEGIN\"" (Java syntax) or '"END" "BEGIN"' (XML syntax).
    static java.lang.String JUSTIFY_END_END
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"END\" \"END\"" (Java syntax) or '"END" "END"' (XML syntax).
    static java.lang.String JUSTIFY_END_FIRST
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"END\" \"FIRST\"" (Java syntax) or '"END" "FIRST"' (XML syntax).
    static java.lang.String JUSTIFY_END_MIDDLE
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"END\" \"MIDDLE\"" (Java syntax) or '"END" "MIDDLE"' (XML syntax).
    static java.lang.String JUSTIFY_FIRST
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "FIRST" (Java syntax) or '"FIRST"' (XML syntax).
    static java.lang.String JUSTIFY_FIRST_BEGIN
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"BEGIN\"" (Java syntax) or '"FIRST" "BEGIN"' (XML syntax).
    static java.lang.String JUSTIFY_FIRST_END
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"END\"" (Java syntax) or '"FIRST" "END"' (XML syntax).
    static java.lang.String JUSTIFY_FIRST_FIRST
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"FIRST\"" (Java syntax) or '"FIRST" "FIRST"' (XML syntax).
    static java.lang.String JUSTIFY_FIRST_MIDDLE
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"FIRST\" \"MIDDLE\"" (Java syntax) or '"FIRST" "MIDDLE"' (XML syntax).
    static java.lang.String JUSTIFY_MIDDLE
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "MIDDLE" (Java syntax) or '"MIDDLE"' (XML syntax).
    static java.lang.String JUSTIFY_MIDDLE_BEGIN
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"BEGIN\"" (Java syntax) or '"MIDDLE" "BEGIN"' (XML syntax).
    static java.lang.String JUSTIFY_MIDDLE_END
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"END\"" (Java syntax) or '"MIDDLE" "END"' (XML syntax).
    static java.lang.String JUSTIFY_MIDDLE_FIRST
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"FIRST\"" (Java syntax) or '"MIDDLE" "FIRST"' (XML syntax).
    static java.lang.String JUSTIFY_MIDDLE_MIDDLE
    MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one set of the quoted enumeration values "\"MIDDLE\" \"MIDDLE\"" (Java syntax) or '"MIDDLE" "MIDDLE"' (XML syntax).
    static java.util.ArrayList<java.lang.String> justifyChoices
    List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
    static java.lang.String LANGUAGE_DEFAULT_VALUE
    SFString field named language has default value equal to an empty string.
    static boolean LEFTTORIGHT_DEFAULT_VALUE
    SFBool field named leftToRight has default value true (Java syntax) or true (XML syntax).
    static int LEVEL
    Integer constant LEVEL provides default X3D Layout component level for this element: 2
    static X3DMetadataObject METADATA_DEFAULT_VALUE
    SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String NAME
    String constant NAME provides name of this element: ScreenFontStyle.
    static float POINTSIZE_DEFAULT_VALUE
    SFFloat field named pointSize has default value 12.0f (Java syntax) or 12.0 (XML syntax).
    static float SPACING_DEFAULT_VALUE
    SFFloat field named spacing has default value 1.0f (Java syntax) or 1.0 (XML syntax).
    static java.lang.String STYLE_BOLD
    SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "BOLD" (Java syntax) or BOLD (XML syntax).
    static java.lang.String STYLE_BOLDITALIC
    SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "BOLDITALIC" (Java syntax) or BOLDITALIC (XML syntax).
    static java.lang.String STYLE_DEFAULT_VALUE
    SFString field named style has default value "PLAIN" (Java syntax) or PLAIN (XML syntax).
    static java.lang.String STYLE_ITALIC
    SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "ITALIC" (Java syntax) or ITALIC (XML syntax).
    static java.lang.String STYLE_PLAIN
    SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "PLAIN" (Java syntax) or PLAIN (XML syntax).
    static java.lang.String toField_METADATA
    toField ROUTE name for SFNode field named metadata.
    static boolean TOPTOBOTTOM_DEFAULT_VALUE
    SFBool field named topToBottom has default value true (Java syntax) or true (XML syntax).

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

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    ScreenFontStyleObject()
    Constructor for ScreenFontStyleObject to initialize member variables with default values.
    ScreenFontStyleObject​(java.lang.String DEFlabel)
    Utility constructor that assigns DEF label after initializing member variables with default values.
  • Method Summary

    Modifier and Type Method Description
    ScreenFontStyleObject addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    ScreenFontStyleObject addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    ScreenFontStyleObject addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    ScreenFontStyleObject addFamily​(java.lang.String newValue)
    Add singleton String value to MFString family field.
    ScreenFontStyleObject addFamily​(SFStringObject newValue)
    Add singleton SFStringObject value to MFString family field.
    ScreenFontStyleObject addJustify​(java.lang.String newValue)
    Add singleton String value to MFString justify field.
    ScreenFontStyleObject addJustify​(SFStringObject newValue)
    Add singleton SFStringObject value to MFString justify field.
    ScreenFontStyleObject clearFamily()
    Utility method to clear MFString value of family field.
    ScreenFontStyleObject clearIS()
    Utility method to clear SFNode value of IS field.
    ScreenFontStyleObject clearJustify()
    Utility method to clear MFString value of justify field.
    ScreenFontStyleObject clearMetadata()
    Utility method to clear SFNode value of metadata field.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
    X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    java.lang.String getAccessType​(java.lang.String fieldName)
    Indicate accessType corresponding to given fieldName.
    java.lang.String getComponent()
    Defines X3D component for the ScreenFontStyle element: Layout
    int getComponentLevel()
    Provides default X3D component level for this element: 2
    java.lang.String getContainerFieldDefault()
    containerField describes typical field relationship of a node to its parent.
    java.lang.String getCssClass()
    Provide String value from inputOutput SFString field named class.
    java.lang.String getDEF()
    Provide String value from inputOutput SFString field named DEF.
    java.lang.String getElementName()
    Provides name of this element: ScreenFontStyle
    java.lang.String[] getFamily()
    Provide array of String enumeration results ( baseType fontFamilyValues) [""SANS"" | ""SERIF"" | ""TYPEWRITER"" | '"etc."'] from initializeOnly MFString field named family.
    java.util.ArrayList<java.lang.String> getFamilyList()
    Utility method to get ArrayList value of MFString family field, similar to getFamily().
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    boolean getHorizontal()
    Provide boolean value from initializeOnly SFBool field named horizontal.
    ISObject getIS()
    Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
    java.lang.String[] getJustify()
    Provide array of String enumeration results ( baseType justifyChoices) [""MIDDLE"" | ""MIDDLE" "BEGIN"" | ""MIDDLE" "END"" | ""MIDDLE" "FIRST"" | ""MIDDLE" "MIDDLE"" | ""BEGIN"" | ""BEGIN" "BEGIN"" | ""BEGIN" "END"" | ""BEGIN" "FIRST"" | ""BEGIN" "MIDDLE"" | ""END"" | ""END" "BEGIN"" | ""END" "END"" | ""END" "FIRST"" | ""END" "MIDDLE"" | ""FIRST"" | ""FIRST" "BEGIN"" | ""FIRST" "END"" | ""FIRST" "FIRST"" | ""FIRST" "MIDDLE""] from initializeOnly MFString field named justify.
    java.util.ArrayList<java.lang.String> getJustifyList()
    Utility method to get ArrayList value of MFString justify field, similar to getJustify().
    java.lang.String getLanguage()
    Provide String value from initializeOnly SFString field named language.
    boolean getLeftToRight()
    Provide boolean value from initializeOnly SFBool field named leftToRight.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float getPointSize()
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named pointSize.
    float getSpacing()
    Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named spacing.
    java.lang.String getStyle()
    Provide String enumeration value ( baseType fontStyleChoices) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from initializeOnly SFString field named style.
    boolean getTopToBottom()
    Provide boolean value from initializeOnly SFBool field named topToBottom.
    java.lang.String getUSE()
    Provide String value from inputOutput SFString field named USE.
    boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    boolean hasIS()
    Indicate whether an object is available for inputOutput SFNode field IS.
    boolean hasMetadata()
    Indicate whether an object is available for inputOutput SFNode field metadata.
    boolean hasNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    void initialize()
    Initialize all member variables to default values.
    ScreenFontStyleObject setCssClass​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named class.
    ScreenFontStyleObject setCssClass​(SFStringObject newValue)
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    ScreenFontStyleObject setDEF​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named DEF.
    ScreenFontStyleObject setDEF​(SFStringObject newValue)
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    ScreenFontStyleObject setFamily​(java.lang.String newValue)
    Assign singleton String value to MFString family field, similar to setFamily(String[]).
    ScreenFontStyleObject setFamily​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to initializeOnly MFString field named family.
    ScreenFontStyleObject setFamily​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString family field, similar to setFamily(String[]).
    ScreenFontStyleObject setFamily​(MFStringObject newValue)
    Assign typed object value to MFString family field, similar to setFamily(String[]).
    ScreenFontStyleObject setFamily​(SFStringObject newValue)
    Assign single SFString object value to MFString family field, similar to setFamily(String[]).
    ScreenFontStyleObject setHorizontal​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named horizontal.
    ScreenFontStyleObject setHorizontal​(SFBoolObject newValue)
    Assign typed object value to SFBool horizontal field, similar to setHorizontal(boolean).
    ScreenFontStyleObject setIS​(ISObject newValue)
    Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
    ScreenFontStyleObject setJustify​(java.lang.String newValue)
    Assign singleton String value to MFString justify field, similar to setJustify(String[]).
    ScreenFontStyleObject setJustify​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""MIDDLE"" | ""MIDDLE" "BEGIN"" | ""MIDDLE" "END"" | ""MIDDLE" "FIRST"" | ""MIDDLE" "MIDDLE"" | ""BEGIN"" | ""BEGIN" "BEGIN"" | ""BEGIN" "END"" | ""BEGIN" "FIRST"" | ""BEGIN" "MIDDLE"" | ""END"" | ""END" "BEGIN"" | ""END" "END"" | ""END" "FIRST"" | ""END" "MIDDLE"" | ""FIRST"" | ""FIRST" "BEGIN"" | ""FIRST" "END"" | ""FIRST" "FIRST"" | ""FIRST" "MIDDLE"") to initializeOnly MFString field named justify.
    ScreenFontStyleObject setJustify​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString justify field, similar to setJustify(String[]).
    ScreenFontStyleObject setJustify​(MFStringObject newValue)
    Assign typed object value to MFString justify field, similar to setJustify(String[]).
    ScreenFontStyleObject setJustify​(SFStringObject newValue)
    Assign single SFString object value to MFString justify field, similar to setJustify(String[]).
    ScreenFontStyleObject setLanguage​(java.lang.String newValue)
    Accessor method to assign String value to initializeOnly SFString field named language.
    ScreenFontStyleObject setLanguage​(SFStringObject newValue)
    Assign typed object value to SFString language field, similar to setLanguage(String).
    ScreenFontStyleObject setLeftToRight​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named leftToRight.
    ScreenFontStyleObject setLeftToRight​(SFBoolObject newValue)
    Assign typed object value to SFBool leftToRight field, similar to setLeftToRight(boolean).
    ScreenFontStyleObject setMetadata​(ProtoInstanceObject newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    ScreenFontStyleObject setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ScreenFontStyleObject setPointSize​(double newValue)
    Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPointSize(float).
    ScreenFontStyleObject setPointSize​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named pointSize.
    ScreenFontStyleObject setPointSize​(SFFloatObject newValue)
    Assign typed object value to SFFloat pointSize field, similar to setPointSize(float).
    ScreenFontStyleObject setSpacing​(double newValue)
    Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpacing(float).
    ScreenFontStyleObject setSpacing​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named spacing.
    ScreenFontStyleObject setSpacing​(SFFloatObject newValue)
    Assign typed object value to SFFloat spacing field, similar to setSpacing(float).
    ScreenFontStyleObject setStyle​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to initializeOnly SFString field named style.
    ScreenFontStyleObject setStyle​(SFStringObject newValue)
    Assign typed object value to SFString style field, similar to setStyle(String).
    ScreenFontStyleObject setTopToBottom​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named topToBottom.
    ScreenFontStyleObject setTopToBottom​(SFBoolObject newValue)
    Assign typed object value to SFBool topToBottom field, similar to setTopToBottom(boolean).
    ScreenFontStyleObject setUSE​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named USE.
    ScreenFontStyleObject setUSE​(SFStringObject newValue)
    Assign typed object value to SFString USE field, similar to setUSE(String).
    ScreenFontStyleObject setUSE​(ScreenFontStyleObject DEFnode)
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    java.lang.String toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    java.lang.String toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    java.lang.String toStringX3D​(int indentLevel)
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    java.lang.String validate()
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

    Methods inherited from class java.lang.Object

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