Open topic with navigation

com.hp.lft.sdk.winforms

## Interface TreeView

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

      public interface TreeView
      extends UiObjectBase, TestObject

  A .NET Windows Forms tree-view object.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateNode(int nodeIndex)` Activates the node with the specified index in the tree-view control.
    `void` | `activateNode(int nodeIndex, MouseButton button)` Activates (double-clicks) a node by index in the tree-view control.
    `void` | `activateNode(java.lang.String nodePath)` Activates the node at the given path in the tree-view control.
    `void` | `activateNode(java.lang.String nodePath, MouseButton button)` Activates (double-clicks) the node at the given path in the tree-view control.
    `void` | `activateNode(TreeViewNode node)` Activates a node in the tree-view control.
    `void` | `activateNode(TreeViewNode node, MouseButton button)` Activates (double-clicks) a node in this tree-view control.
    `java.util.List<TreeViewNode>` | `getCheckedVisibleNodes()` Returns the checked visible nodes in the tree-view control.
    `java.lang.String` | `getErrorText()` Returns the tooltip text of the error icon associated with this object.
    `TreeViewNode` | `getNode(java.lang.String nodePath)` Returns the node at the given path.
    `java.util.List<TreeViewNode>` | `getSelectedNodes()` Returns the selected nodes in the tree-view control.
    `java.util.List<TreeViewNode>` | `getVisibleNodes()` Returns the visible nodes in the tree-view control.
    `void` | `select(int nodeIndex)` Selects the node with the specified index in the tree-view control.
    `void` | `select(int nodeIndex, MouseButton button)` Selects the node with the specified index in the tree-view control.
    `void` | `select(java.lang.String nodePath)` Selects the node at the specified path in the tree-view control.
    `void` | `select(java.lang.String nodePath, MouseButton button)` Selects the node at the specified path in the tree-view control.
    `void` | `select(TreeViewNode node)` Selects a node in the tree-view control.
    `void` | `select(TreeViewNode node, MouseButton button)` Selects a node in the tree-view control.

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

      `fireEvent, getFullNamePath, getFullType, getObjectName, getObjectProperty, getText, getWindowClassRegExp, getWindowId, isChildWindow, isOwnedWindow`

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

      `getNativeObject`

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

    - #### activateNode

          void activateNode(TreeViewNode node,
                            MouseButton button)
                     throws GeneralLeanFtException

      Activates (double-clicks) a node in this tree-view control.
      Parameters:
        `node` - the node to activate
        `button` - the mouse button used to activate the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateNode

          void activateNode(java.lang.String nodePath,
                            MouseButton button)
                     throws GeneralLeanFtException

      Activates (double-clicks) the node at the given path in the tree-view control.
      Parameters:
        `nodePath` - the path
        `button` - the mouse button used to activate the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateNode

          void activateNode(int nodeIndex,
                            MouseButton button)
                     throws GeneralLeanFtException

      Activates (double-clicks) a node by index in the tree-view control.
      Parameters:
        `nodeIndex` - the index
        `button` - the mouse button used to activate the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateNode

          void activateNode(TreeViewNode node)
                     throws GeneralLeanFtException

      Activates a node in the tree-view control.
      Parameters:
        `node` - the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateNode

          void activateNode(java.lang.String nodePath)
                     throws GeneralLeanFtException

      Activates the node at the given path in the tree-view control.
      Parameters:
        `nodePath` - the path
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateNode

          void activateNode(int nodeIndex)
                     throws GeneralLeanFtException

      Activates the node with the specified index in the tree-view control.
      Parameters:
        `nodeIndex` - the index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getCheckedVisibleNodes

          java.util.List<TreeViewNode> getCheckedVisibleNodes()
                                                       throws GeneralLeanFtException

      Returns the checked visible nodes in the tree-view control.
      Returns:
        the checked visible nodes
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getVisibleNodes

          java.util.List<TreeViewNode> getVisibleNodes()
                                                throws GeneralLeanFtException

      Returns the visible nodes in the tree-view control.
      Returns:
        the visible nodes
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedNodes

          java.util.List<TreeViewNode> getSelectedNodes()
                                                 throws GeneralLeanFtException

      Returns the selected nodes in the tree-view control.
      Returns:
        the selected nodes
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(TreeViewNode node,
                      MouseButton button)
               throws GeneralLeanFtException

      Selects a node in the tree-view control.
      Parameters:
        `node` - the node to select
        `button` - the mouse button used to select the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(java.lang.String nodePath,
                      MouseButton button)
               throws GeneralLeanFtException

      Selects the node at the specified path in the tree-view control.
      Parameters:
        `nodePath` - the path
        `button` - the mouse button used to select the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(int nodeIndex,
                      MouseButton button)
               throws GeneralLeanFtException

      Selects the node with the specified index in the tree-view control.
      Parameters:
        `nodeIndex` - the index
        `button` - the mouse button used to select the node
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(TreeViewNode node)
               throws GeneralLeanFtException

      Selects a node in the tree-view control.
      Parameters:
        `node` - the node to select
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(java.lang.String nodePath)
               throws GeneralLeanFtException

      Selects the node at the specified path in the tree-view control.
      Parameters:
        `nodePath` - the path
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(int nodeIndex)
               throws GeneralLeanFtException

      Selects the node with the specified index in the tree-view control.
      Parameters:
        `nodeIndex` - the index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getNode

                                                      TreeViewNode getNode(java.lang.String nodePath)

      Returns the node at the given path. If the path is not unique, the first matching node is returned.
      Parameters:
        `nodePath` - the path of the node to retrieve separated by ; char.
      Returns:
        a the node

    - #### getErrorText

          java.lang.String getErrorText()
                                 throws GeneralLeanFtException

      Returns the tooltip text of the error icon associated with this object.
      Returns:
        the tooltip text
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.