oracle.jdeveloper.rescat2.dockable

Class AbstractBaseTreeDockable

java.lang.Object

oracle.ide.view.View

oracle.ide.view.ViewDecorator

oracle.ide.docking.DockableView

oracle.ide.docking.DockableWindow

oracle.jdeveloper.rescat2.dockable.AbstractBaseTreeDockable

All Implemented Interfaces:

ContextMenuListener, Controller, ControllerProvider, Dockable, Helpable

Direct Known Subclasses:

AbstractConnDockable

public abstract class AbstractBaseTreeDockable
extends DockableWindow
implements Controller, ContextMenuListener

A dockable with a BaseTreeExplorer.

Field Summary

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.controller.Controller

UPDATE_FROM_ACTION_PERFORMED, UPDATE_FROM_ACTIVE_VIEW_CHANGED, UPDATE_FROM_UNDO, UPDATE_FROM_USER_EXTENSION, UPDATE_FROM_VIEW_SELECTION_CHANGED

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
AbstractBaseTreeDockable(java.lang.String viewId)

Method Summary

Modifier and Type	Method and Description
ContextMenu	getContextMenu()
protected abstract int[]	getContextMenuActionIds()
Controller	getController() Get the Controller associated with this view.
int	getDefaultVisibility(Layout layout) The first time a Dockable is exposed to a layout, if the dockable is not of type Dockable.TYPE_GLOBAL_VISIBLE, it will be asked if it wants to be shown in that layout.
protected abstract java.lang.String	getEmptyTipText()
java.awt.Component	getGUI()
protected abstract RescatContext	getRescatContext()
protected abstract Element	getRootNode()
protected Element[]	getSelectionFromUI() This method retrieve's the selection in this View directly from the UI.
protected Element	getSelectionRoot(java.lang.Class<? extends Element> ofInstance)
java.lang.String	getTitleName() Gets title to display in a title bar.
boolean	handleDefaultAction(Context context) Called when the user double clicks on an item that has a context menu.
boolean	handleEvent(IdeAction action, Context context) This method is called when a user interaction with a View triggers the execution of a command.
void	menuWillHide(ContextMenu contextMenu) This method is called just before a showing context menu is dismissed.
void	menuWillShow(ContextMenu contextMenu) Called just before the context menu is shown.
boolean	update(IdeAction action, Context context) This method updates the enabled status of the specified action within the specified context.
void	updateRootNode(Element rootNode)

Methods inherited from class oracle.ide.docking.DockableWindow

addTitleChangeListener, close, dockableHidden, dockableShown, fireTitleChangeListener, getCachedDockable, 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, getDecorated, getHelpInfo, 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, loadLayout, saveLayout

Constructor Detail

AbstractBaseTreeDockable

public AbstractBaseTreeDockable(java.lang.String viewId)

Method Detail

getRootNode

protected abstract Element getRootNode()

getEmptyTipText

protected abstract java.lang.String getEmptyTipText()

getController

public final Controller getController()

Description copied from interface: ControllerProvider

Get the Controller associated with this view.

Specified by:

getController in interface ControllerProvider

Overrides:

getController in class ViewDecorator

Returns:

the Controller associated with this view.

update

public boolean update(IdeAction action,
                      Context context)

Description copied from interface: Controller

This method updates the enabled status of the specified action within the specified context. It should generally be called on the controller associated with the active view to allow that controller to take the first crack at determining its enabled status. If that controller wants to update its enabled status, it does so and returns true to indicate that further controllers do not need to be consulted. If the controller does not deal with setting the enabled status of an action, it delegates the request to its supervising controller, all the way up to the Ide. The Ide has a special implementation of update(xx) that further delegates the request to root controllers, until one of them returns true indicating the request was handled by the controller.

Specified by:

update in interface Controller

Parameters:

action - action whose command is to be executed.

context - the current context

Returns:

true if the controller handles the specified command.

handleEvent

public boolean handleEvent(IdeAction action,
                           Context context)

Description copied from interface: Controller

This method is called when a user interaction with a View triggers the execution of a command.

Specified by:

handleEvent in interface Controller

Parameters:

action - action whose command is to be executed.

Returns:

true if the controller handles the specified command.

getGUI

public java.awt.Component getGUI()

Overrides:

getGUI in class ViewDecorator

Returns:

the root graphical user interface component.

getContextMenu

public ContextMenu getContextMenu()

Overrides:

getContextMenu in class ViewDecorator

Returns:

the ContextMenu, if any.

updateRootNode

public void updateRootNode(Element rootNode)

getTitleName

public final java.lang.String getTitleName()

Description copied from interface: Dockable

Gets title to display in a title bar.

Specified by:

getTitleName in interface Dockable

Returns:

the title to display in a title bar.

See Also:

Dockable.getTabIcon()

menuWillShow

public void menuWillShow(ContextMenu contextMenu)

Description copied from interface: ContextMenuListener

Called just before the context menu is shown. Implementations should add their items to the context menu here.

Specified by:

menuWillShow in interface ContextMenuListener

Parameters:

contextMenu - the context menu being shown

getContextMenuActionIds

protected abstract int[] getContextMenuActionIds()

menuWillHide

public void menuWillHide(ContextMenu contextMenu)

Description copied from interface: ContextMenuListener

This method is called just before a showing context menu is dismissed. Most implementations should not do anything in this method. In particular, it is not necessary to clean out menu items or submenus that were added during ContextMenuListener.menuWillShow(oracle.ide.controller.ContextMenu), since the IDE takes care of that automatically.

Specified by:

menuWillHide in interface ContextMenuListener

Parameters:

contextMenu - the context menu being hidden

handleDefaultAction

public final boolean handleDefaultAction(Context context)

Description copied from interface: ContextMenuListener

Called when the user double clicks on an item that has a context menu. If the listener handles the action, then it must return true; otherwise it must return false. Processing of handleDefaultAction stops on the first return of true.

Specified by:

handleDefaultAction in interface ContextMenuListener

Parameters:

context - the context on which the default action needs to occur.

getDefaultVisibility

public int getDefaultVisibility(Layout layout)

Description copied from interface: Dockable

The first time a Dockable is exposed to a layout, if the dockable is not of type Dockable.TYPE_GLOBAL_VISIBLE, it will be asked if it wants to be shown in that layout.

Specified by:

getDefaultVisibility in interface Dockable

Overrides:

getDefaultVisibility in class DockableWindow

getSelectionFromUI

protected final Element[] getSelectionFromUI()

Description copied from class: View

This method retrieve's the selection in this View directly from the UI. Callers must invoke this method on the Swing/AWT event dispatch thread, and implementations can assume that calls are on the Swing/AWT event dispatch thread.

Overrides:

getSelectionFromUI in class ViewDecorator

Returns:

the selection from the UI.

getSelectionRoot

protected final Element getSelectionRoot(java.lang.Class<? extends Element> ofInstance)

Returns:

the first parent of the selection that implements the ofInstance class.

getRescatContext

protected abstract RescatContext getRescatContext()