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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*******************************************************************************
* Copyright (c) 2000, 2013 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;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
/**
* A launch configuration tab group is used to edit/view attributes
* of a specific type of launch configuration. Launch
* configurations are presented in a dialog, with a tab folder.
* Each tab manipulates one or more attributes of a launch
* configuration. The tab group controls which tabs are
* displayed for a specific type of launch configuration,
* and provides a mechanism for overriding configuration
* initialization performed by tabs.
* <p>
* A tab group has the following lifecycle methods:
* <ul>
* <li><code>createTabs(ILaunchConfigurationDialog, String)</code> -
* this is the first method called on a tab group after it is instantiated.</li>
* <li><code>initializeFrom(ILaunchConfiguration)</code> - called when a
* launch configuration is selected to be displayed.</li>
* <li><code>performApply(ILaunchConfigurationWorkingCopy)</code> - called when
* a tab group's values are to be written to a launch configuration.</li>
* <li><code>dispose()</code> - the last method called on a tab group, when it is
* to perform any required cleanup. Note that a tab can be disposed before its control
* has been created.</li>
* </ul>
* The method <code>setDefaults(ILaunchConfigurationWorkingCopy)</code>
* can be called before a tab's controls are created.
* </p>
* <p>
* The launch tab framework was originally designed to handle inter tab
* communication by applying attributes from the active tab to a launch configuration
* being edited, when a tab is exited, and by initializing a tab when activated.
* In 3.0, the addition of the methods <code>activated</code> and <code>deactivated</code>
* allow tabs to determine the appropriate course of action. The default implementation
* in <code>AbstractLaunchConfigurationTab</code> is to call the old methods
* (<code>initializeFrom</code> and <code>performApply</code>). Tabs should override
* the new methods as required.
* </p>
* <p>
* A launch configuration group extension is defined in <code>plugin.xml</code>.
* Following is an example definition of a launch configuration
* group extension.
* <pre>
* <extension point="org.eclipse.debug.ui.launchConfigurationTabGroups">
* <launchConfigurationTabGroup
* id="com.example.ExampleTabGroup"
* type="com.example.ExampleLaunchConfigurationTypeIdentifier"
* class="com.example.ExampleLaunchConfigurationTabGroupClass">
* </launchConfigurationTabGroup>
* </extension>
* </pre>
* The attributes are specified as follows:
* <ul>
* <li><code>id</code> specifies a unique identifier for this launch configuration
* tab group.</li>
* <li><code>type</code> specifies launch configuration type that this tab
* group is applicable to (corresponds to the id of a launch configuration type
* extension).</li>
* <li><code>class</code> specifies a fully qualified name of a Java class
* that implements <code>ILaunchConfigurationTabGroup</code>.</li>
* </ul>
* </p>
* <p>
* This interface is intended to be implemented by clients.
* </p>
* @see org.eclipse.debug.core.ILaunchConfigurationType
* @see org.eclipse.debug.core.ILaunchConfiguration
* @see org.eclipse.debug.ui.ILaunchConfigurationTab
* @since 2.0
*/
public interface ILaunchConfigurationTabGroup {
/**
* Creates the tabs contained in this tab group for the specified
* launch mode. The tabs control's are not created. This is the
* fist method called in the lifecycle of a tab group.
*
* @param dialog the launch configuration dialog this tab group
* is contained in
* @param mode the mode the launch configuration dialog was
* opened in
*/
void createTabs(ILaunchConfigurationDialog dialog, String mode);
/**
* Returns the tabs contained in this tab group.
*
* @return the tabs contained in this tab group
*/
ILaunchConfigurationTab[] getTabs();
/**
* Notifies this launch configuration tab group that it has
* been disposed, and disposes this group's tabs. Marks the end
* of this tab group's lifecycle, allowing this tab group to
* perform any cleanup required.
*/
void dispose();
/**
* Initializes the given launch configuration with
* default values for this tab group. This method
* is called when a new launch configuration is created
* such that the configuration can be initialized with
* meaningful values. This method may be called before
* tab controls are created.
*
* @param configuration launch configuration
*/
void setDefaults(ILaunchConfigurationWorkingCopy configuration);
/**
* Initializes this group's tab controls with values from the given
* launch configuration. This method is called when
* a configuration is selected to view or edit.
*
* @param configuration launch configuration
*/
void initializeFrom(ILaunchConfiguration configuration);
/**
* Copies values from this group's tabs into the given
* launch configuration.
*
* @param configuration launch configuration
*/
void performApply(ILaunchConfigurationWorkingCopy configuration);
/**
* Notifies this tab that a configuration has been
* launched, resulting in the given launch. This method can be
* called when a tab's control does not exist, to support single-click
* launching.
*
* @param launch the result of launching the current
* launch configuration
* @deprecated As of R3.0, this method is no longer called by the launch
* framework. Since tabs do not exist when launching is performed elsewhere
* than the launch dialog, this method cannot be relied upon for launching
* functionality.
*/
@Deprecated void launched(ILaunch launch);
}
|
