Interface Screen

All Superinterfaces:
ScreenBase, TestObject, TestObjectDescriber

public interface Screen extends TestObject, ScreenBase
A terminal emulator screen that fully supports HLLAPI.
  • Method Details

    • getCursorPosition

      Position getCursorPosition() throws GeneralLeanFtException
      Returns the Terminal Emulator screen current row and current column.
      Returns:
      Terminal Emulator screen current row and current column.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getLabel

      String getLabel() throws GeneralLeanFtException
      Returns the Terminal Emulator screen label.
      Returns:
      Terminal Emulator screen label.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getInputFieldCount

      int getInputFieldCount() throws GeneralLeanFtException
      Returns the Terminal Emulator screen input field count.
      Returns:
      Terminal Emulator screen input field count.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getId

      int getId() throws GeneralLeanFtException
      Returns the Terminal Emulator Screen ID.
      Returns:
      Terminal Emulator Screen ID.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getProtectedFieldCount

      int getProtectedFieldCount() throws GeneralLeanFtException
      Returns the Terminal Emulator screen protected field count.
      Returns:
      Terminal Emulator screen protected field count.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • sendTEKeys

      void sendTEKeys(String keys) throws GeneralLeanFtException
      Sends a keystroke or string of keystrokes to the current cursor position in the emulator screen.
      Parameters:
      keys - The string to type in the object. The string can include constants from the Keys class, which represent keyboard keys.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • setText

      void setText(String text, Position position) throws GeneralLeanFtException
      Copies a string to a specific location in the emulator screen.
      Parameters:
      text - The text that will be written in the specified position within the emulator screen.
      position - The specified Position within the emulator screen.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • setText

      void setText(String text, int row, int column) throws GeneralLeanFtException
      Copies a string to a specific location in the emulator screen.
      Parameters:
      text - The text that will be written in the specified position within the emulator screen.
      row - The row position within the emulator screen.
      column - The column position within the emulator screen.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • setText

      void setText(String text) throws GeneralLeanFtException
      Copies a string to a specific location in the emulator screen.
      Parameters:
      text - The text that will be written in the specified position within the emulator screen.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • setCursorPosition

      void setCursorPosition(Position position) throws GeneralLeanFtException
      Changes the position of the cursor within the emulator screen.
      Parameters:
      position - The specified Position screen rectangle.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • setCursorPosition

      void setCursorPosition(int row, int column) throws GeneralLeanFtException
      Changes the position of the cursor within the emulator screen.
      Parameters:
      row - The row position within the emulator screen.
      column - The column position within the emulator screen.
      Throws:
      GeneralLeanFtException - if error occurs during execution