oracle.ide.navigator
Class NavigatorManager

java.lang.Object
  oracle.ide.view.MultiManager
      oracle.ide.navigator.NavigatorManager

All Implemented Interfaces:

Addin, Controller

Direct Known Subclasses:

oracle.ideri.navigator.DefaultNavigatorManager

public abstract class NavigatorManager
extends MultiManager

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

Field Summary

protected static java.lang.String

SOURCE_NAVIGATOR_PROPERTY

Fields inherited from interface oracle.ide.controller.Controller

UPDATE_FROM_ACTION_PERFORMED, UPDATE_FROM_ACTIVE_VIEW_CHANGED, UPDATE_FROM_UNDO, UPDATE_FROM_USER_EXTENSION, UPDATE_FROM_VIEW_SELECTION_CHANGED

Constructor Summary

NavigatorManager()

Method Summary

abstract void	addContextMenuListener(ContextMenuListener l, java.lang.Class cls) Adds a context menu listener to all NavigatorWindows.
protected abstract NavigatorWindow	createNavigatorWindow() Subclasses must override this method to create the NavigatorWindow.
static NavigatorManager	getApplicationNavigatorManager() Returns the NavigatorManager instance that represents the Application Navigator or null if no such navigator exists.
ChildFilterFactory	getChildFilterFactoryForType(java.lang.Class elementClass)
static NavigatorManager	getConnectionNavigatorManager() Deprecated. the Connection Navigator is being removed in 11.0 to be replaced by the Resource Catalog, Database Navigator (from SQL Dev) and Application Server Navigators.
abstract ContextMenu	getContextMenu() Get the ContextMenu to be shared by all Editors.
static Element	getFolderFromContext(Context context) Returns the narrowest Element that represents the specified Context.
HelpInfo	getHelpInfo() Get the help topic id for the navigator managed by me.
java.util.List	getHostedDockables() Deprecated. use getHostedViews() instead.
java.util.List<HostedView>	getHostedViews()
NavigatorWindow	getNavigatorWindow() Returns the NavigatorWindow.
URLFilter	getURLFilter(java.lang.Class elementClass)
static NavigatorManager	getWorkspaceNavigatorManager() Returns the NavigatorManager instance that represents the Workspace Navigator or null if no such navigator exists.
boolean	isSystemNavigator(ViewId viewId) Returns true if the view identified by the give viewId is the system navigator.
protected ViewId	newViewId(Element folder) Returns the ViewId for a NavigatorWindow opened on the specified Element.
NavigatorWindow	openNavigator(Context context) Open a navigator based on the specified context.
abstract void	registerExtension(Extension ext, java.lang.Class cls) Register a navigator extension.
void	registerFilter(java.lang.Class elementClass, ChildFilterFactory childFilterFactory) Associates a ChildFilterFactory with the specified elementClass.
void	registerFilter(java.lang.Class elementClass, java.lang.Class childFilterClass, URLFilter urlFilter) Associates a childFilterClass filter and urlFilter with the specified elementClass.
void	registerHostedDockable(HostedView hostedView)
void	registerHostedDockable(ViewId viewId)
void	registerHostedDockable(ViewId viewId, float weight)
abstract void	removeContextMenuListener(ContextMenuListener l) Remove the specified ContextMenuListener.
static void	setApplicationNavigatorManager(NavigatorManager navMgr) Publishes the specified NavigatorManager as implementing the Application Navigator.
static void	setConnectionNavigatorManager(NavigatorManager navMgr) Deprecated. the Connection Navigator is being removed in 11.0 to be replaced by the Resource Catalog, Database Navigator (from SQL Dev) and Application Server Navigators.
static void	setWorkspaceNavigatorManager(NavigatorManager navMgr) Publishes the specified NavigatorManager as implementing the Workspace Navigator.
NavigatorWindow	showNavigator(Context context) Convenience method programatically identical to casting the result of showView(context) to a NavigatorWindow.

Methods inherited from class oracle.ide.view.MultiManager

