Extension SDK

oracle.ide.navigator
Interface NavigatorWindow

All Superinterfaces:
Dockable, Helpable, Subview, View

public interface NavigatorWindow
extends View, Dockable

NavigatorWindow interface provides the API for managing the contents of a navigator window tree.

See Also:
Observer

Field Summary
static java.lang.String NAVIGATOR_WINDOW_ID
          The navigator window view ID.
 
Fields inherited from interface oracle.ide.addin.View
PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Fields inherited from interface oracle.ide.docking.Dockable
TYPE_DISCARDABLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE
 
Method Summary
 void collapse(TNode tnode, boolean all)
          Collapse the specified TNode.
 void expand(TNode tnode, boolean all)
          Expand the specified TNode.
 TNode findTNode(Element element, TNode root)
          Find the specified element.
 java.util.Comparator getComparator()
          Returns the default Comparator that is used to sort children of container nodes managed by this TreeExplorer.
 NodeOverlayManager getOverlayManager()
          Returns the overlay icon manager for this navigator.
 Toolbar getToolbar()
          Get the navigator window's toolbar.
 TreeExplorer getTreeExplorer()
          Returns the TreeExplorer implementing the tree behavior for this navigator.
 void refresh(TNode tnode)
          Closes and re-opens the specified tnode.
 void setComparator(java.util.Comparator comparator)
          Sets the default Comparator that is used to sort children of container nodes managed by this TreeExplorer.
 void setOverlayManager(NodeOverlayManager manager)
          Sets the overlay icon manager for coordinating overlays for the window.
 void setRootVisible(boolean visible)
          Hides the navigator root node if the visible parameter is false.
 
Methods inherited from interface oracle.ide.addin.View
activate, addViewListener, addViewSelectionListener, deactivate, getContext, getId, getSelection, removeViewListener, removeViewSelectionListener, updateTitle
 
Methods inherited from interface oracle.ide.help.Helpable
getHelpInfo
 
Methods inherited from interface oracle.ide.addin.Subview
close, getContext, getContextMenu, getController, getGUI, isVisible, owner, show
 
Methods inherited from interface oracle.ide.docking.Dockable
addTitleChangeListener, getHostedComponent, getMenuPreferredMnemonic, getMenuTitle, getSite, getTabDropListener, getTabIcon, getTabName, getTitleName, getType, getUniqueName, loadLayout, removeTitleChangeListener, saveLayout, setSite
 

Field Detail

NAVIGATOR_WINDOW_ID

public static final java.lang.String NAVIGATOR_WINDOW_ID
The navigator window view ID.
Method Detail

getToolbar

public Toolbar getToolbar()
Get the navigator window's toolbar.
Specified by:
getToolbar in interface View

setRootVisible

public void setRootVisible(boolean visible)
Hides the navigator root node if the visible parameter is false.

collapse

public void collapse(TNode tnode,
                     boolean all)
Collapse the specified TNode. If the boolean flag all is set to true, all descendents are also collapsed.

expand

public void expand(TNode tnode,
                   boolean all)
Expand the specified TNode. If the boolean flag all is set to true, all descendents are also expanded.

findTNode

public TNode findTNode(Element element,
                       TNode root)
Find the specified element. Start looking recursively depth first from the given root node. This method will open nodes in order to carry out the search. For other types of searches get the TreeExplorer using the getTreeExplorer() method. The TreeExplorer class provides other search methods.

refresh

public void refresh(TNode tnode)
Closes and re-opens the specified tnode.

getComparator

public java.util.Comparator getComparator()
Returns the default Comparator that is used to sort children of container nodes managed by this TreeExplorer. This default comparator may be overridden for a specific TNode by calling TNode.setComparator(Comparator).

setComparator

public void setComparator(java.util.Comparator comparator)
Sets the default Comparator that is used to sort children of container nodes managed by this TreeExplorer. If the default comparator changes, the tree is recreated.

getOverlayManager

public NodeOverlayManager getOverlayManager()
Returns the overlay icon manager for this navigator.

setOverlayManager

public void setOverlayManager(NodeOverlayManager manager)
Sets the overlay icon manager for coordinating overlays for the window. Do not call this method directly from an addin, instead use its namesake in the navigator manager.
Parameters:
manager - the manager to set.

getTreeExplorer

public TreeExplorer getTreeExplorer()
Returns the TreeExplorer implementing the tree behavior for this navigator.

Extension SDK