Share this page

com.hp.lft.sdk.java

# Interface TreeView

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

      public interface TreeView
      extends TreeViewBase, UiObjectBase, TestObject

  A Java tree.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateNode(String nodePath)` Activates a node in the tree by node path.
    `void` | `activateNode(TreeViewNode node)` Activates a node in the tree.
    `void` | `deselect(TreeViewNode... nodes)` Clears the selection of nodes in the tree.
    `void` | `extendSelect(TreeViewNode... nodes)` Selects additional nodes in the tree.
    `String` | `getColumnHeader(int columnIndex)` Returns the header of the specified column in the tree.
    `TreeViewNode` | `getNode(String nodePath)` Returns the specified node.
    `List<TreeViewNode>` | `getSelectedNodes()` Returns the selected nodes in the tree.
    `int` | `getVisibleNodesCount()` Returns the number of visible nodes in the tree.
    `void` | `select(TreeViewNode... nodes)` Selects the specified nodes.
    `void` | `selectRange(TreeViewNode fromNode, TreeViewNode toNode)` Selects the specified range of nodes.

    - ### Methods inherited from interface com.hp.lft.sdk.java.TreeViewBase

      `buildNodePath, deselect, deselectRange, extendSelect, getColumnsCount, select, selectRange`

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

      `createObject, createObject, fireEvent, getAttachedText, getBackgroundColor, getForegroundColor, getLabel, getNativeClass, getObjectName, getObjectProperty, getPath, getStatics, getTagName, isFocused, sendKeys, sendKeys`

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

      `getNativeObject`

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

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

- - ### Method Detail

    - #### getVisibleNodesCount

          int getVisibleNodesCount()
                            throws GeneralLeanFtException

      Returns the number of visible nodes in the tree.
      Returns:
        the number of visible nodes.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getSelectedNodes

          List<TreeViewNode> getSelectedNodes()
                                       throws GeneralLeanFtException

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

    - #### activateNode

          void activateNode(TreeViewNode node)
                     throws GeneralLeanFtException

      Activates a node in the tree.
      Parameters:
        `node` - the node to activate.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activateNode

          void activateNode(String nodePath)
                     throws GeneralLeanFtException

      Activates a node in the tree by node path.
      Parameters:
        `nodePath` - the full path of the node to activate.
        Tip: Use the `TreeViewBase.buildNodePath(java.lang.Object...)` method to build the node path string to be used as the nodePath argument for this method.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselect

          void deselect(TreeViewNode... nodes)
                 throws GeneralLeanFtException

      Clears the selection of nodes in the tree.
      Parameters:
        `nodes` - the nodes to deselect.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelect

          void extendSelect(TreeViewNode... nodes)
                     throws GeneralLeanFtException

      Selects additional nodes in the tree.
      Parameters:
        `nodes` - the nodes to add to the selection.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution.

    - #### getColumnHeader

          String getColumnHeader(int columnIndex)
                          throws GeneralLeanFtException

      Returns the header of the specified column in the tree.
      Parameters:
        `columnIndex` - 0-based index of the column from which to return the value.
      Returns:
        the header of the specified column.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getNode

          TreeViewNode getNode(String nodePath)
                        throws GeneralLeanFtException

      Returns the specified node.
      Parameters:
        `nodePath` - the full path of the node to return within the tree.
        Tip: Use the `TreeViewBase.buildNodePath(java.lang.Object...)` method to build the node path string to be used as the nodePath argument for this method.
      Returns:
        the specified node.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(TreeViewNode... nodes)
               throws GeneralLeanFtException

      Selects the specified nodes.
      Parameters:
        `nodes` - the nodes to select.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectRange

          void selectRange(TreeViewNode fromNode,
                           TreeViewNode toNode)
                    throws GeneralLeanFtException

      Selects the specified range of nodes.
      Parameters:
        `fromNode` - the first node in the range.
        `toNode` - the last node of the range.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: