Open topic with navigation

com.hp.lft.sdk.stdwin

## Interface Editor

- All Superinterfaces:
    Clickable, DoubleClickable, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, TestObject, TestObjectDescriber, UiObjectBase, UiObjectWithLayoutInfo, VisibleProvider, WaitUntilVisibleProvider, WaitUntilEnabledProvider, EnabledProvider

      public interface Editor
      extends UiObjectWithLayoutInfo, TestObject

  A standard Windows multi-line editor.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `int` | `getCursorColumn()` Returns the character position where the cursor is located.
    `int` | `getCursorLine()` Returns the line where the cursor is located.
    `void` | `select(int fromLine, int fromCharPos, int toLine, int toCharPos)` Selects the specified content in the editor.
    `void` | `setCursorPosition(int line, int charPos)` Places the cursor at the specified point in the multi-line editor.

    - ### Methods inherited from interface com.hp.lft.sdk.stdwin.UiObjectWithLayoutInfo

      `isRightAligned, isRightToLeftLayout, isRightToLeftReading`

    - ### Methods inherited from interface com.hp.lft.sdk.stdwin.UiObjectBase

      `getAccessibleName, getAttachedText, getText, getWindowClassRegExp, getWindowExtendedStyle, getWindowExtendedStyleAsLong, getWindowId, getWindowStyle, getWindowStyleAsLong`

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

      `getHandle, getNativeClass, getWindowTitleRegExp, isEnabled, isFocused, isVisible, mouseMove`

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

      `click, click, click`

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

      `doubleClick, doubleClick, doubleClick`

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

      `getAbsoluteLocation, getLocation, getSize`

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

      `sendKeys, sendKeys`

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

      `dragAndDropOn, dragAndDropOn`

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

      `waitUntilEnabled, waitUntilEnabled`

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

      `isEnabled`

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

      `waitUntilVisible, waitUntilVisible`

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

      `isVisible`

- - ### Method Detail

    - #### getCursorLine

          int getCursorLine()
                     throws GeneralLeanFtException

      Returns the line where the cursor is located. (0-based)
      Returns:
        the line where the cursor is located. (0-based)
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getCursorColumn

          int getCursorColumn()
                       throws GeneralLeanFtException

      Returns the character position where the cursor is located. (0-based)
      Returns:
        the character position where the cursor is located. (0-based)
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setCursorPosition

          void setCursorPosition(int line,
                                 int charPos)
                          throws GeneralLeanFtException

      Places the cursor at the specified point in the multi-line editor.
      Parameters:
        `line` - the line in which the cursor is placed. (0-based)
        `charPos` - the character position at which the cursor is placed.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(int fromLine,
                      int fromCharPos,
                      int toLine,
                      int toCharPos)
               throws GeneralLeanFtException

      Selects the specified content in the editor.
      Note: All positions are 0-based.
      Parameters:
        `fromLine` - the line at which the selection starts, inclusive.
        `fromCharPos` - the character position at which the selection starts, inclusive.
        `toLine` - the line at which the selection ends, inclusive.
        `toCharPos` - the character position at which the selection ends, inclusive.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.