All Superinterfaces:: X3DChildNode, X3DKeyDeviceSensorNode, X3DNode, X3DSensorNode

All Known Implementing Classes:: StringSensor

public interface StringSensor extends X3DKeyDeviceSensorNode

StringSensor generates events as the user presses keys on the keyboard.

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. StringSensor node tooltip: [X3DKeyDeviceSensorNode] StringSensor generates events as the user presses keys on the keyboard. Browser support includes the notion of "keyboard focus".

Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity

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

boolean

getDeletionAllowed()

Provide boolean value from inputOutput SFBool field named deletionAllowed.

String

getDescription()

Provide String value from inputOutput SFString field named description.

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

String

getEnteredText()

Provide String value from outputOnly SFString field named enteredText.

String

getFinalText()

Provide String value from outputOnly SFString field named finalText.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

X3DMetadataObject

getMetadata()

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

StringSensor

setDeletionAllowed(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named deletionAllowed.

StringSensor

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

StringSensor

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

StringSensor

setMetadata(X3DMetadataObject newValue)

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

Method Details
- getDeletionAllowed
  boolean getDeletionAllowed()
  
  Provide boolean value from inputOutput SFBool field named deletionAllowed.
  
  Tooltip: If deletionAllowed is true, then previously entered character in enteredText can be removed. If deletionAllowed is false, then characters may only be added to the string.
  
  Hint: deletion key is typically defined by local system.
  
  Returns:
  
  value of deletionAllowed field
- setDeletionAllowed
  StringSensor setDeletionAllowed(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named deletionAllowed.
  
  Tooltip: If deletionAllowed is true, then previously entered character in enteredText can be removed. If deletionAllowed is false, then characters may only be added to the string.
  
  Hint: deletion key is typically defined by local system.
  
  Parameters:
  
  newValue - is new value for the deletionAllowed field.
  
  Returns:
  
  StringSensor - 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 node.
  
  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 X3DKeyDeviceSensorNode
  
  Specified by:
  
  getDescription in interface X3DSensorNode
  
  Returns:
  
  value of description field
- setDescription
  StringSensor 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 node.
  
  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 X3DKeyDeviceSensorNode
  
  Specified by:
  
  setDescription in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  StringSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getEnabled
  
  boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface X3DKeyDeviceSensorNode
  
  Specified by:
  
  getEnabled in interface X3DSensorNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  StringSensor setEnabled(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  setEnabled in interface X3DKeyDeviceSensorNode
  
  Specified by:
  
  setEnabled in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  StringSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getEnteredText
  String getEnteredText()
  
  Provide String value from outputOnly SFString field named enteredText.
  
  Tooltip: Events generated as character-producing keys are pressed on keyboard.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Returns:
  
  value of enteredText field
- getFinalText
  String getFinalText()
  
  Provide String value from outputOnly SFString field named finalText.
  
  Tooltip: Events generated when sequence of keystrokes matches keys in terminationText string when this condition occurs, enteredText is moved to finalText and enteredText is set to empty string.
  
  Hint: termination key is typically defined by local system.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Returns:
  
  value of finalText field
- getIsActive
  boolean getIsActive()
  
  Provide boolean value from outputOnly SFBool field named isActive.
  
  Tooltip: Select geometry by activating the pointing device (for example, clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (for example, when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (for example, when primary mouse button is released).
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Specified by:
  
  getIsActive in interface X3DKeyDeviceSensorNode
  
  Specified by:
  
  getIsActive in interface X3DSensorNode
  
  Returns:
  
  value of isActive field
- 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DKeyDeviceSensorNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSensorNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  StringSensor 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DKeyDeviceSensorNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  StringSensor - 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

Interface StringSensor

Method Summary

Method Details

getDeletionAllowed

setDeletionAllowed

getDescription

setDescription

getEnabled

setEnabled

getEnteredText

getFinalText

getIsActive

getMetadata

setMetadata