|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A launch configuration tab 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 ore more attributes of a launch configuration.
A tab has the following lifecycle methods:
setLaunchConfigurationDialog(ILaunchConfigurationDialog)
-
this is the first method called on a tab after it is instantiated.initializeFrom(ILaunchConfiguration)
- called when a
launch configuration is selected to be displayed.activated(ILaunchConfigurationWorkingCopy)
- called when
a tab is entered.deactivated(ILaunchConfigurationWorkingCopy)
- called when
a tab is exited.performApply(ILaunchConfigurationWorkingCopy)
- called when
a tab is to write its values to a launch configuration.dispose()
- the last method called on a tab, 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.
This interface is intended to be implemented by clients.
ILaunchConfigurationType
,
ILaunchConfiguration
Method Summary | |
void |
activated(ILaunchConfigurationWorkingCopy workingCopy)
Notification that this tab has become the active tab in the launch configuration dialog. |
boolean |
canSave()
Returns whether this tab is in a state that allows the launch configuration whose values this tab is showing to be saved. |
void |
createControl(Composite parent)
Creates the top level control for this launch configuration tab under the given parent composite. |
void |
deactivated(ILaunchConfigurationWorkingCopy workingCopy)
Notification that this tab is no longer the active tab in the launch configuration dialog. |
void |
dispose()
Notifies this launch configuration tab that it has been disposed. |
Control |
getControl()
Returns the top level control for this tab. |
String |
getErrorMessage()
Returns the current error message for this tab. |
Image |
getImage()
Returns the image for this tab, or null if none |
String |
getMessage()
Returns the current message for this tab. |
String |
getName()
Returns the name of this tab. |
void |
initializeFrom(ILaunchConfiguration configuration)
Initializes this tab's controls with values from the given launch configuration. |
boolean |
isValid(ILaunchConfiguration launchConfig)
Returns whether this tab is in a valid state in the context of the specified 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 tab into the given launch configuration. |
void |
setDefaults(ILaunchConfigurationWorkingCopy configuration)
Initializes the given launch configuration with default values for this tab. |
void |
setLaunchConfigurationDialog(ILaunchConfigurationDialog dialog)
Sets the launch configuration dialog that hosts this tab. |
Method Detail |
public void createControl(Composite parent)
setLaunchConfigurationDialog
is called.
Implementors are responsible for ensuring that
the created control can be accessed via getControl
parent
- the parent compositepublic Control getControl()
May return null
if the control
has not been created yet.
null
public void setDefaults(ILaunchConfigurationWorkingCopy configuration)
configuration
- launch configurationpublic void initializeFrom(ILaunchConfiguration configuration)
configuration
- launch configurationpublic void dispose()
public void performApply(ILaunchConfigurationWorkingCopy configuration)
configuration
- launch configurationpublic String getErrorMessage()
null
to indicate no error message.
An error message should describe some error state, as opposed to a message which may simply provide instruction or information to the user.
null
if nonepublic String getMessage()
A message provides instruction or information to the user, as opposed to an error message which should describe some error state.
null
if nonepublic boolean isValid(ILaunchConfiguration launchConfig)
This information is typically used by the launch configuration dialog to decide when it is okay to launch.
launchConfig
- launch configuration which provides context for validating this tab.
This value must not be null
.
public boolean canSave()
isValid()
in that canSave()
determines if this tab prevents the current launch configuration from being saved, whereas
isValid()
determines if this tab prevents the current launch configuration from
being launched.
This information is typically used by the launch configuration dialog to decide when it is okay to save a launch configuration.
public void setLaunchConfigurationDialog(ILaunchConfigurationDialog dialog)
dialog
- launch configuration dialogpublic void launched(ILaunch launch)
launch
- the result of launching the current
launch configurationpublic String getName()
public Image getImage()
null
if none
null
if nonepublic void activated(ILaunchConfigurationWorkingCopy workingCopy)
workingCopy
- the launch configuration being editedpublic void deactivated(ILaunchConfigurationWorkingCopy workingCopy)
workingCopy
- the launch configuration being edited
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.