1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.ui.actions;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ui.IWorkbenchPart;
/**
* An adapter to support breakpoint creation/deletion for an active part
* or selection within an active part. The debug platform provides
* retargettable actions for toggling line breakpoints, method breakpoints,
* and watchpoints. A debug implementation can plug into the global actions
* by providing an adapter of this type on relevant parts and objects.
* The debug platform provides one command and key binding for each breakpoint
* operation.
* <p>
* When a part is activated, a retargettable action asks the part
* for its <code>IToggleBreakpointTarget</code> adapter. If one exists,
* that adapter is delegated to to perform breakpoint operations when
* the user invokes an associated action. If an adapter does not exist
* for the part, the retargettable actions asks selected objects in the
* active part for an adapter. Generally, a debug implementation will
* provide breakpoint adapters for relevant editors and model objects.
* </p>
* <p>
* Clients are intended to implement this interface and provide instances as
* an adapter on applicable parts (for example, editors) and objects (for
* example, methods and fields) that support breakpoint toggling.
* </p>
* @since 3.0
*/
public interface IToggleBreakpointsTarget {
/**
* Creates new line breakpoints or removes existing breakpoints.
* The selection varies depending on the given part. For example,
* a text selection is provided for text editors, and a structured
* selection is provided for tree views, and may be a multi-selection.
*
* @param part the part on which the action has been invoked
* @param selection selection on which line breakpoints should be toggled
* @throws CoreException if unable to perform the action
*/
void toggleLineBreakpoints(IWorkbenchPart part, ISelection selection) throws CoreException;
/**
* Returns whether line breakpoints can be toggled on the given selection.
* The selection varies depending on the given part. For example,
* a text selection is provided for text editors, and a structured
* selection is provided for tree views, and may be a multi-selection.
*
* @param part the part on which the action has been invoked
* @param selection selection on which line breakpoints may be toggled
* @return whether line breakpoints can be toggled on the given selection
*/
boolean canToggleLineBreakpoints(IWorkbenchPart part, ISelection selection);
/**
* Creates new method breakpoints or removes existing breakpoints.
* The selection varies depending on the given part. For example,
* a text selection is provided for text editors, and a structured
* selection is provided for tree views, and may be a multi-selection.
*
* @param part the part on which the action has been invoked
* @param selection selection on which method breakpoints should be toggled
* @throws CoreException if unable to perform the action
*/
void toggleMethodBreakpoints(IWorkbenchPart part, ISelection selection) throws CoreException;
/**
* Returns whether method breakpoints can be toggled on the given selection.
* The selection varies depending on the given part. For example,
* a text selection is provided for text editors, and a structured
* selection is provided for tree views, and may be a multi-selection.
*
* @param part the part on which the action has been invoked
* @param selection selection on which method breakpoints may be toggled
* @return whether method breakpoints can be toggled on the given selection
*/
boolean canToggleMethodBreakpoints(IWorkbenchPart part, ISelection selection);
/**
* Creates new watchpoints or removes existing breakpoints.
* The selection varies depending on the given part. For example,
* a text selection is provided for text editors, and a structured
* selection is provided for tree views, and may be a multi-selection.
*
* @param part the part on which the action has been invoked
* @param selection selection on which watchpoints should be toggled
* @throws CoreException if unable to perform the action
*/
void toggleWatchpoints(IWorkbenchPart part, ISelection selection) throws CoreException;
/**
* Returns whether watchpoints can be toggled on the given selection.
* The selection varies depending on the given part. For example,
* a text selection is provided for text editors, and a structured
* selection is provided for tree views, and may be a multi-selection.
*
* @param part the part on which the action has been invoked
* @param selection selection on which watchpoints may be toggled
* @return whether watchpoints can be toggled on the given selection
*/
boolean canToggleWatchpoints(IWorkbenchPart part, ISelection selection);
}
|
