Interface DataApi

  • All Known Implementing Classes:
    WebTextTerminal

    public interface DataApi
    API for the data exchanged between browser and server.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      TextTerminalData getTextTerminalData()
      This method is called by the web component while polling for data
      void postHandlerCall​(java.lang.String handlerId, java.lang.String partialInput)
      This method is called by the web component in response to a handler call (triggered by typing its associated key combination).
      void postUserInput​(java.lang.String input)
      This method is called by the web component to post the user input
      void postUserInterrupt​(java.lang.String partialInput)
      This method is called by the web component in response to a user interrupt (typically triggered by typing Ctrl+Q).
    • Method Detail

      • getTextTerminalData

        TextTerminalData getTextTerminalData()
        This method is called by the web component while polling for data
      • postUserInput

        void postUserInput​(java.lang.String input)
        This method is called by the web component to post the user input
      • postUserInterrupt

        void postUserInterrupt​(java.lang.String partialInput)
        This method is called by the web component in response to a user interrupt (typically triggered by typing Ctrl+Q).
        Parameters:
        partialInput - the partially entered input when the user interrupt occurred.
      • postHandlerCall

        void postHandlerCall​(java.lang.String handlerId,
                             java.lang.String partialInput)
        This method is called by the web component in response to a handler call (triggered by typing its associated key combination).
        Parameters:
        handlerId - the id of the handler to be called.
        partialInput - the partially entered input when the hander call occurred.