createDockableView, createShowAction, createToggleToolbarAction, findOrCreateView, findView, getAcceleratorFile, getDefaultName, getDefaultView, getDefaultViewId, getDockableFactory, getLastView, getNewView, getOrientation, getRelativeView, getShowAction, getToggleToolbarMenuWeight, getViewCategory, getViewId, getViews, handleEvent, initialize, isToolbarVisible, setToolbarVisible, showLastView, showView, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOURCE_NAVIGATOR_PROPERTY

protected static final java.lang.String SOURCE_NAVIGATOR_PROPERTY

See Also:

Constant Field Values

Constructor Detail

NavigatorManager

public NavigatorManager()

Method Detail

getApplicationNavigatorManager

public static NavigatorManager getApplicationNavigatorManager()

Returns the NavigatorManager instance that represents the Application Navigator or null if no such navigator exists.

setApplicationNavigatorManager

public static void setApplicationNavigatorManager(NavigatorManager navMgr)

Publishes the specified NavigatorManager as implementing the Application Navigator.

getWorkspaceNavigatorManager

public static NavigatorManager getWorkspaceNavigatorManager()

Returns the NavigatorManager instance that represents the Workspace Navigator or null if no such navigator exists.

setWorkspaceNavigatorManager

public static void setWorkspaceNavigatorManager(NavigatorManager navMgr)

Publishes the specified NavigatorManager as implementing the Workspace Navigator.

getConnectionNavigatorManager

public static NavigatorManager getConnectionNavigatorManager()

Deprecated. the Connection Navigator is being removed in 11.0 to be replaced by the Resource Catalog, Database Navigator (from SQL Dev) and Application Server Navigators.

Returns the NavigatorManager instance that represents the Connection Navigator or null if no such navigator exists.

setConnectionNavigatorManager

public static void setConnectionNavigatorManager(NavigatorManager navMgr)

Deprecated. the Connection Navigator is being removed in 11.0 to be replaced by the Resource Catalog, Database Navigator (from SQL Dev) and Application Server Navigators.

Publishes the specified NavigatorManager as implementing the Connection Navigator.

getContextMenu

public abstract ContextMenu getContextMenu()

Get the ContextMenu to be shared by all Editors.

isSystemNavigator

public final boolean isSystemNavigator(ViewId viewId)

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

getNavigatorWindow

public final NavigatorWindow getNavigatorWindow()

Returns the NavigatorWindow.

createNavigatorWindow

protected abstract NavigatorWindow createNavigatorWindow()

Subclasses must override this method to create the NavigatorWindow.

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.

Parameters:

context - the context to open the navigato on.

Throws:

java.lang.NullPointerException - if context is null.

showNavigator

public final NavigatorWindow showNavigator(Context context)

Convenience method programatically identical to casting the result of showView(context) to a NavigatorWindow.

addContextMenuListener

public abstract 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 abstract void removeContextMenuListener(ContextMenuListener l)

Remove the specified ContextMenuListener.

registerHostedDockable

public void registerHostedDockable(HostedView hostedView)

registerHostedDockable

public final void registerHostedDockable(ViewId viewId)

registerHostedDockable

public final void registerHostedDockable(ViewId viewId,
                                         float weight)

getHostedDockables

@Deprecated
public final java.util.List getHostedDockables()

Deprecated. use getHostedViews() instead.

getHostedViews

public final java.util.List<HostedView> getHostedViews()

registerFilter

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

Associates a childFilterClass filter and urlFilter with the specified elementClass.

registerFilter

public final void registerFilter(java.lang.Class elementClass,
                                 ChildFilterFactory childFilterFactory)

Associates a ChildFilterFactory with the specified elementClass.

getChildFilterFactoryForType

public final ChildFilterFactory getChildFilterFactoryForType(java.lang.Class elementClass)

getURLFilter

public final URLFilter getURLFilter(java.lang.Class elementClass)

registerExtension

public abstract 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.

getHelpInfo

public HelpInfo getHelpInfo()

Get the help topic id for the navigator managed by me.

getFolderFromContext

public static final Element getFolderFromContext(Context context)

Returns the narrowest Element that represents the specified Context.

newViewId

protected ViewId newViewId(Element folder)

Returns the ViewId for a NavigatorWindow opened on the specified Element.