com.hp.lft.sdk.powerbuilder

Interface TreeViewNode

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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.
      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.
      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.
      String getParentPath()
      Returns the full path of the node's parent node as a semi-colon delimited String.
      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.
      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.
    • Method Detail

      • getFirstChildPath

        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 error occurs during execution
      • getNextSiblingPath

        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 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 error occurs during execution
      • getParentPath

        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 error occurs during execution
      • getPath

        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 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 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 error occurs during execution