Open topic with navigation

com.hp.lft.sdk.insight

## Interface InsightObject

- All Superinterfaces:
    Clickable, DoubleClickable, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, TestObject, TestObjectDescriber

      public interface InsightObject
      extends TestObject, Clickable, DoubleClickable, LocationInfoProvider, SupportSendKeys, SupportDragAndDrop

  An object identified using image-based recognition.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `clickSpecial()` Clicks the object, without first bringing its parent into focus.
    `void` | `clickSpecial(ClickArgs args)` Clicks the object, without first bringing its parent into focus.
    `void` | `clickSpecial(MouseButton button)` Clicks the object, without first bringing its parent into focus.
    `java.lang.String` | `getVisibleText()` Returns the visible text from the entire Test Object area.
    `java.lang.String` | `getVisibleText(java.awt.Rectangle textArea)` Returns the visible text from the text area within the test object area.
    `void` | `hover(Location location)` Places the pointer on the object.
    `void` | `longClick()` Presses and holds the left mouse button for a default number of seconds.
    `void` | `longClick(double duration)` Presses and holds the left mouse button for a default number of seconds.
    `void` | `longClick(double duration, Location location)` Presses and holds the left mouse button for a default number of seconds.
    `void` | `longClick(Location location)` Presses and holds the left mouse button for a default number of seconds.

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

- - ### Method Detail

    - #### getVisibleText

          java.lang.String getVisibleText()
                                   throws GeneralLeanFtException

      Returns the visible text from the entire Test Object area.
      Specified by:
        `getVisibleText` in interface `TestObject`
      Returns:
        all visible text from this object.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getVisibleText

          java.lang.String getVisibleText(java.awt.Rectangle textArea)
                                   throws GeneralLeanFtException

      Returns the visible text from the text area within the test object area.
      Specified by:
        `getVisibleText` in interface `TestObject`
      Parameters:
        `textArea` - an inner rectangle within the test object area, to get the visible text from.
      Returns:
        all visible text within the supplied rectangle.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### clickSpecial

          void clickSpecial()
                     throws GeneralLeanFtException

      Clicks the object, without first bringing its parent into focus.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### clickSpecial

          void clickSpecial(MouseButton button)
                     throws GeneralLeanFtException

      Clicks the object, without first bringing its parent into focus.
      Parameters:
        `button` - the mouse button to perform the click with.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### clickSpecial

          void clickSpecial(ClickArgs args)
                     throws GeneralLeanFtException

      Clicks the object, without first bringing its parent into focus.
      Parameters:
        `args` - arguments that will be used during the click.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### hover

          void hover(Location location)
              throws GeneralLeanFtException

      Places the pointer on the object.
      Parameters:
        `location` - defines the location to place the pointer.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### longClick

          void longClick()
                  throws GeneralLeanFtException

      Presses and holds the left mouse button for a default number of seconds.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### longClick

          void longClick(Location location)
                  throws GeneralLeanFtException

      Presses and holds the left mouse button for a default number of seconds.
      Parameters:
        `location` - defines the location to place the pointer when pressing the mouse button.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### longClick

          void longClick(double duration,
                         Location location)
                  throws GeneralLeanFtException

      Presses and holds the left mouse button for a default number of seconds.
      Parameters:
        `duration` - the number of seconds to hold the left mouse button when long-clicking.
        `location` - defines the location to place the pointer when pressing the mouse button.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### longClick

          void longClick(double duration)
                  throws GeneralLeanFtException

      Presses and holds the left mouse button for a default number of seconds.
      Parameters:
        `duration` - the number of seconds to hold the left mouse button when long-clicking.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.