Package com.hp.lft.sdk.java

Interface TreeViewBase

All Known Subinterfaces:
TreeView, TreeViewTable
public interface TreeViewBase
The base interface for a Java Tree.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    buildNodePath(Object... nodePathParts)
    Returns the path of a node in the tree.
    void
    deselect(String... nodesPaths)
    Clears the selection of nodes in the tree by nodes paths.
    void
    deselectRange(String fromNodePath, String toNodePath)
    Clears the selection of the specified range of nodes in the tree.
    void
    extendSelect(String... nodesPaths)
    Selects additional nodes in the tree.
    int
    getColumnsCount()
    Returns the number of columns in the tree.
    void
    select(String... nodesPaths)
    Selects the specified nodes by nodes paths.
    void
    selectRange(String fromNodePath, String toNodePath)
    Selects the specified range of nodes.

  • Method Details

    • buildNodePath

      String buildNodePath(Object... nodePathParts)
      Returns the path of a node in the tree.
      Parameters:
      nodePathParts - the node path parts can be: text(string) or numeric index(int). Index values are 0-based.
      Returns:
      the tree node path.

    • getColumnsCount

      int getColumnsCount() throws GeneralLeanFtException
      Returns the number of columns in the tree.
      Returns:
      the number of columns.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • extendSelect

      void extendSelect(String... nodesPaths) throws GeneralLeanFtException
      Selects additional nodes in the tree.
      Parameters:
      nodesPaths - the paths of the nodes to add to the selection.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • deselect

      void deselect(String... nodesPaths) throws GeneralLeanFtException
      Clears the selection of nodes in the tree by nodes paths.
      Parameters:
      nodesPaths - the paths of the nodes to deselect.
      Tip: Use the buildNodePath(java.lang.Object...) method to build the node path strings to be used as arguments for this method.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • deselectRange

      void deselectRange(String fromNodePath, String toNodePath) throws GeneralLeanFtException
      Clears the selection of the specified range of nodes in the tree.
      Parameters:
      fromNodePath - 0-based index of the first node in the range.
      Tip: Use the buildNodePath(java.lang.Object...) method to build the node path strings to be used as the fromNodePath and toNodePath arguments for this method.
      toNodePath - 0-based index of the last node of the range.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • select

      void select(String... nodesPaths) throws GeneralLeanFtException
      Selects the specified nodes by nodes paths.
      Parameters:
      nodesPaths - the paths of the nodes to select.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • selectRange

      void selectRange(String fromNodePath, String toNodePath) throws GeneralLeanFtException
      Selects the specified range of nodes.
      Parameters:
      fromNodePath - 0-based index of the first node in the range.
      toNodePath - 0-based index of the last node of the range. Tip: Use the buildNodePath(java.lang.Object...) method to build the node path strings to be used as the fromNodePath and toNodePath arguments for this method.
      Throws:
      GeneralLeanFtException - if error occurs during execution