|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
The tab group's lifecycle begins when createTabs(ILaunchConfigurationDialog, String)
is called. A tab group may then be asked repeatedly to initialize its
tabs to display values for a launch configuration (see
initializeFrom(ILaunchConfiguration)
), and to
apply its current settings to a launch configuration (see
performApply(ILaunchConfigurationWorkingCopy)
).
While a user manipulates a tab's controls, the tab is not
intended to update a launch configuration. Updating a launch
configuration should only be performed when performApply
is called. To end a tab group's lifecyle, dispose()
will
be called. Note that a tab group can be disposed before its controls
have been created.
To support single-click launching, a tab group is required to initialize
default values into launch configurations (possibly when controls
have not been created). See setDefaults(ILaunchConfigurationWorkingCopy)
.
As well, the method launched
can be called when the tab's
control does not exist.
A launch configuration group extension is defined in plugin.xml
.
Following is an example definition of a launch configuration
group extension.
<extension point="org.eclipse.debug.ui.launchConfigurationTabGroups"> <launchConfigurationTabGroup id="com.example.ExampleTabGroup" type="com.example.ExampleLaunchConfigurationTypeIdentifier" class="com.example.ExampleLaunchConfigurationTabGroupClass"> </launchConfigurationTabGroup> </extension>The attributes are specified as follows:
id
specifies a unique identifier for this launch configuration
tab group.type
specifies launch configuration type that this tab
group is applicable to (corresponds to the id of a launch configuration type
extension).class
specifies a fully qualified name of a Java class
that implements ILaunchConfigurationTabGroup
.This interface is intended to be implemented by clients.
ILaunchConfigurationType
,
ILaunchConfiguration
,
ILaunchConfigurationTab
Method Summary | |
void |
createTabs(ILaunchConfigurationDialog dialog,
String mode)
Creates the tabs contained in this tab group for the specified launch mode. |
void |
dispose()
Notifies this launch configuration tab group that it has been disposed, and disposes this group's tabs. |
ILaunchConfigurationTab[] |
getTabs()
Returns the tabs contained in this tab group. |
void |
initializeFrom(ILaunchConfiguration configuration)
Initializes this group's tab controls with values from the given launch configuration. |
void |
launched(ILaunch launch)
Notifies this tab that a configuration has been launched, resulting in the given launch. |
void |
performApply(ILaunchConfigurationWorkingCopy configuration)
Copies values from this group's tabs into the given launch configuration. |
void |
setDefaults(ILaunchConfigurationWorkingCopy configuration)
Initializes the given launch configuration with default values for this tab group. |
Method Detail |
public void createTabs(ILaunchConfigurationDialog dialog, String mode)
dialog
- the launch configuration dialog this tab group
is contained inmode
- the mode the launch configuration dialog was
opened inpublic ILaunchConfigurationTab[] getTabs()
public void dispose()
public void setDefaults(ILaunchConfigurationWorkingCopy configuration)
configuration
- launch configurationpublic void initializeFrom(ILaunchConfiguration configuration)
configuration
- launch configurationpublic void performApply(ILaunchConfigurationWorkingCopy configuration)
configuration
- launch configurationpublic void launched(ILaunch launch)
launch
- the result of launching the current
launch configuration
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |