Interface FontStyle

All Superinterfaces:
X3DFontStyleNode, X3DNode
All Known Implementing Classes:
FontStyle
public interface FontStyle extends X3DFontStyleNode
FontStyle is an X3DFontStyleNode that defines the size, family, justification, and other styles used by Text nodes.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. FontStyle node tooltip: [X3DFontStyleNode] FontStyle is an X3DFontStyleNode that defines the size, family, justification, and other styles used by Text nodes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getFamily()
    Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from inputOutput MFString field named family.
    boolean
    getHorizontal()
    Provide boolean value from inputOutput SFBool field named horizontal.
    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.
    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
    getSize()
    Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named size.
    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.
    FontStyle
    setFamily(String[] newValue)
    Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to inputOutput MFString field named family.
    FontStyle
    setHorizontal(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named horizontal.
    FontStyle
    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.
    FontStyle
    setLanguage(String newValue)
    Accessor method to assign String value to inputOutput SFString field named language.
    FontStyle
    setLeftToRight(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named leftToRight.
    FontStyle
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    FontStyle
    setSize(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named size.
    FontStyle
    setSpacing(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named spacing.
    FontStyle
    setStyle(String newValue)
    Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to inputOutput SFString field named style.
    FontStyle
    setTopToBottom(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named topToBottom.

  • Method Details

    • getFamily

      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.
      Returns:
      value of family field

    • setFamily

      FontStyle setFamily(String[] newValue)
      Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to 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.
      Parameters:
      newValue - is new value for the family field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getHorizontal

      boolean getHorizontal()
      Provide boolean value from inputOutput SFBool field named horizontal.

      Tooltip: Whether text direction is horizontal (true) or vertical (false).
      Returns:
      value of horizontal field

    • setHorizontal

      FontStyle 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).
      Parameters:
      newValue - is new value for the horizontal field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getJustify

      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.
      Returns:
      value of justify field

    • setJustify

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

      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.
      Parameters:
      newValue - is new value for the justify field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLanguage

      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.
      Returns:
      value of language field

    • setLanguage

      FontStyle 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.
      Parameters:
      newValue - is new value for the language field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLeftToRight

      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).
      Returns:
      value of leftToRight field

    • setLeftToRight

      FontStyle 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).
      Parameters:
      newValue - is new value for the leftToRight field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

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

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DFontStyleNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

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

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DFontStyleNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getSize

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

      Tooltip: (0,+infinity) Nominal height (in local coordinate system) of text glyphs, also sets default spacing between adjacent lines of text.
      • Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
      Returns:
      value of size field

    • setSize

      FontStyle setSize(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named size.

      Tooltip: (0,+infinity) Nominal height (in local coordinate system) of text glyphs, also sets default spacing between adjacent lines of text.
      • Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
      Parameters:
      newValue - is new value for the size field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSpacing

      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.
      Returns:
      value of spacing field

    • setSpacing

      FontStyle 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.
      Parameters:
      newValue - is new value for the spacing field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStyle

      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).
      Returns:
      value of style field

    • setStyle

      FontStyle setStyle(String newValue)
      Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to inputOutput SFString field named style.

      Tooltip: Pick one of four values for text style (PLAIN|BOLD|ITALIC|BOLDITALIC).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTopToBottom

      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).
      Returns:
      value of topToBottom field

    • setTopToBottom

      FontStyle 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).
      Parameters:
      newValue - is new value for the topToBottom field.
      Returns:
      FontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).