oracle.ide.navigator
Interface NavigatorManager

public interface NavigatorManager

The NavigatorManager is responsible for managing the creation of the system navigator and transient navigators opened on selected nodes.

Method Summary

void	addContextMenuListener(ContextMenuListener l, java.lang.Class cls) Adds a context menu listener to all NavigatorWindows.
void	addViewCreationListener(ViewCreationListener l) Adds a listener for view creation events.
NavigatorWindow	createView(Context context, ViewId viewId) Creates a new navigator view with the specified context, and identified by the given viewId.
ChildFilter	findFilter(java.lang.Class elementClass) Find the ChildFilter associated with the specified elementClass.
ContextMenu	getContextMenu() Get the ContextMenu to be shared by all Editors.
NavigatorWindow	getSystemNavigator() Returns the system navigator.
void	initialize() Initialize the log window management.
void	initIconOverlayCache() Initializes the shared IconOverlayCache for navigator window explorers.
boolean	isNavigatorOpen(Context context) Returns true if a navigator is opened on the specified context.
boolean	isSystemNavigator(ViewId viewId) Returns true if the view identified by the give viewId is the system navigator.
boolean	isSystemNavigatorVisible() Returns true if the system navigator is visible.
NavigatorWindow	openNavigator(Context context) Open a navigator based on the specified context.
void	registerExtension(Extension ext, java.lang.Class cls) Register a navigator extension.
void	registerFilter(java.lang.Class elementClass, java.lang.Class childFilterClass, URLFilter urlFilter)
void	removeContextMenuListener(ContextMenuListener l) Remove the specified ContextMenuListener.
void	removeViewCreationListener(ViewCreationListener l) Removes the specified ViewCreationListener.
NavigatorWindow	showNavigator(Context context) Show a navigator based on the specified context.
void	toggleSystemNavigator(Context context) Toggles the visibility of the system navigator.

Method Detail

initialize

public void initialize()

Initialize the log window management. This method is called during the system startup process.

getContextMenu

public ContextMenu getContextMenu()

Get the ContextMenu to be shared by all Editors.

isSystemNavigatorVisible

public boolean isSystemNavigatorVisible()

Returns true if the system navigator is visible.

isSystemNavigator

public boolean isSystemNavigator(ViewId viewId)

Returns true if the view identified by the give viewId is the system navigator.

toggleSystemNavigator

public void toggleSystemNavigator(Context context)

Toggles the visibility of the system navigator.

getSystemNavigator

public NavigatorWindow getSystemNavigator()

Returns the system navigator.

openNavigator

public NavigatorWindow openNavigator(Context context)

Open a navigator based on the specified context. If an existing navigator based on the context exist it shows it. If the system navigator contains the context selected element, it shows the system navigator, and expands the corresponding node. Otherwise, it opens a new navigator.

showNavigator

public NavigatorWindow showNavigator(Context context)

Show a navigator based on the specified context. It creates a new navigator if none found. Otherwise, it shows it.

isNavigatorOpen

public boolean isNavigatorOpen(Context context)

Returns true if a navigator is opened on the specified context.

createView

public NavigatorWindow createView(Context context,
                                  ViewId viewId)

Creates a new navigator view with the specified context, and identified by the given viewId.

addContextMenuListener

public void addContextMenuListener(ContextMenuListener l,
                                   java.lang.Class cls)

Adds a context menu listener to all NavigatorWindows. The listener will be called when users pop-up the menu on nodes of type cls. Specifying null for the cls parameter will cause the listener to be called when a menu is pop-up on any node type.

removeContextMenuListener

public void removeContextMenuListener(ContextMenuListener l)

Remove the specified ContextMenuListener.

registerFilter

public void registerFilter(java.lang.Class elementClass,
                           java.lang.Class childFilterClass,
                           URLFilter urlFilter)

findFilter

public ChildFilter findFilter(java.lang.Class elementClass)

Find the ChildFilter associated with the specified elementClass.

registerExtension

public void registerExtension(Extension ext,
                              java.lang.Class cls)

Register a navigator extension. Extensions are called when the navigator builds the context. Extensions get a chance to update the context before it is returned to the client requesting the context.

Parameters:

ext - the extension to register.

cls - the Element class for which the specified extension will be called.

initIconOverlayCache

public void initIconOverlayCache()

Initializes the shared IconOverlayCache for navigator window explorers.

addViewCreationListener

public void addViewCreationListener(ViewCreationListener l)

Adds a listener for view creation events. The listener will be called when any NavigatorWindow view is created.

removeViewCreationListener

public void removeViewCreationListener(ViewCreationListener l)

Removes the specified ViewCreationListener.