public interface IInstructionPointerPresentation extends IDebugModelPresentation
A client has several options when overriding default instruction pointer annotations, and the debug platform uses the following prioritized order when computing an annotation for a stack frame.
null
value from getInstructionPointerAnnotation(..)
.annotationType
extension to use.
This is done by returning a non-null
value from
getInstructionPointerAnnotationType(..)
. When specified, the annotation
type controls the image displayed via its associated
markerAnnotationSpecification
.null
value from getInstructionPointerImage(..)
.null
value from getInstructionPointerText(..)
.
These methods are called when the debugger has opened an editor to display source for the given stack frame. The image will be positioned based on stack frame line number and character ranges.
By default, the debug platform uses different annotations for top stack
frames and non-top stack frames in a thread. The default platform annotations
are contributed as annotationType
extensions with
the identifiers IDebugUIConstants.ANNOTATION_INSTRUCTION_POINTER_CURRENT
and IDebugUIConstants.ANNOTAION_INSTRUCTION_POINTER_SECONDARY
.
Clients implementing a debug model presentation may also implement this interface.
DISPLAY_VARIABLE_TYPE_NAMES
Modifier and Type | Method and Description |
---|---|
Annotation |
getInstructionPointerAnnotation(IEditorPart editorPart,
IStackFrame frame)
Returns an annotation used for the specified stack frame in the specified
editor, or
null if a default annotation should be used. |
String |
getInstructionPointerAnnotationType(IEditorPart editorPart,
IStackFrame frame)
Returns an identifier of a
org.eclipse.ui.editors.annotationTypes extension used for
the specified stack frame in the specified editor, or null if a default annotation
should be used. |
Image |
getInstructionPointerImage(IEditorPart editorPart,
IStackFrame frame)
Returns the instruction pointer image used for the specified stack frame in the specified
editor, or
null if a default image should be used. |
String |
getInstructionPointerText(IEditorPart editorPart,
IStackFrame frame)
Returns the text to associate with the instruction pointer annotation used for the
specified stack frame in the specified editor, or
null if a default
message should be used. |
computeDetail, getImage, getText, setAttribute
addListener, dispose, isLabelProperty, removeListener
getEditorId, getEditorInput
Annotation getInstructionPointerAnnotation(IEditorPart editorPart, IStackFrame frame)
null
if a default annotation should be used.editorPart
- the editor the debugger has openedframe
- the stack frame for which the debugger is displaying
sourcenull
String getInstructionPointerAnnotationType(IEditorPart editorPart, IStackFrame frame)
org.eclipse.ui.editors.annotationTypes
extension used for
the specified stack frame in the specified editor, or null
if a default annotation
should be used.editorPart
- the editor the debugger has openedframe
- the stack frame for which the debugger is displaying
sourcenull
Image getInstructionPointerImage(IEditorPart editorPart, IStackFrame frame)
null
if a default image should be used.
By default, the debug platform uses different images for top stack frames and non-top stack frames in a thread.
editorPart
- the editor the debugger has openedframe
- the stack frame for which the debugger is displaying
sourcenull
String getInstructionPointerText(IEditorPart editorPart, IStackFrame frame)
null
if a default
message should be used.
By default, the debug platform uses different images for top stack frames and non-top stack frames in a thread.
editorPart
- the editor the debugger has openedframe
- the stack frame for which the debugger is displaying
sourcenull
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.