Class EnvironmentTab
- All Implemented Interfaces:
IPrototypeAttributesLabelProvider
,ILaunchConfigurationTab
,ILaunchConfigurationTab2
Clients may call AbstractLaunchConfigurationTab.setHelpContextId(String)
on this tab prior to
control creation to alter the default context help associated with this tab.
This class may be instantiated.
- Since:
- 3.0
- Restriction:
- This class is not intended to be sub-classed by clients.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
Content provider for the environment tableclass
Label provider for the environment table -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
activated
(ILaunchConfigurationWorkingCopy workingCopy) This method was added to theILaunchConfigurationTab
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.protected boolean
addVariable
(org.eclipse.debug.internal.ui.launchConfigurations.EnvironmentVariable variable) Attempts to add the given variable.protected int
addVariables
(List<org.eclipse.debug.internal.ui.launchConfigurations.EnvironmentVariable> variables) Attempts to add the given variables.protected void
createAppendReplace
(Composite parent) Creates and configures the widgets which allow the user to choose whether the specified environment should be appended to the native environment or if it should completely replace it.void
createControl
(Composite parent) Creates the top level control for this launch configuration tab under the given parent composite.protected void
createEnvironmentTable
(Composite parent) Creates and configures the table that displayed the key/value pairs that comprise the environment.protected void
createTableButtons
(Composite parent) Creates the add/edit/remove buttons for the environment tablevoid
deactivated
(ILaunchConfigurationWorkingCopy workingCopy) This method was added to theILaunchConfigurationTab
interface in the 3.0 release to allow tabs to distinguish between a tab being deactivated and saving its attributes to a launch configuration.getId()
Returns this tab's unique identifier ornull
if none.getImage()
Returns the image for this tab, ornull
if nonegetName()
Returns the name of this tab.protected void
Adds a new environment variable to the table.protected void
Responds to a selection changed event in the environment tableprotected void
Initialize attributes labels.void
initializeFrom
(ILaunchConfiguration configuration) Initializes this tab's controls with values from the given launch configuration.void
performApply
(ILaunchConfigurationWorkingCopy configuration) Stores the environment in the given configurationvoid
setDefaults
(ILaunchConfigurationWorkingCopy configuration) Initializes the given launch configuration with default values for this tab.protected void
Updates the enablement of the append/replace widgets.protected void
updateEnvironment
(ILaunchConfiguration configuration) Updates the environment table for the given launch configurationMethods inherited from class org.eclipse.debug.ui.AbstractLaunchConfigurationTab
canSave, createCheckButton, createPushButton, createRadioButton, createSeparator, createUpdateJob, createVerticalSpacer, dispose, getAttributeLabel, getAttributesLabelsForPrototype, getControl, getErrorMessage, getHelpContextId, getLaunchConfigurationDialog, getLaunchManager, getMessage, getShell, getUpdateJobDelay, getWarningMessage, isDirty, isValid, launched, scheduleUpdateJob, setAttribute, setControl, setDirty, setErrorMessage, setHelpContextId, setLaunchConfigurationDialog, setMessage, setWarningMessage, updateLaunchConfigurationDialog
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.debug.ui.ILaunchConfigurationTab
OkToLeaveTab, postApply
-
Field Details
-
environmentTable
-
envTableColumnHeaders
-
P_VARIABLE
- See Also:
-
P_VALUE
- See Also:
-
envAddButton
-
envEditButton
-
envRemoveButton
-
envCopyButton
- Since:
- 3.14
-
envPasteButton
- Since:
- 3.14
-
appendEnvironment
-
replaceEnvironment
-
envSelectButton
-
-
Constructor Details
-
EnvironmentTab
public EnvironmentTab()Constructs a new tab with default context help.
-
-
Method Details
-
createControl
Description copied from interface:ILaunchConfigurationTab
Creates the top level control for this launch configuration tab under the given parent composite. This method is called once on tab creation, aftersetLaunchConfigurationDialog
is called.Implementors are responsible for ensuring that the created control can be accessed via
getControl
- Parameters:
parent
- the parent composite
-
createAppendReplace
Creates and configures the widgets which allow the user to choose whether the specified environment should be appended to the native environment or if it should completely replace it.- Parameters:
parent
- the composite in which the widgets should be created
-
updateAppendReplace
protected void updateAppendReplace()Updates the enablement of the append/replace widgets. The widgets should disable when there are no environment variables specified. -
createEnvironmentTable
Creates and configures the table that displayed the key/value pairs that comprise the environment.- Parameters:
parent
- the composite in which the table should be created
-
handleTableSelectionChanged
Responds to a selection changed event in the environment table- Parameters:
event
- the selection change event
-
createTableButtons
Creates the add/edit/remove buttons for the environment table- Parameters:
parent
- the composite in which the buttons should be created
-
handleEnvAddButtonSelected
protected void handleEnvAddButtonSelected()Adds a new environment variable to the table. -
addVariable
protected boolean addVariable(org.eclipse.debug.internal.ui.launchConfigurations.EnvironmentVariable variable) Attempts to add the given variable. Returns whether the variable was added or not (as when the user answers not to overwrite an existing variable).- Parameters:
variable
- the variable to add- Returns:
- whether the variable was added
-
addVariables
protected int addVariables(List<org.eclipse.debug.internal.ui.launchConfigurations.EnvironmentVariable> variables) Attempts to add the given variables. Returns the number of variables added (as when the user answers not to overwrite an existing variable).- Parameters:
variables
- the variables to add- Returns:
- the number of variables added
- Since:
- 3.14
-
updateEnvironment
Updates the environment table for the given launch configuration- Parameters:
configuration
- the configuration to use as input for the backing table
-
setDefaults
Description copied from interface:ILaunchConfigurationTab
Initializes the given launch configuration with default values for this tab. 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 this tab's control is created.- Parameters:
configuration
- launch configuration
-
initializeFrom
Description copied from interface:ILaunchConfigurationTab
Initializes this tab's controls with values from the given launch configuration. This method is called when a configuration is selected to view or edit, after this tab's control has been created.- Parameters:
configuration
- launch configuration
-
performApply
Stores the environment in the given configuration- Parameters:
configuration
- launch configuration- See Also:
-
getName
Description copied from interface:ILaunchConfigurationTab
Returns the name of this tab.- Returns:
- the name of this tab
-
getId
Description copied from class:AbstractLaunchConfigurationTab
Returns this tab's unique identifier ornull
if none. By default,null
is returned. Subclasses should override as necessary.Tab identifiers allow contributed tabs to be ordered relative to one another.
- Overrides:
getId
in classAbstractLaunchConfigurationTab
- Returns:
- tab id or
null
- Since:
- 3.3
- See Also:
-
getImage
Description copied from interface:ILaunchConfigurationTab
Returns the image for this tab, ornull
if none- Specified by:
getImage
in interfaceILaunchConfigurationTab
- Overrides:
getImage
in classAbstractLaunchConfigurationTab
- Returns:
- the image for this tab, or
null
if none - See Also:
-
activated
Description copied from class:AbstractLaunchConfigurationTab
This method was added to theILaunchConfigurationTab
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'sinitializeFrom
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
anddeactivated
allow tabs to determine the appropriate course of action.- Specified by:
activated
in interfaceILaunchConfigurationTab
- Overrides:
activated
in classAbstractLaunchConfigurationTab
- Parameters:
workingCopy
- the launch configuration being edited- See Also:
-
deactivated
Description copied from class:AbstractLaunchConfigurationTab
This method was added to theILaunchConfigurationTab
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'sperformApply
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
anddeactivated
allow tabs to determine the appropriate course of action.- Specified by:
deactivated
in interfaceILaunchConfigurationTab
- Overrides:
deactivated
in classAbstractLaunchConfigurationTab
- Parameters:
workingCopy
- the launch configuration being edited- See Also:
-
initializeAttributes
protected void initializeAttributes()Description copied from class:AbstractLaunchConfigurationTab
Initialize attributes labels.- Overrides:
initializeAttributes
in classAbstractLaunchConfigurationTab
- Since:
- 3.13
-