Interface FontLibrary

All Superinterfaces:
X3DChildNode, X3DNode, X3DUrlObject
All Known Implementing Classes:
FontLibrary
public interface FontLibrary extends X3DChildNode, X3DUrlObject
FontLibrary can load additional fonts for use by Text and FontStyle nodes.

FontLibrary node tooltip: (X3D version 4.1 draft) [X3DChildNode] FontLibrary can load additional fonts for use by Text and FontStyle 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
    double
    getAutoRefresh()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
    double
    getAutoRefreshTimeLimit()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    String[]
    getFamily()
    Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from inputOutput MFString field named family.
    boolean
    getLoad()
    Provide boolean value from inputOutput SFBool field named load.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    String[]
    getUrl()
    Provide array of String results from inputOutput MFString field named url.
    FontLibrary
    setAutoRefresh(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
    FontLibrary
    setAutoRefreshTimeLimit(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
    FontLibrary
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    FontLibrary
    setFamily(String[] newValue)
    Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to inputOutput MFString field named family.
    FontLibrary
    setLoad(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named load.
    FontLibrary
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    FontLibrary
    setUrl(String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named url.

  • Method Details

    • getAutoRefresh

      double getAutoRefresh()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

      Tooltip: The [autoRefresh field has no effect, Anchor operation is only triggered by user selection. *
      Specified by:
      getAutoRefresh in interface X3DUrlObject
      Returns:
      value of autoRefresh field

    • setAutoRefresh

      FontLibrary setAutoRefresh(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

      Tooltip: The [autoRefresh field has no effect, Anchor operation is only triggered by user selection. *
      Specified by:
      setAutoRefresh in interface X3DUrlObject
      Parameters:
      newValue - is new value for the autoRefresh field.
      Returns:
      FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getAutoRefreshTimeLimit

      double getAutoRefreshTimeLimit()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

      Tooltip: The [autoRefreshTimeLimit field has no effect, Anchor operation is only triggered by user selection. *
      Specified by:
      getAutoRefreshTimeLimit in interface X3DUrlObject
      Returns:
      value of autoRefreshTimeLimit field

    • setAutoRefreshTimeLimit

      FontLibrary setAutoRefreshTimeLimit(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

      Tooltip: The [autoRefreshTimeLimit field has no effect, Anchor operation is only triggered by user selection. *
      Specified by:
      setAutoRefreshTimeLimit in interface X3DUrlObject
      Parameters:
      newValue - is new value for the autoRefreshTimeLimit field.
      Returns:
      FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface X3DUrlObject
      Returns:
      value of description field

    • setDescription

      FontLibrary setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface X3DUrlObject
      Parameters:
      newValue - is new value for the description field.
      Returns:
      FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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: supports supports capabilities for Web Internationalization (i18n) https://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

      FontLibrary 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: supports supports capabilities for Web Internationalization (i18n) https://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:
      FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLoad

      boolean getLoad()
      Provide boolean value from inputOutput SFBool field named load.

      Tooltip: The load field has no effect, Anchor operation is only triggered by user selection. *
      Specified by:
      getLoad in interface X3DUrlObject
      Returns:
      value of load field

    • setLoad

      FontLibrary setLoad(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named load.

      Tooltip: The load field has no effect, Anchor operation is only triggered by user selection. *
      Specified by:
      setLoad in interface X3DUrlObject
      Parameters:
      newValue - is new value for the load field.
      Returns:
      FontLibrary - 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 X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      FontLibrary 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 X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getUrl

      String[] getUrl()
      Provide array of String results from inputOutput MFString field named url.

      Tooltip: Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the user selecting Shape geometry within the Anchor children nodes.
      • Hint: jump to a world's internal viewpoint by appending viewpoint name (for example, #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
      • Hint: jump to a local viewpoint by only using viewpoint name (for example, #GrandTour).
      • Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains to interpolators or scripts.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field

    • setUrl

      FontLibrary setUrl(String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.

      Tooltip: Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the user selecting Shape geometry within the Anchor children nodes.
      • Hint: jump to a world's internal viewpoint by appending viewpoint name (for example, #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
      • Hint: jump to a local viewpoint by only using viewpoint name (for example, #GrandTour).
      • Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains to interpolators or scripts.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      setUrl in interface X3DUrlObject
      Parameters:
      newValue - is new value for the url field.
      Returns:
      FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).