Share this page

com.hp.lft.sdk.stdwin

## Interface TreeViewNode

- All Superinterfaces:
    SupportDragAndDrop

      public interface TreeViewNode
      extends SupportDragAndDrop

  A single tree view node belonging to a standard Windows tree-view object.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `clickState()` Clicks the state icon.
    `void` | `collapse()` Hides sub-nodes of this node in the expanded tree-view control.
    `void` | `doubleClickState()` Double-clicks state icon.
    `void` | `enableLabelEditing()` Activates the edit mode for the node in the tree-view control to enable renaming.
    `void` | `expand()` Displays hidden sub-nodes of this node in the tree-view control.
    `void` | `expandAll()` Expands this node and all nodes below it, in the tree-view control.
    `java.lang.String` | `getFirstChildPath()` Returns the full path of the node's first child node as a semi-colon delimited String.
    `int` | `getImageIndex()` Returns the image index of the node.
    `java.lang.String` | `getNextSiblingPath()` Returns the full path of the node's next sibling node as a semi-colon delimited String.
    `int` | `getOverlayImageIndex()` Returns the index number of the current overlay image.
    `java.lang.String` | `getParentPath()` Returns the full path of the node's parent node as a semi-colon delimited String.
    `java.lang.String` | `getPath()` Returns the full path of the node as a semi-colon delimited String.
    `int` | `getState()` Returns the state image index of the node.
    `java.lang.String` | `getText()` Returns the text of the node, or "" when empty.
    `boolean` | `hasChildren()` Indicates whether the node has children.
    `boolean` | `isExpanded()` Indicates whether the node is expanded.
    `boolean` | `isSelected()` Indicates whether the node is selected.
    `void` | `setNodeState(int index)` Sets the state of the check box icon of the specified node in the tree-view control.

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

      `dragAndDropOn, dragAndDropOn`

- - ### Method Detail

    - #### isExpanded

          boolean isExpanded()
                      throws GeneralLeanFtException

      Indicates whether the node is expanded.
      Returns:
        true when the node is expanded.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getFirstChildPath

          java.lang.String getFirstChildPath()
                                      throws GeneralLeanFtException

      Returns the full path of the node's first child node as a semi-colon delimited String.
      Returns:
        the full path of the node's first child node as a semi-colon delimited String.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### hasChildren

          boolean hasChildren()
                       throws GeneralLeanFtException

      Indicates whether the node has children.
      Returns:
        true when the node has children.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getImageIndex

          int getImageIndex()
                     throws GeneralLeanFtException

      Returns the image index of the node.
      Returns:
        the image index of the node.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getNextSiblingPath

          java.lang.String getNextSiblingPath()
                                       throws GeneralLeanFtException

      Returns the full path of the node's next sibling node as a semi-colon delimited String.
      Returns:
        the full path of the node's next sibling node as a semi-colon delimited String.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getOverlayImageIndex

          int getOverlayImageIndex()
                            throws GeneralLeanFtException

      Returns the index number of the current overlay image.
      Returns:
        the index number of the current overlay image.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getParentPath

          java.lang.String getParentPath()
                                  throws GeneralLeanFtException

      Returns the full path of the node's parent node as a semi-colon delimited String.
      Returns:
        the full path of the node's parent node as a semi-colon delimited String.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getPath

          java.lang.String getPath()
                            throws GeneralLeanFtException

      Returns the full path of the node as a semi-colon delimited String.
      Returns:
        the full path of the node as a semi-colon delimited String.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isSelected

          boolean isSelected()
                      throws GeneralLeanFtException

      Indicates whether the node is selected.
      Returns:
        true when the node is selected.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getState

          int getState()
                throws GeneralLeanFtException

      Returns the state image index of the node.
      Returns:
        the state image index of the node.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getText

          java.lang.String getText()
                            throws GeneralLeanFtException

      Returns the text of the node, or "" when empty.
      Returns:
        the text of the node.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setNodeState

          void setNodeState(int index)
                     throws GeneralLeanFtException

      Sets the state of the check box icon of the specified node in the tree-view control.
      Parameters:
        `index` - the state index.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### clickState

          void clickState()
                   throws GeneralLeanFtException

      Clicks the state icon.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### doubleClickState

          void doubleClickState()
                         throws GeneralLeanFtException

      Double-clicks state icon.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### collapse

          void collapse()
                 throws GeneralLeanFtException

      Hides sub-nodes of this node in the expanded tree-view control.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### enableLabelEditing

          void enableLabelEditing()
                           throws GeneralLeanFtException

      Activates the edit mode for the node in the tree-view control to enable renaming.

      IMPORTANT: This method only enables the node for renaming. To actually rename the node, you must set its value using the EditField or Editor test object, together with an applicable method.

      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### expand

          void expand()
               throws GeneralLeanFtException

      Displays hidden sub-nodes of this node in the tree-view control.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### expandAll

          void expandAll()
                  throws GeneralLeanFtException

      Expands this node and all nodes below it, in the tree-view control.
      Throws:
        `GeneralLeanFtException` - if an 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: