Open topic with navigation

com.hp.lft.sdk.winforms

## Interface TreeViewNode

- All Superinterfaces:
    SupportDragAndDrop

      public interface TreeViewNode
      extends SupportDragAndDrop

  A tree view node of a .NET Windows Forms 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 the state icon.
    `void` | `enableLabelEditing()` Activates the edit mode for the node in the tree-view control to enable renaming.
    `void` | `expand()` Displays direct sub-nodes of this node in the tree-view control.
    `void` | `expandAll()` Displays all nodes of the sub-tree that has this node as the root.
    `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 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()` The text of this node.
    `boolean` | `hasChildren()` Indicates whether the node has children.
    `boolean` | `isExpanded()` Indicates whether this node is currently expanded.
    `boolean` | `isSelected()` Indicates whether this 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 this node is currently expanded.
      Returns:
        true if 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 path
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### hasChildren

          boolean hasChildren()
                       throws GeneralLeanFtException

      Indicates whether the node has children.
      Returns:
        true if 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
      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 path
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getOverlayImageIndex

          int getOverlayImageIndex()
                            throws GeneralLeanFtException

      Returns the index of the current overlay image.
      Returns:
        the index
      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 parent's path
      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 path
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isSelected

          boolean isSelected()
                      throws GeneralLeanFtException

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

    - #### getState

          int getState()
                throws GeneralLeanFtException

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

    - #### getText

          java.lang.String getText()
                            throws GeneralLeanFtException

      The text of this node. Returns an empty string if the node does not contain any text.
      Returns:
        the text
      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 the 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.
      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 direct sub-nodes of this node in the tree-view control.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### expandAll

          void expandAll()
                  throws GeneralLeanFtException

      Displays all nodes of the sub-tree that has this node as the root.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.