Open topic with navigation

com.hp.lft.sdk.te

## Interface Field

- All Superinterfaces:
    TestObject, TestObjectDescriber, VisibleProvider, WaitUntilVisibleProvider

      public interface Field
      extends TestObject

  A terminal emulator field that fully supports HLLAPI.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getAttachedText()` Returns the Terminal Emulator Field attached text.
    `int` | `getId()` Returns the Terminal Emulator Field ID.
    `int` | `getLength()` Returns the Terminal Emulator Field length.
    `Position` | `getStartPosition()` Returns the Terminal Emulator Field start column and row column property.
    `java.lang.String` | `getText()` Returns the Terminal Emulator Field text.
    `boolean` | `isNumeric()` Returns the Terminal Emulator Field numeric property.
    `boolean` | `isProtected()` Returns the Terminal Emulator Field protected property.
    `boolean` | `isVisible()` Returns the Visible attribute for TeField.
    `void` | `setCursor()` Places the cursor in the specified position within the field.
    `void` | `setCursor(long offset)` Places the cursor in the specified position within the field.
    `void` | `setSecure(java.lang.String codedString)` Inserts text into a hidden (invisible) field.
    `void` | `setText(java.lang.String text)` Inserts text into an unprotected field.
    `void` | `setText(java.lang.String text, long offset)` Inserts text into an unprotected field.

    - ### 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.WaitUntilVisibleProvider

      `waitUntilVisible, waitUntilVisible`

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

      `isVisible`

- - ### Method Detail

    - #### getText

          java.lang.String getText()
                            throws GeneralLeanFtException

      Returns the Terminal Emulator Field text.
      Returns:
        Terminal Emulator Field text.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getLength

          int getLength()
                 throws GeneralLeanFtException

      Returns the Terminal Emulator Field length.
      Returns:
        Terminal Emulator Field length.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getAttachedText

          java.lang.String getAttachedText()
                                    throws GeneralLeanFtException

      Returns the Terminal Emulator Field attached text.
      Returns:
        Terminal Emulator Field attached text.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isNumeric

          boolean isNumeric()
                     throws GeneralLeanFtException

      Returns the Terminal Emulator Field numeric property.
      Returns:
        Terminal Emulator Field numeric property.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isProtected

          boolean isProtected()
                       throws GeneralLeanFtException

      Returns the Terminal Emulator Field protected property.
      Returns:
        Terminal Emulator Field protected property.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isVisible

          boolean isVisible()
                     throws GeneralLeanFtException

      Returns the Visible attribute for TeField.
      Returns:
        Visible attribute for TeField.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getId

          int getId()
             throws GeneralLeanFtException

      Returns the Terminal Emulator Field ID.
      Returns:
        Terminal Emulator Field ID.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getStartPosition

                                                      Position getStartPosition()
                             throws GeneralLeanFtException

      Returns the Terminal Emulator Field start column and row column property.
      Returns:
        Terminal Emulator Field start column and row column property.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setText

          void setText(java.lang.String text,
                       long offset)
                throws GeneralLeanFtException

      Inserts text into an unprotected field.
      Parameters:
        `text` - the string that will be inserted in the field.
        `offset` - the position in the field of the text.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setText

          void setText(java.lang.String text)
                throws GeneralLeanFtException

      Inserts text into an unprotected field. The default value for the position in the field is 0.
      Parameters:
        `text` - the string that will be inserted in the field.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setCursor

          void setCursor(long offset)
                  throws GeneralLeanFtException

      Places the cursor in the specified position within the field.
      Parameters:
        `offset` - the position in the field where the cursor will be positioned.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setCursor

          void setCursor()
                  throws GeneralLeanFtException

      Places the cursor in the specified position within the field. The default value for the position in the field is 0.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setSecure

          void setSecure(java.lang.String codedString)
                  throws GeneralLeanFtException

      Inserts text into a hidden (invisible) field.
      Parameters:
        `codedString` - the coded string which will be inserted in the field.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.