Class ScreenFontStyleObject

  • All Implemented Interfaces:
    X3DNode, ScreenFontStyle, X3DFontStyleNode

    public class ScreenFontStyleObject
    extends X3DConcreteNode
    implements ScreenFontStyle
    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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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).
    • 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.
    • Field Detail

      • FAMILY_SANS

        public static final java.lang.String FAMILY_SANS
        MFString field named family with X3DUOM baseType fontFamilyValues is an array that can include this quoted enumeration value (and alternate values) "SANS" (Java syntax) or '"SANS"' (XML syntax).
        See Also:
        fontFamilyValues, Constant Field Values
      • FAMILY_SERIF

        public static final java.lang.String FAMILY_SERIF
        MFString field named family with X3DUOM baseType fontFamilyValues is an array that can include this quoted enumeration value (and alternate values) "SERIF" (Java syntax) or '"SERIF"' (XML syntax).
        See Also:
        fontFamilyValues, Constant Field Values
      • FAMILY_TYPEWRITER

        public static final java.lang.String FAMILY_TYPEWRITER
        MFString field named family with X3DUOM baseType fontFamilyValues is an array that can include this quoted enumeration value (and alternate values) "TYPEWRITER" (Java syntax) or '"TYPEWRITER"' (XML syntax).
        See Also:
        fontFamilyValues, Constant Field Values
      • justifyChoices

        public static final java.util.ArrayList<java.lang.String> justifyChoices
        List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.

        Allowed 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"".

        justifyChoices are strictly allowed enumeration values for FontStyle node justify field. Note that intermediate commas and extraneous whitespace are disallowed by these strictly defined enumeration values.
        See Also:
        https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/text.html#Directionandjustification
      • JUSTIFY_MIDDLE

        public static final java.lang.String JUSTIFY_MIDDLE
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "MIDDLE" (Java syntax) or '"MIDDLE"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_MIDDLE_BEGIN

        public static final java.lang.String JUSTIFY_MIDDLE_BEGIN
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"MIDDLE\" \"BEGIN\"" (Java syntax) or '"MIDDLE" "BEGIN"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_MIDDLE_END

        public static final java.lang.String JUSTIFY_MIDDLE_END
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"MIDDLE\" \"END\"" (Java syntax) or '"MIDDLE" "END"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_MIDDLE_FIRST

        public static final java.lang.String JUSTIFY_MIDDLE_FIRST
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"MIDDLE\" \"FIRST\"" (Java syntax) or '"MIDDLE" "FIRST"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_MIDDLE_MIDDLE

        public static final java.lang.String JUSTIFY_MIDDLE_MIDDLE
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"MIDDLE\" \"MIDDLE\"" (Java syntax) or '"MIDDLE" "MIDDLE"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_BEGIN

        public static final java.lang.String JUSTIFY_BEGIN
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "BEGIN" (Java syntax) or '"BEGIN"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_BEGIN_BEGIN

        public static final java.lang.String JUSTIFY_BEGIN_BEGIN
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"BEGIN\" \"BEGIN\"" (Java syntax) or '"BEGIN" "BEGIN"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_BEGIN_END

        public static final java.lang.String JUSTIFY_BEGIN_END
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"BEGIN\" \"END\"" (Java syntax) or '"BEGIN" "END"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_BEGIN_FIRST

        public static final java.lang.String JUSTIFY_BEGIN_FIRST
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"BEGIN\" \"FIRST\"" (Java syntax) or '"BEGIN" "FIRST"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_BEGIN_MIDDLE

        public static final java.lang.String JUSTIFY_BEGIN_MIDDLE
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"BEGIN\" \"MIDDLE\"" (Java syntax) or '"BEGIN" "MIDDLE"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_END

        public static final java.lang.String JUSTIFY_END
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "END" (Java syntax) or '"END"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_END_BEGIN

        public static final java.lang.String JUSTIFY_END_BEGIN
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"END\" \"BEGIN\"" (Java syntax) or '"END" "BEGIN"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_END_END

        public static final java.lang.String JUSTIFY_END_END
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"END\" \"END\"" (Java syntax) or '"END" "END"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_END_FIRST

        public static final java.lang.String JUSTIFY_END_FIRST
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"END\" \"FIRST\"" (Java syntax) or '"END" "FIRST"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_END_MIDDLE

        public static final java.lang.String JUSTIFY_END_MIDDLE
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"END\" \"MIDDLE\"" (Java syntax) or '"END" "MIDDLE"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_FIRST

        public static final java.lang.String JUSTIFY_FIRST
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "FIRST" (Java syntax) or '"FIRST"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_FIRST_BEGIN

        public static final java.lang.String JUSTIFY_FIRST_BEGIN
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"FIRST\" \"BEGIN\"" (Java syntax) or '"FIRST" "BEGIN"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_FIRST_END

        public static final java.lang.String JUSTIFY_FIRST_END
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"FIRST\" \"END\"" (Java syntax) or '"FIRST" "END"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_FIRST_FIRST

        public static final java.lang.String JUSTIFY_FIRST_FIRST
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"FIRST\" \"FIRST\"" (Java syntax) or '"FIRST" "FIRST"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • JUSTIFY_FIRST_MIDDLE

        public static final java.lang.String JUSTIFY_FIRST_MIDDLE
        MFString field named justify with X3DUOM baseType justifyChoices is an array that can only include one of the quoted enumeration values "\"FIRST\" \"MIDDLE\"" (Java syntax) or '"FIRST" "MIDDLE"' (XML syntax).
        See Also:
        justifyChoices, Constant Field Values
      • STYLE_PLAIN

        public static final java.lang.String STYLE_PLAIN
        SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "PLAIN" (Java syntax) or PLAIN (XML syntax).
        See Also:
        fontStyleChoices, Constant Field Values
      • STYLE_BOLD

        public static final java.lang.String STYLE_BOLD
        SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "BOLD" (Java syntax) or BOLD (XML syntax).
        See Also:
        fontStyleChoices, Constant Field Values
      • STYLE_ITALIC

        public static final java.lang.String STYLE_ITALIC
        SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "ITALIC" (Java syntax) or ITALIC (XML syntax).
        See Also:
        fontStyleChoices, Constant Field Values
      • STYLE_BOLDITALIC

        public static final java.lang.String STYLE_BOLDITALIC
        SFString field named style with X3DUOM baseType fontStyleChoices can equal this value "BOLDITALIC" (Java syntax) or BOLDITALIC (XML syntax).
        See Also:
        fontStyleChoices, Constant Field Values
      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: ScreenFontStyle.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.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 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).
      • 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 ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • JUSTIFY_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> JUSTIFY_DEFAULT_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 java.lang.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 java.lang.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
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ScreenFontStyleObject

        public ScreenFontStyleObject()
        Constructor for ScreenFontStyleObject to initialize member variables with default values.
      • ScreenFontStyleObject

        public ScreenFontStyleObject​(java.lang.String DEFlabel)
        Utility constructor that assigns DEF label after initializing member variables with default values.
        Parameters:
        DEFlabel - unique DEF name for this X3D node
    • Method Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: ScreenFontStyle
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.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 java.lang.String getFieldType​(java.lang.String fieldName)
        Indicate type corresponding to given fieldName.
        Specified by:
        getFieldType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D node
        Returns:
        X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
      • getAccessType

        public java.lang.String getAccessType​(java.lang.String fieldName)
        Indicate accessType corresponding to given fieldName.
        Specified by:
        getAccessType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D node
        Returns:
        X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
      • initialize

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteNode
      • getFamily

        public java.lang.String[] getFamily()
        Provide array of String enumeration results ( baseType fontFamilyValues) [""SANS"" | ""SERIF"" | ""TYPEWRITER"" | '"etc."'] from initializeOnly MFString field named family.

        Tooltip: Array of quoted font family names in preference order, browsers use the first supported family.

        Available enumeration values for string comparison: SANS, SERIF, TYPEWRITER.
        Specified by:
        getFamily in interface ScreenFontStyle
        Returns:
        value of family field
      • getFamilyList

        public java.util.ArrayList<java.lang.String> getFamilyList()
        Utility method to get ArrayList value of MFString family field, similar to getFamily().
        Returns:
        value of family field
      • setFamily

        public ScreenFontStyleObject setFamily​(java.lang.String[] newValue)
        Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to initializeOnly MFString field named family.

        Hint: authors have option to choose from an extendible list of predefined enumeration values (SANS, SERIF, TYPEWRITER).

        Tooltip: Array of quoted font family names in preference order, browsers use the first supported family.
        Specified by:
        setFamily in interface ScreenFontStyle
        Parameters:
        newValue - is new value for the family field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFamily

        public ScreenFontStyleObject setFamily​(MFStringObject newValue)
        Assign typed object value to MFString family field, similar to setFamily(String[]).
        Parameters:
        newValue - is new value for the family field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFamily

        public ScreenFontStyleObject setFamily​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString family field, similar to setFamily(String[]).
        Parameters:
        newValue - is new value for the family field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearFamily

        public ScreenFontStyleObject clearFamily()
        Utility method to clear MFString value of family field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setHorizontal

        public ScreenFontStyleObject setHorizontal​(SFBoolObject newValue)
        Assign typed object value to SFBool horizontal field, similar to setHorizontal(boolean).
        Parameters:
        newValue - is new value for the horizontal field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

        public ScreenFontStyleObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        ScreenFontStyleObject - 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()
      • getJustifyList

        public java.util.ArrayList<java.lang.String> getJustifyList()
        Utility method to get ArrayList value of MFString justify field, similar to getJustify().
        Returns:
        value of justify field
      • setJustify

        public ScreenFontStyleObject setJustify​(MFStringObject newValue)
        Assign typed object value to MFString justify field, similar to setJustify(String[]).
        Parameters:
        newValue - is new value for the justify field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setJustify

        public ScreenFontStyleObject setJustify​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString justify field, similar to setJustify(String[]).
        Parameters:
        newValue - is new value for the justify field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearJustify

        public ScreenFontStyleObject clearJustify()
        Utility method to clear MFString value of justify field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • getLanguage

        public java.lang.String getLanguage()
        Provide String value from initializeOnly SFString field named language.

        Tooltip: Language codes consist of a primary code and a (possibly empty) series of subcodes. [ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved for language abbreviations. Two-letter primary codes include en (English), fr (French), de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese), ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur (Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.
        Specified by:
        getLanguage in interface ScreenFontStyle
        Returns:
        value of language field
      • setLanguage

        public ScreenFontStyleObject setLanguage​(java.lang.String newValue)
        Accessor method to assign String value to initializeOnly SFString field named language.

        Tooltip: Language codes consist of a primary code and a (possibly empty) series of subcodes. [ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved for language abbreviations. Two-letter primary codes include en (English), fr (French), de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese), ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur (Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.
        Specified by:
        setLanguage in interface ScreenFontStyle
        Parameters:
        newValue - is new value for the language field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLanguage

        public ScreenFontStyleObject setLanguage​(SFStringObject newValue)
        Assign typed object value to SFString language field, similar to setLanguage(String).
        Parameters:
        newValue - is new value for the language field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getLeftToRight

        public boolean getLeftToRight()
        Provide boolean value from initializeOnly SFBool field named leftToRight.
        Specified by:
        getLeftToRight in interface ScreenFontStyle
        Returns:
        value of leftToRight field
      • setLeftToRight

        public ScreenFontStyleObject setLeftToRight​(boolean newValue)
        Accessor method to assign boolean value to initializeOnly SFBool field named leftToRight.
        Specified by:
        setLeftToRight in interface ScreenFontStyle
        Parameters:
        newValue - is new value for the leftToRight field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLeftToRight

        public ScreenFontStyleObject setLeftToRight​(SFBoolObject newValue)
        Assign typed object value to SFBool leftToRight field, similar to setLeftToRight(boolean).
        Parameters:
        newValue - is new value for the leftToRight field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearMetadata

        public ScreenFontStyleObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 initializeOnly 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.
        Specified by:
        getPointSize in interface ScreenFontStyle
        Returns:
        value of pointSize field
      • setPointSize

        public ScreenFontStyleObject setPointSize​(float newValue)
        Accessor method to assign float value to initializeOnly 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.
        Specified by:
        setPointSize in interface ScreenFontStyle
        Parameters:
        newValue - is new value for the pointSize field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPointSize

        public ScreenFontStyleObject setPointSize​(SFFloatObject newValue)
        Assign typed object value to SFFloat pointSize field, similar to setPointSize(float).
        Parameters:
        newValue - is new value for the pointSize field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPointSize

        public ScreenFontStyleObject 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:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getSpacing

        public float getSpacing()
        Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named spacing.

        Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text. *
        Specified by:
        getSpacing in interface ScreenFontStyle
        Returns:
        value of spacing field
      • setSpacing

        public ScreenFontStyleObject setSpacing​(float newValue)
        Accessor method to assign float value to initializeOnly SFFloat field named spacing.

        Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text. *
        Specified by:
        setSpacing in interface ScreenFontStyle
        Parameters:
        newValue - is new value for the spacing field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpacing

        public ScreenFontStyleObject setSpacing​(SFFloatObject newValue)
        Assign typed object value to SFFloat spacing field, similar to setSpacing(float).
        Parameters:
        newValue - is new value for the spacing field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpacing

        public ScreenFontStyleObject 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:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setStyle

        public ScreenFontStyleObject setStyle​(SFStringObject newValue)
        Assign typed object value to SFString style field, similar to setStyle(String).
        Parameters:
        newValue - is new value for the style field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTopToBottom

        public ScreenFontStyleObject setTopToBottom​(SFBoolObject newValue)
        Assign typed object value to SFBool topToBottom field, similar to setTopToBottom(boolean).
        Parameters:
        newValue - is new value for the topToBottom field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public final ScreenFontStyleObject setDEF​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named DEF.

        Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

        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:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public ScreenFontStyleObject setDEF​(SFStringObject newValue)
        Assign typed object value to SFString DEF field, similar to setDEF(String).
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getUSE

        public java.lang.String getUSE()
        Provide String value from inputOutput SFString field named USE.

        Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
        • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
        • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
        • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

        public final ScreenFontStyleObject setUSE​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named USE.

        Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
        • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
        • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
        • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


        Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

        Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

        Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
        Specified by:
        setUSE in class X3DConcreteNode
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public ScreenFontStyleObject setUSE​(SFStringObject newValue)
        Assign typed object value to SFString USE field, similar to setUSE(String).
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCssClass

        public java.lang.String getCssClass()
        Provide String value from inputOutput SFString field named class.

        Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
        • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
        • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
        Overrides:
        getCssClass in class X3DConcreteNode
        Returns:
        value of class field
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public final ScreenFontStyleObject setCssClass​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named class.

        Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
        • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
        • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
        Specified by:
        setCssClass in class X3DConcreteNode
        Parameters:
        newValue - is new value for the class field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public ScreenFontStyleObject setCssClass​(SFStringObject newValue)
        Assign typed object value to SFString cssClass field, similar to setCssClass(String).
        Parameters:
        newValue - is new value for the class field.
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public ScreenFontStyleObject setUSE​(ScreenFontStyleObject 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:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public ScreenFontStyleObject addComments​(java.lang.String newComment)
        Add comment as String to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public ScreenFontStyleObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        ScreenFontStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue,
                                                         java.lang.String elementName)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • hasElementByNameValue

        public boolean hasElementByNameValue​(java.lang.String nameValue,
                                             java.lang.String elementName)
        Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        whether node is found
        See Also:
        findElementByNameValue(String, String)
      • hasNodeByDEF

        public boolean hasNodeByDEF​(java.lang.String DEFvalue)
        Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
        Parameters:
        DEFvalue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        whether node is found
        See Also:
        findNodeByDEF(String)
      • validate

        public java.lang.String validate()
        Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
        Specified by:
        validate in class X3DConcreteElement
        Returns:
        validation results (if any)