Package org.web3d.x3d.sai.Layout

Interface ScreenFontStyle

All Superinterfaces:
X3DFontStyleNode, X3DNode
All Known Implementing Classes:
ScreenFontStyleObject
public interface ScreenFontStyle
extends X3DFontStyleNode
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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: ScreenFontStyle, X3D Tooltips: ScreenFontStyle, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    java.lang.String[] getFamily()
    Provide array of String enumeration results (baseType fontFamilyValues) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from initializeOnly MFString field named family.
    boolean getHorizontal()
    Provide boolean value from initializeOnly SFBool field named horizontal.
    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.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.
    ScreenFontStyle setFamily​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to initializeOnly MFString field named family.
    ScreenFontStyle setHorizontal​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named horizontal.
    ScreenFontStyle 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.
    ScreenFontStyle setLanguage​(java.lang.String newValue)
    Accessor method to assign String value to initializeOnly SFString field named language.
    ScreenFontStyle setLeftToRight​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named leftToRight.
    ScreenFontStyle setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ScreenFontStyle setPointSize​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named pointSize.
    ScreenFontStyle setSpacing​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named spacing.
    ScreenFontStyle setStyle​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to initializeOnly SFString field named style.
    ScreenFontStyle setTopToBottom​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named topToBottom.

  • Method Details

    • getFamily

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

    • setFamily

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

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

    • getHorizontal

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

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

    • setHorizontal

      ScreenFontStyle setHorizontal​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named horizontal.

      Tooltip: Whether text direction is horizontal (true) or vertical (false).
      Parameters:
      newValue - is new value for the horizontal field.
      Returns:
      ScreenFontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getJustify

      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.

      Tooltip: The justify field determines alignment of the above text layout relative to the origin of the object coordinate system.
      Returns:
      value of justify field

    • setJustify

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

      Tooltip: The justify field determines alignment of the above text layout relative to the origin of the object coordinate system.
      Parameters:
      newValue - is new value for the justify field.
      Returns:
      ScreenFontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLanguage

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

    • setLanguage

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

    • getLeftToRight

      boolean getLeftToRight()
      Provide boolean value from initializeOnly SFBool field named leftToRight.
      Returns:
      value of leftToRight field

    • setLeftToRight

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

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DFontStyleNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      ScreenFontStyle setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DFontStyleNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ScreenFontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getPointSize

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

    • setPointSize

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

    • getSpacing

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

    • setSpacing

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

    • getStyle

      java.lang.String getStyle()
      Provide String enumeration value (baseType fontStyleChoices) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from initializeOnly SFString field named style.

      Tooltip: Pick one of four values for text style.
      Returns:
      value of style field

    • setStyle

      ScreenFontStyle setStyle​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to initializeOnly SFString field named style.

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

    • getTopToBottom

      boolean getTopToBottom()
      Provide boolean value from initializeOnly SFBool field named topToBottom.

      Tooltip: Whether text direction is top-to-bottom (true) or bottom-to-top (false).
      Returns:
      value of topToBottom field

    • setTopToBottom

      ScreenFontStyle setTopToBottom​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named topToBottom.

      Tooltip: Whether text direction is top-to-bottom (true) or bottom-to-top (false).
      Parameters:
      newValue - is new value for the topToBottom field.
      Returns:
      ScreenFontStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).