|
Eclipse Platform Release 3.1 |
|||||||||||
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.
A tab group has the following lifecycle methods:
createTabs(ILaunchConfigurationDialog, String)
-
this is the first method called on a tab group after it is instantiated.initializeFrom(ILaunchConfiguration)
- called when a
launch configuration is selected to be displayed.performApply(ILaunchConfigurationWorkingCopy)
- called when
a tab group's values are to be written to a launch configuration.dispose()
- 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.setDefaults(ILaunchConfigurationWorkingCopy)
can be called before a tab's controls are created.
The launch tab framework was originially 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 activated
and deactivated
allow tabs to determine the appropriate course of action. The default implementation
in AbstractLaunchConfigurationTab
is to call the old methods
(initializeFrom
and performApply
). Tabs should overeride
the new methods as required.
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)
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. |
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 Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.