Text (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DGeometryNode, X3DNode

All Known Implementing Classes:

TextObject
```
public interface Text
extends X3DGeometryNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DGeometryNode] Text is a 2D (flat) geometry node that can contain multiple lines of string values. Layout and styling is controlled by a contained FontStyle node.
- Hint: String (computer science)
  https://en.wikipedia.org/wiki/String_(computer_science)
- Hint: full internationalization (i18n) and localization (l10n) features are available for any written language.
- Hint: relates to Internationalization (i18n)
  http://www.w3.org/standards/webdesign/i18n
- Hint: insert a Shape node before adding geometry or Appearance.
- Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value) for contained node content.
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: Text, X3D Tooltips: Text, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`X3DFontStyleNode`	`getFontStyle()` Provide X3DFontStyleNode instance (using a properly typed node) from inputOutput SFNode field fontStyle.
`float[]`	`getLength()` Provide array of float results within allowed range of [0,infinity) from inputOutput MFFloat field named length.
`float[]`	`getLineBounds()` Provide array of 2-tuple float results from outputOnly MFVec2f field named lineBounds.
`float`	`getMaxExtent()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxExtent.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getOrigin()` Provide array of 3-tuple float results from outputOnly SFVec3f field named origin.
`boolean`	`getSolid()` Provide boolean value from initializeOnly SFBool field named solid.
`java.lang.String[]`	`getString()` Provide array of String results from inputOutput MFString field named string.
`float[]`	`getTextBounds()` Provide array of 2-tuple float results from outputOnly SFVec2f field named textBounds.
`Text`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Text`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Text`	`setFontStyle(X3DFontStyleNode newValue)` Assign X3DFontStyleNode instance (using a properly typed node) to inputOutput SFNode field fontStyle.
`Text`	`setLength(float[] newValue)` Assign float array within allowed range of [0,infinity) to inputOutput MFFloat field named length.
`Text`	`setMaxExtent(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named maxExtent.
`Text`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`Text`	`setSolid(boolean newValue)` Assign boolean value to initializeOnly SFBool field named solid.
`Text`	`setString(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named string.
`Text`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getFontStyle
```
X3DFontStyleNode getFontStyle()
```
    Provide X3DFontStyleNode instance (using a properly typed node) from inputOutput SFNode field fontStyle.
    
    Returns:
    
    value of fontStyle field
  - setFontStyle
```
Text setFontStyle(X3DFontStyleNode newValue)
```
    Assign X3DFontStyleNode instance (using a properly typed node) to inputOutput SFNode field fontStyle.
    
    Parameters:
    
    newValue - is new value for the fontStyle field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getLength
```
float[] getLength()
```
    Provide array of float results within allowed range of [0,infinity) from inputOutput MFFloat field named length.
    
    Tooltip: Array of length values for each text string in the local coordinate system. Each string is stretched or compressed to fit. *
    
    Returns:
    
    value of length field
  - setLength
```
Text setLength(float[] newValue)
```
    Assign float array within allowed range of [0,infinity) to inputOutput MFFloat field named length.
    
    Tooltip: Array of length values for each text string in the local coordinate system. Each string is stretched or compressed to fit.
    
    Parameters:
    
    newValue - is new value for the length field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getLineBounds
```
float[] getLineBounds()
```
    Provide array of 2-tuple float results from outputOnly MFVec2f field named lineBounds.
    
    Tooltip: Array of 2D bounding box values for each line of text in the local coordinate system.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of lineBounds field
  - getMaxExtent
```
float getMaxExtent()
```
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxExtent.
    
    Tooltip: Limits/compresses all text strings if max string length is longer than maxExtent, as measured in local coordinate system. *
    
    Returns:
    
    value of maxExtent field
  - setMaxExtent
```
Text setMaxExtent(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named maxExtent.
    
    Tooltip: Limits/compresses all text strings if max string length is longer than maxExtent, as measured in local coordinate system.
    
    Parameters:
    
    newValue - is new value for the maxExtent field.
    
    Returns:
    
    Text - 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 X3DGeometryNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
Text setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DGeometryNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    Text - 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
  - getOrigin
```
float[] getOrigin()
```
    Provide array of 3-tuple float results from outputOnly SFVec3f field named origin.
    
    Tooltip: origin of the text local coordinate system, in units of the coordinate system in which the Text node is embedded. The value of the origin field represents the upper left corner of the textBounds.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of origin field
  - getSolid
```
boolean getSolid()
```
    Provide boolean value from initializeOnly SFBool field named solid.
    
    Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
    - Warning: default value true can completely hide geometry if viewed from wrong side!
    - Hint: if in doubt, use solid='false' for maximum visibility.
    - Warning: solid false not supported in VRML97.
    Returns:
    
    value of solid field
  - setSolid
```
Text setSolid(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named solid.
    
    Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off). Warning: default value true can completely hide geometry if viewed from wrong side! Hint: if in doubt, use solid='false' for maximum visibility. Warning: solid false not supported in VRML97.
    
    Parameters:
    
    newValue - is new value for the solid field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getString
```
java.lang.String[] getString()
```
    Provide array of String results from inputOutput MFString field named string.
    
    Tooltip: Single or multiple string values to present as Text. Each value in the string array (including empty strings) gets displayed on a separate line.
    - Hint: MFString arrays can have multiple values, so separate each individual string by quote marks.
    - Hint: Strings can contain quote marks by first escaping them with a backslash example: "say \"hello\" please"
    - 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).
    - Hint: relates to Internationalization (i18n)
      http://www.w3.org/standards/webdesign/i18n Example:
      http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextIndex.html Example:
      http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextSpecialCharactersIndex.html
    Returns:
    
    value of string field
  - setString
```
Text setString(java.lang.String[] newValue)
```
    Assign String array to inputOutput MFString field named string.
    
    Tooltip: Single or multiple string values to present as Text. Each value in the string array (including empty strings) gets displayed on a separate line. Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. Hint: Strings can contain quote marks by first escaping them with a backslash example: "say \"hello\" please" 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). Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n Example: http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextIndex.html Example: http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextSpecialCharactersIndex.html
    
    Parameters:
    
    newValue - is new value for the string field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTextBounds
```
float[] getTextBounds()
```
    Provide array of 2-tuple float results from outputOnly SFVec2f field named textBounds.
    
    Tooltip: 2D bounding box value for all lines of text in the local coordinate system.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of textBounds field
  - setDEF
```
Text setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DGeometryNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Text setUSE(java.lang.String newValue)
```
    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 interface X3DGeometryNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Text setCssClass(java.lang.String newValue)
```
    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 interface X3DGeometryNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Text - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Text

Method Summary

Method Detail

getFontStyle

setFontStyle

getLength

setLength

getLineBounds

getMaxExtent

setMaxExtent

getMetadata

setMetadata

getOrigin

getSolid

setSolid

getString

setString

getTextBounds

setDEF

setUSE

setCssClass