Open topic with navigation

com.hp.lft.sdk.te

## Interface Screen

- All Superinterfaces:
    ScreenBase, TestObject, TestObjectDescriber

      public interface Screen
      extends TestObject, ScreenBase

  A terminal emulator screen that fully supports HLLAPI.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `Position` | `getCursorPosition()` Returns the Terminal Emulator screen current row and current column.
    `int` | `getId()` Returns the Terminal Emulator Screen ID.
    `int` | `getInputFieldCount()` Returns the Terminal Emulator screen input field count.
    `java.lang.String` | `getLabel()` Returns the Terminal Emulator screen label.
    `int` | `getProtectedFieldCount()` Returns the Terminal Emulator screen protected field count.
    `void` | `sendTEKeys(java.lang.String keys)` Sends a keystroke or string of keystrokes to the current cursor position in the emulator screen.
    `void` | `setCursorPosition(int row, int column)` Changes the position of the cursor within the emulator screen.
    `void` | `setCursorPosition(Position position)` Changes the position of the cursor within the emulator screen.
    `void` | `setText(java.lang.String text)` Copies a string to a specific location in the emulator screen.
    `void` | `setText(java.lang.String text, int row, int column)` Copies a string to a specific location in the emulator screen.
    `void` | `setText(java.lang.String text, Position position)` Copies a string to a specific location in the emulator screen.

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

    - ### Methods inherited from interface com.hp.lft.sdk.te.ScreenBase

      `getSize, getText, getText, sync, sync, waitForText, waitForText, waitForText, waitForText, waitForText, waitForText, waitForText, waitForText`

- - ### Method Detail

    - #### 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 an error occurs during execution.

    - #### getLabel

          java.lang.String getLabel()
                             throws GeneralLeanFtException

      Returns the Terminal Emulator screen label.
      Returns:
        Terminal Emulator screen label.
      Throws:
        `GeneralLeanFtException` - if an 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 an error occurs during execution.

    - #### getId

          int getId()
             throws GeneralLeanFtException

      Returns the Terminal Emulator Screen ID.
      Returns:
        Terminal Emulator Screen ID.
      Throws:
        `GeneralLeanFtException` - if an 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 an error occurs during execution.

    - #### sendTEKeys

          void sendTEKeys(java.lang.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 an error occurs during execution.

    - #### setText

          void setText(java.lang.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 an error occurs during execution.

    - #### setText

          void setText(java.lang.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 an error occurs during execution.

    - #### setText

          void setText(java.lang.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 an 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 an 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 an error occurs during execution.