Interface WSOutline

All Known Subinterfaces:
AuthorOutlineAccess

@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSOutline
The Workspace Outline.
Since:
11.2
  • Method Summary

    Modifier and Type
    Method
    Description
    getSelectedPaths(boolean minimizeSelectedPaths)
    Get the tree paths selected in the Outline tree.
    void
    Select and scroll the given tree paths.
  • Method Details

    • getSelectedPaths

      TreePath[] getSelectedPaths(boolean minimizeSelectedPaths)
      Get the tree paths selected in the Outline tree. The tree path contain arrays of AuthorNodes starting from the AuthorDocument and ending in the selected leaf node. The bread crumb displays the path to the last node selected in the Outline.
      Parameters:
      minimizeSelectedPaths - If true and a parent and a child is selected, then only the parent is the list.
      Returns:
      The nodes selected in the Outline tree
    • setSelectionPaths

      void setSelectionPaths(TreePath[] treePath)
      Select and scroll the given tree paths.
      Parameters:
      treePath - The path to select.