oracle.ide.navigator

Class NavigatorWindow

java.lang.Object

oracle.ide.view.View

oracle.ide.view.ViewDecorator

oracle.ide.docking.DockableView

oracle.ide.docking.DockableWindow

oracle.ide.navigator.NavigatorWindow

All Implemented Interfaces:

ControllerProvider, Dockable, Helpable

Direct Known Subclasses:

oracle.ideri.navigator.DefaultNavigatorWindow

public abstract class NavigatorWindow
extends DockableWindow

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

See Also:

Observer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAVIGATOR_WINDOW_ID The navigator window view ID.

Fields inherited from class oracle.ide.docking.DockableView

CLOSED, HIDDEN, SHOWN

Fields inherited from class oracle.ide.view.View

EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Fields inherited from interface oracle.ide.docking.Dockable

DEFAULT_VISIBILITY_MINIMIZED, DEFAULT_VISIBILITY_RAISED, DEFAULT_VISIBILITY_VISIBLE, TYPE_DISCARDABLE, TYPE_FORGETTABLE, TYPE_GLOBAL_VISIBLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE

Constructor Summary

Constructors

Constructor and Description
NavigatorWindow()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	collapse(TNode tnode, boolean all) Collapse the specified TNode.
abstract void	expand(TNode tnode, boolean all) Expand the specified TNode.
abstract TNode	findTNode(Element element, TNode root) Find the specified element.
DrawerWindow	getDrawerWindow() Returns instance of the DrawerWindow or null.
java.util.List<DockableWindow>	getHostedDockables()
abstract NavigatorManager	getManager() Returns the NavigatorManager that manages this navigator.
abstract TreeExplorer	getTreeExplorer() Returns the TreeExplorer implementing the tree behavior for this navigator.
boolean	isUsingDrawer() Overridden by subclass to indicate whether the drawer functionality inherited from DrawerDockableWindow should be enabled.
boolean	openContext(Context context) Asks the NavigatorWindow to open the specified Context.
boolean	openContext(Context context, boolean activateDockable) Asks the NavigatorWindow to open the specified Context.
static void	openContextInLastActiveNavigator(Context context) Opens the specified Context in the last active navigator window.
abstract void	refresh(TNode tnode) Closes and re-opens the specified tnode.
abstract void	setRootVisible(boolean visible) Hides the navigator root node if the visible parameter is false.

Methods inherited from class oracle.ide.docking.DockableWindow

addTitleChangeListener, close, dockableHidden, dockableShown, fireTitleChangeListener, getCachedDockable, getDefaultVisibility, getHeaderComponents, getHostedComponent, getMenuTitle, getSite, getTabDropListener, getTabIcon, getType, getUniqueName, isDrawer, isVisible, removeTitleChangeListener, setDockableVisible, setSite, setType, show, stateChange, updateTitle

Methods inherited from class oracle.ide.docking.DockableView

afterAutoExpanding, afterRestoringFromAutoExpansion, beforeAutoExpanding, getAutoExpansionPreferredSize, getAutoExpansionSize, isAutoExpandable, isAutoExpandableEnabled, setAutoExpandable, setAutoExpandableEnabled

Methods inherited from class oracle.ide.view.ViewDecorator

activate, deactivate, getContext, getContextMenu, getController, getDecorated, getGUI, getHelpInfo, getSelectionFromUI, getToolbar, getViewWithoutDecoration, isDecorated, loadLayout, newId, saveLayout, setDecorated, setOwner, setToolbarVisible, updateVisibleActions

Methods inherited from class oracle.ide.view.View

addViewListener, addViewSelectionListener, addViewStateListener, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getId, getSelection, getTabName, loadManifestToolbar, loadManifestToolbar, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, scheduleUpdateSelection, setId, toString, updateSelection, updateSelectionImpl, updateToolbarActions, updateVisibleActions

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.docking.Dockable

getTabName, getTitleName, loadLayout, saveLayout

Field Detail

NAVIGATOR_WINDOW_ID

public static final java.lang.String NAVIGATOR_WINDOW_ID

The navigator window view ID.

See Also:

Constant Field Values

Constructor Detail

NavigatorWindow

public NavigatorWindow()

Method Detail

setRootVisible

public abstract void setRootVisible(boolean visible)

Hides the navigator root node if the visible parameter is false.

collapse

public abstract 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 abstract 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 abstract 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 abstract void refresh(TNode tnode)

Closes and re-opens the specified tnode.

getTreeExplorer

public abstract TreeExplorer getTreeExplorer()

Returns the TreeExplorer implementing the tree behavior for this navigator.

getManager

public abstract NavigatorManager getManager()

Returns the NavigatorManager that manages this navigator.

isUsingDrawer

public boolean isUsingDrawer()

Overridden by subclass to indicate whether the drawer functionality inherited from DrawerDockableWindow should be enabled. If this method returns false, the NavigatorWindow essentially behaves as a regular DockableWindow without the accordion and drawer components.

getHostedDockables

public java.util.List<DockableWindow> getHostedDockables()

openContext

public boolean openContext(Context context)

Asks the NavigatorWindow to open the specified Context. This involves expanding as many levels of UI necessary to reach the specified Context. The base implementation is inefficient. Subclasses are expected to override this method to provide more efficient implementations.

Parameters:

context - the Context to open

Returns:

true if the Context was successfully opened or false otherwise.

openContext

public boolean openContext(Context context,
                  boolean activateDockable)

Asks the NavigatorWindow to open the specified Context. This involves expanding as many levels of UI necessary to reach the specified Context. The base implementation is inefficient. Subclasses are expected to override this method to provide more efficient implementations.

Parameters:

context - the Context to open

whether - the dockable should be activated upon finding

Returns:

true if the Context was successfully opened or false otherwise.

openContextInLastActiveNavigator

public static void openContextInLastActiveNavigator(Context context)

Opens the specified Context in the last active navigator window.

Parameters:

context - the context to open

getDrawerWindow

public DrawerWindow getDrawerWindow()

Returns instance of the DrawerWindow or null. This method returns null on default and it should be overridden in case window requires to share instance of the DrawerWindow to expand, minimize or hide drawers. It also returns null if NavigatorWindow doesn't use drawers.

Returns:

null or DrawerWindow instance