Interface Field

All Superinterfaces:
TestObject, TestObjectDescriber, VisibleProvider, WaitUntilVisibleProvider

public interface Field extends TestObject, WaitUntilVisibleProvider
A terminal emulator field that fully supports HLLAPI.
  • Method Details

    • getText

      String getText() throws GeneralLeanFtException
      Returns the Terminal Emulator Field text.
      Returns:
      Terminal Emulator Field text.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getLength

      int getLength() throws GeneralLeanFtException
      Returns the Terminal Emulator Field length.
      Returns:
      Terminal Emulator Field length.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getAttachedText

      String getAttachedText() throws GeneralLeanFtException
      Returns the Terminal Emulator Field attached text.
      Returns:
      Terminal Emulator Field attached text.
      Throws:
      GeneralLeanFtException - if 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 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 error occurs during execution
    • isVisible

      boolean isVisible() throws GeneralLeanFtException
      Returns the Visible attribute for TeField.
      Specified by:
      isVisible in interface VisibleProvider
      Returns:
      Visible attribute for TeField.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getId

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

      String getBackgroundColor() throws GeneralLeanFtException
      Returns the background color of the terminal emulator field.
      Returns:
      the terminal emulator field background color.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getColor

      String getColor() throws GeneralLeanFtException
      Returns the color of the text in the terminal emulator field.
      Returns:
      the terminal emulator field color.
      Throws:
      GeneralLeanFtException - if 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 error occurs during execution
    • setText

      void setText(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 error occurs during execution
    • setText

      void setText(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 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 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 error occurs during execution
    • setSecure

      void setSecure(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 error occurs during execution