oracle.jdeveloper.deploy.dt
Class DeployDesignTime

java.lang.Object
  oracle.jdeveloper.deploy.dt.DeployDesignTime

All Implemented Interfaces:

ContextMenuListener, Controller, DeployAddin

Direct Known Subclasses:

DeployProfileDt

public abstract class DeployDesignTime
extends java.lang.Object
implements DeployAddin, Controller, ContextMenuListener

This class defines the protocol between the Deployment class and any classes that provide deploy-addin-specific design-time functionality.

Field Summary

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

DeployDesignTime()

Method Summary

protected DeployMenuItem	createDeployMenuItem(java.lang.String commandName)
protected DeployMenuItem	createDeployMenuItem(java.lang.String commandName, Profile profile)
protected DeployMenuItem	createDeployMenuItem(java.lang.String commandName, Profile profile, java.lang.String label)
protected IdeAction	createIdeAction(java.lang.String commandName, java.lang.String label)
protected java.lang.String	getDefaultCommand() Should be overridden by subclass to support the Deployment.deploy(String) method.
protected java.lang.String	getLabelForCommand(java.lang.String commandName) Should be overridden by subclass if findOrCreateIdeAction(..) or createDeployMenuItem(..) are used.
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.
protected static boolean	isInSupportedNavigator(Context context)
protected static boolean	isInSupportedNavigator(ContextMenu popup)
void	menuWillHide(ContextMenu popup) This method is called just before a showing context menu is dismissed.
void	menuWillShow(ContextMenu popup) The default implementation removes all menu items from the context menu.
void	startup() Called when the addin is loaded.
static java.lang.Object	unwrapData(Context context)
static java.lang.Object	unwrapData(ContextMenu popup)
boolean	update(IdeAction action, Context context) This method updates the enabled status of the specified action within the specified context.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployDesignTime

public DeployDesignTime()

Method Detail

createIdeAction

protected IdeAction createIdeAction(java.lang.String commandName,
                                    java.lang.String label)

createDeployMenuItem

protected final DeployMenuItem createDeployMenuItem(java.lang.String commandName)

createDeployMenuItem

protected final DeployMenuItem createDeployMenuItem(java.lang.String commandName,
                                                    Profile profile)

createDeployMenuItem

protected final DeployMenuItem createDeployMenuItem(java.lang.String commandName,
                                                    Profile profile,
                                                    java.lang.String label)

getDefaultCommand

protected java.lang.String getDefaultCommand()

Should be overridden by subclass to support the Deployment.deploy(String) method. If there is no default command, this method must return null.

getLabelForCommand

protected java.lang.String getLabelForCommand(java.lang.String commandName)

Should be overridden by subclass if findOrCreateIdeAction(..) or createDeployMenuItem(..) are used. The return value should be a label that can be shown to the user corresponding to the command name. If the command name is not recognized, this method must return null. If the command name is recognized, this method must return non-null, even if the label is never displayed to the user. Return values do not need to be unique.

startup

public void startup()

Description copied from interface: DeployAddin

Called when the addin is loaded. The addin should perform all initialization.

Specified by:

startup in interface DeployAddin

menuWillShow

public void menuWillShow(ContextMenu popup)

The default implementation removes all menu items from the context menu.

Specified by:

menuWillShow in interface ContextMenuListener

Parameters:

popup - the context menu being shown

menuWillHide

public void menuWillHide(ContextMenu popup)

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:

popup - the context menu being hidden

handleDefaultAction

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

isInSupportedNavigator

protected static boolean isInSupportedNavigator(ContextMenu popup)

isInSupportedNavigator

protected static boolean isInSupportedNavigator(Context context)

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.

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.

unwrapData

public static java.lang.Object unwrapData(ContextMenu popup)

unwrapData

public static java.lang.Object unwrapData(Context context)