oracle.ide.runner

Interface DebuggerWindowProvider

All Superinterfaces:

DebuggerListener, java.util.EventListener

public interface DebuggerWindowProvider
extends DebuggerListener

Extensions can add their own debugger windows. The debugger supply notification of various events. A debugger window needs to be prepared to work during multiple concurrent debugging processes, and the debugger will call 'setContext' each time the 'active' debugging process changes. Note that the debugger no longer positions windows (as of 11.1.2.0.0), positioning is remembered and restored by Dockables IDE code. The preferred way to register a DebuggerWindowProvider:
In an extension.xml file, add the registration as follows:
Use a fully qualified class name of an implementation of oracle.ide.runner.DebuggerWindowProviderDeclarator for the 'class' attribute
Add a <trigger-hooks> section or use the existing one
Add a <triggers> section or use the existing one
Add a <jdeveloper-hook> section or use the existing one

<trigger-hooks xmlns="http://xmlns.oracle.com/ide/extension"> <triggers trigger-id="Register Ant StarterFactory"> <jdeveloper-hook xmlns="http://xmlns.oracle.com/jdeveloper/1013/extension">
<debugger-hook>
<debugger-window-provider class="my.company.DebuggerWindowProviderDeclarator" />
</debugger-hook>
</jdeveloper-hook>
</triggers>
</trigger-hooks>
A DebuggerWindowProvider is automatically added as a DebuggerListener The DebuggerListener callbacks will post notification of debugger events. Call getSource() on the DebuggerEvent to get a DebuggerEventSource Object, which can be queried for the Context of the process that caused the event.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DebuggerWindowProvider.DebuggerWindowPosition Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Rectangle	getFloatingPosition() Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows
DebuggerWindowProvider.DebuggerWindowPosition	getPosition() Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows
DockableWindow	getWindow() Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows
boolean	installByDefault() Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows
void	refresh() Called by the debugger as a courtesy when debugger windows are refreshed.
void	setContext(Context context) Called by the debugger when the active debugging process changes
void	setDebuggerDockableLayoutPrefix(java.lang.String prefix) Called by the debugger BEFORE any call to getWindow().
void	setEvaluator(DebuggerEvaluator evaluator) Called each time the user changes stackframe or thread, supplying a new evaluator for that thread and stackframe.
void	shutDown() Called by the debugger when the IDE shuts down.

Methods inherited from interface oracle.ide.runner.DebuggerListener

debuggerFinished, debuggerResuming, debuggerStarted, debuggerStopping

Method Detail

installByDefault

@Deprecated
boolean installByDefault()

Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows

Called by the debugger to inquire if the window should be created and installed by default. Windows installed in the structure pane (WEST orientation) and log pane (SOUTH orientation) that have a good chance of being used are usually installed by default and are either shown by default or kept invisible till needed.

Returns:

True if the window should be installed by default

setEvaluator

void setEvaluator(DebuggerEvaluator evaluator)

Called each time the user changes stackframe or thread, supplying a new evaluator for that thread and stackframe. The DebuggerWindowProvider can use any non-expired DebuggerEvaluator for evaluations, while keeping in mind that each DebuggerEvaluator is tied to a stackframe and thread. Don't hold on to expired evaluators. Let them be garbage collected after each 'resume' and 'finish'.

Parameters:

evaluator - An evaluator that can be used while the debuggee is stopped.

setContext

void setContext(Context context)

Called by the debugger when the active debugging process changes

Parameters:

context - The context of the new 'active' debugging process

refresh

void refresh()

Called by the debugger as a courtesy when debugger windows are refreshed. Of course, the DebuggerWindowProvider can decide to refresh the window at any time.

setDebuggerDockableLayoutPrefix

void setDebuggerDockableLayoutPrefix(java.lang.String prefix)

Called by the debugger BEFORE any call to getWindow(). This tells the provider which layout prefix the debugger uses. For instance, if the prefix is 'Debugger', the provider could set the ID of the Dockable to 'Debugger.MyDockable'.

Parameters:

prefix - The prefix the debugger uses for layouts

getWindow

@Deprecated
DockableWindow getWindow()

Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows

Called by the debugger to get the custom debugger window

Returns:

a DockableWindow which should not be null

getPosition

@Deprecated
DebuggerWindowProvider.DebuggerWindowPosition getPosition()

Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows

Called by the debugger to get the position of the provided window

Returns:

the desired position

getFloatingPosition

@Deprecated
java.awt.Rectangle getFloatingPosition()

Deprecated. Debugger Extenders should provide their own DockableFactories and no longer use the core DockableFactory to create and manage their windows

Called by the debugger to get the preferred floating position IFF the window position is FLOATING.

Returns:

The preferred floating position, or null if the debugger should determine the best floating position

shutDown

void shutDown()

Called by the debugger when the IDE shuts down. This is the time to save settings