ro.sync.exml.workspace.api.editor.page
Interface WSOutline

All Known Subinterfaces:

AuthorOutlineAccess

public interface WSOutline

The Workspace Outline.

*********************************
EXPERIMENTAL - Subject to change
*********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Since:

11.2

Method Summary

TreePath[]	getSelectedPaths(boolean minimizeSelectedPaths) Get the tree paths selected in the Outline tree.
void	setSelectionPaths(TreePath[] treePath) Select and scroll the given tree paths.

Method Detail

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.