org.eclipse.debug.ui
Interface IDebugEditorPresentation

public interface IDebugEditorPresentation

A debug model presentation may implement this interface to provide editor related decorations for editors opened by the debugger.

Since:

3.0

Method Summary

void	decorateEditor(IEditorPart editorPart, IStackFrame frame) Provides this editor presentation with an opportunity to decorate the given editor in the context of the given stack frame.
Image	getInstructionPointerImage(IStackFrame frame) Returns the image used to annotate a line of source code in an editor's ruler corresponding to the given stack frame, or null if the default image should be used.
void	removeDecorations(IEditorPart editorPart, IThread thread) Removes any debug related decorations in the given editor.
boolean	selectAndReveal(IEditorPart editorPart, IStackFrame frame) Provides this editor presentation with a chance to position the given editor to the appropriate location for the given stack frame.

Method Detail

getInstructionPointerImage

public Image getInstructionPointerImage(IStackFrame frame)

Returns the image used to annotate a line of source code in an editor's ruler corresponding to the given stack frame, or null if the default image should be used.

Parameters:

frame - stack frame

Returns:

image used to annotate a line of source code in an editor's ruler corresponding to the given stack frame, or null if the default image should be used

selectAndReveal

public boolean selectAndReveal(IEditorPart editorPart,
                               IStackFrame frame)

Provides this editor presentation with a chance to position the given editor to the appropriate location for the given stack frame. Returns whether this editor presentation has performed the select and reveal. When false is returned, the debugger will perform the select and reveal.

Parameters:

editorPart - the editor the debugger has opened

frame - the stack frame that corresponds to the editor

Returns:

whether this presentation has performed the select and reveal

removeDecorations

public void removeDecorations(IEditorPart editorPart,
                              IThread thread)

Removes any debug related decorations in the given editor. This method is called when the debugger clears the source selection in an editor opened by the debugger when a debug session is resumed or terminated.

Parameters:

editorPart - an editor that was decorated

thread - the thread the editor was decorated for

decorateEditor

public void decorateEditor(IEditorPart editorPart,
                           IStackFrame frame)

Provides this editor presentation with an opportunity to decorate the given editor in the context of the given stack frame. This method is called after selectAndReveal.

Parameters:

editorPart - the editor the debugger has opened

frame - the stack frame that corresponds to the editor