Oxygen XML Editor 14.2 Author API

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

All Known Subinterfaces:
AuthorOutlineAccess

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WSOutline

The Workspace Outline.

Since:
11.2

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

Method Detail

getSelectedPaths

javax.swing.tree.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(javax.swing.tree.TreePath[] treePath)
Select and scroll the given tree paths.

Parameters:
treePath - The path to select.

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.