com.hp.lft.sdk.stdwin

Interface TreeViewNode

    • Method Summary

      Modifier and TypeMethod and Description
      voidclickState()
      Clicks the state icon.
      voidcollapse()
      Hides sub-nodes of this node in the expanded tree-view control.
      voiddoubleClickState()
      Double-clicks state icon.
      voidenableLabelEditing()
      Activates the edit mode for the node in the tree-view control to enable renaming.
      voidexpand()
      Displays hidden sub-nodes of this node in the tree-view control.
      voidexpandAll()
      Expands this node and all nodes below it, in the tree-view control.
      java.lang.StringgetFirstChildPath()
      Returns the full path of the node's first child node as a semi-colon delimited String.
      intgetImageIndex()
      Returns the image index of the node.
      java.lang.StringgetNextSiblingPath()
      Returns the full path of the node's next sibling node as a semi-colon delimited String.
      intgetOverlayImageIndex()
      Returns the index number of the current overlay image.
      java.lang.StringgetParentPath()
      Returns the full path of the node's parent node as a semi-colon delimited String.
      java.lang.StringgetPath()
      Returns the full path of the node as a semi-colon delimited String.
      intgetState()
      Returns the state image index of the node.
      java.lang.StringgetText()
      Returns the text of the node, or "" when empty.
      booleanhasChildren()
      Indicates whether the node has children.
      booleanisExpanded()
      Indicates whether the node is expanded.
      booleanisSelected()
      Indicates whether the node is selected.
      voidsetNodeState(int index)
      Sets the state of the check box icon of the specified node in the tree-view control.
    • Method Detail

      • 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.
      • 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.
      • 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.
      • 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.