public class CommonTab extends AbstractLaunchConfigurationTab
Clients may call AbstractLaunchConfigurationTab.setHelpContextId(String)
on this tab prior to control
creation to alter the default context help associated with this tab.
Clients may instantiate this class.
Constructor and Description |
---|
CommonTab()
Constructs a new tab with default context help.
|
Modifier and Type | Method and Description |
---|---|
void |
activated(ILaunchConfigurationWorkingCopy workingCopy)
This method was added to the
ILaunchConfigurationTab interface
in the 3.0 release to allow tabs to distinguish between a tab being activated
and a tab group be initialized for the first time, from a selected launch
configuration. |
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.
|
protected void |
createLaunchInBackgroundComponent(Composite parent)
Creates the controls needed to edit the launch in background
attribute of an external tool
|
void |
deactivated(ILaunchConfigurationWorkingCopy workingCopy)
This method was added to the
ILaunchConfigurationTab interface
in the 3.0 release to allow tabs to distinguish between a tab being deactivated
and saving its attributes to a launch configuration. |
String |
getId()
Returns this tab's unique identifier or
null if none. |
Image |
getImage()
Returns the image for this tab, or
null if none |
protected org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationManager |
getLaunchConfigurationManager()
Convenience accessor
|
String |
getName()
Returns the name of this tab.
|
void |
initializeFrom(ILaunchConfiguration configuration)
Initializes this tab's controls with values from the given
launch configuration.
|
static boolean |
isLaunchInBackground(ILaunchConfiguration configuration)
Returns whether the given configuration should be launched in the background.
|
boolean |
isValid(ILaunchConfiguration config)
Returns whether this tab is in a valid state in the context of the specified launch configuration.
|
void |
performApply(ILaunchConfigurationWorkingCopy configuration)
Copies values from this tab into the given
launch configuration.
|
void |
setDefaults(ILaunchConfigurationWorkingCopy config)
Initializes the given launch configuration with
default values for this tab.
|
protected void |
updateLaunchInBackground(ILaunchConfiguration configuration)
Updates the launch on background check button
|
createCheckButton, createPushButton, createRadioButton, createSeparator, createUpdateJob, createVerticalSpacer, dispose, getControl, getErrorMessage, getHelpContextId, getLaunchConfigurationDialog, getLaunchManager, getMessage, getShell, getUpdateJobDelay, getWarningMessage, isDirty, launched, scheduleUpdateJob, setAttribute, setControl, setDirty, setErrorMessage, setHelpContextId, setLaunchConfigurationDialog, setMessage, setWarningMessage, updateLaunchConfigurationDialog
public void createControl(Composite parent)
ILaunchConfigurationTab
setLaunchConfigurationDialog
is called.
Implementors are responsible for ensuring that
the created control can be accessed via getControl
parent
- the parent compositeprotected void createLaunchInBackgroundComponent(Composite parent)
parent
- the composite to create the controls inpublic void initializeFrom(ILaunchConfiguration configuration)
ILaunchConfigurationTab
configuration
- launch configurationprotected void updateLaunchInBackground(ILaunchConfiguration configuration)
configuration
- the local launch configurationpublic static boolean isLaunchInBackground(ILaunchConfiguration configuration)
configuration
- the configurationprotected org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationManager getLaunchConfigurationManager()
LaunchConfigurationManager
public boolean isValid(ILaunchConfiguration config)
ILaunchConfigurationTab
This information is typically used by the launch configuration dialog to decide when it is okay to launch.
isValid
in interface ILaunchConfigurationTab
isValid
in class AbstractLaunchConfigurationTab
config
- launch configuration which provides context for validating this tab.
This value must not be null
.ILaunchConfigurationTab.isValid(ILaunchConfiguration)
public void setDefaults(ILaunchConfigurationWorkingCopy config)
ILaunchConfigurationTab
config
- launch configurationpublic void performApply(ILaunchConfigurationWorkingCopy configuration)
ILaunchConfigurationTab
configuration
- launch configurationpublic String getName()
ILaunchConfigurationTab
public String getId()
AbstractLaunchConfigurationTab
null
if none.
By default, null
is returned. Subclasses should override
as necessary.
Tab identifiers allow contributed tabs to be ordered relative to one another.
getId
in class AbstractLaunchConfigurationTab
null
AbstractLaunchConfigurationTab.getId()
public boolean canSave()
ILaunchConfigurationTab
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.
canSave
in interface ILaunchConfigurationTab
canSave
in class AbstractLaunchConfigurationTab
ILaunchConfigurationTab.canSave()
public Image getImage()
ILaunchConfigurationTab
null
if nonegetImage
in interface ILaunchConfigurationTab
getImage
in class AbstractLaunchConfigurationTab
null
if noneILaunchConfigurationTab.getImage()
public void activated(ILaunchConfigurationWorkingCopy workingCopy)
AbstractLaunchConfigurationTab
ILaunchConfigurationTab
interface
in the 3.0 release to allow tabs to distinguish between a tab being activated
and a tab group be initialized for the first time, from a selected launch
configuration. To maintain backwards compatible behavior, the default
implementation provided, calls this tab's initializeFrom
method.
Tabs should override this method as required.
The launch tab framework was originally designed to take care of inter tab
communication by applying attributes from the active tab to the launch configuration
being edited, when a tab is exited, and by initializing a tab when activated.
The addition of the methods activated
and deactivated
allow tabs to determine the appropriate course of action.
activated
in interface ILaunchConfigurationTab
activated
in class AbstractLaunchConfigurationTab
workingCopy
- the launch configuration being editedILaunchConfigurationTab.activated(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy)
public void deactivated(ILaunchConfigurationWorkingCopy workingCopy)
AbstractLaunchConfigurationTab
ILaunchConfigurationTab
interface
in the 3.0 release to allow tabs to distinguish between a tab being deactivated
and saving its attributes to a launch configuration. To maintain backwards
compatible behavior, the default implementation provided, calls this tab's
performApply
method. Tabs should override this method as required.
The launch tab framework was originally designed to take care of inter tab
communication by applying attributes from the active tab to the launch configuration
being edited, when a tab is exited, and by initializing a tab when activated.
The addition of the methods activated
and deactivated
allow tabs to determine the appropriate course of action.
deactivated
in interface ILaunchConfigurationTab
deactivated
in class AbstractLaunchConfigurationTab
workingCopy
- the launch configuration being editedILaunchConfigurationTab.deactivated(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy)
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.