org.eclipse.debug.ui
Class AbstractLaunchConfigurationTab
java.lang.Object
org.eclipse.debug.ui.AbstractLaunchConfigurationTab
-
All Implemented Interfaces:
-
ILaunchConfigurationTab
-
Direct Known Subclasses:
-
CommonTab,
EnvironmentTab,
RefreshTab,
SourceLookupTab,
WorkingDirectoryBlock
-
public abstract class AbstractLaunchConfigurationTab
- extends
Object
- implements
ILaunchConfigurationTab
Common function for launch configuration tabs.
Clients may subclass this class.
-
Since:
- 2.0
-
See Also:
-
ILaunchConfigurationTab
Method Summary
|
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. |
protected
Button
|
createCheckButton
(
Composite parent,
String label)
Creates and returns a new check button with the given
label. |
protected
Button
|
createPushButton
(
Composite parent,
String label,
Image image)
Creates and returns a new push button with the given
label and/or image. |
protected
Button
|
createRadioButton
(
Composite parent,
String label)
Creates and returns a new radio button with the given
label and/or image. |
protected void
|
createSeparator
(
Composite comp,
int colSpan)
Create a horizontal separator. |
protected void
|
createVerticalSpacer
(
Composite comp,
int colSpan)
Creates vertical space in the parent Composite
|
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. |
void
|
dispose
()
By default, do nothing. |
Control
|
getControl
()
Returns the top level control for this tab. |
String
|
getErrorMessage
()
Returns the current error message for this tab. |
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
ILaunchConfigurationDialog
|
getLaunchConfigurationDialog
()
Returns the dialog this tab is contained in, or
null if not yet set. |
protected
ILaunchManager
|
getLaunchManager
()
Convenience method to return the launch manager. |
String
|
getMessage
()
Returns the current message for this tab. |
protected
Shell
|
getShell
()
Returns the shell this tab is contained in, or null . |
protected boolean
|
isDirty
()
Returns if this tab has pending changes that need to be saved. |
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.
|
protected void
|
setAttribute
(
String attribute,
ILaunchConfigurationWorkingCopy configuration,
boolean value,
boolean defaultValue)
Convenience method to set a boolean attribute of on a launch
configuration. |
protected void
|
setControl
(
Control control)
Sets the control to be displayed in this tab. |
protected void
|
setDirty
(boolean dirty)
Sets the dirty state of the tab. |
protected void
|
setErrorMessage
(
String errorMessage)
Sets this page's error message, possibly null . |
void
|
setLaunchConfigurationDialog
(
ILaunchConfigurationDialog dialog)
Sets the launch configuration dialog that hosts this tab. |
protected void
|
setMessage
(
String message)
Sets this page's message, possibly null . |
protected void
|
updateLaunchConfigurationDialog
()
Updates the buttons and message in this page's launch
configuration dialog. |
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
AbstractLaunchConfigurationTab
public AbstractLaunchConfigurationTab()
getLaunchConfigurationDialog
protected
ILaunchConfigurationDialog getLaunchConfigurationDialog()
- Returns the dialog this tab is contained in, or
null
if not yet set.
-
-
-
Returns:
- launch configuration dialog, or
null
updateLaunchConfigurationDialog
protected void updateLaunchConfigurationDialog()
- Updates the buttons and message in this page's launch
configuration dialog.
-
-
getControl
public
Control getControl()
-
Description copied from interface:
ILaunchConfigurationTab
- Returns the top level control for this tab.
May return null
if the control
has not been created yet.
-
-
Specified by:
-
getControl
in interface
ILaunchConfigurationTab
-
-
Returns:
- the top level control or
null
-
See Also:
-
ILaunchConfigurationTab.getControl()
setControl
protected void setControl(
Control control)
- Sets the control to be displayed in this tab.
-
-
-
Parameters:
-
control
- the control for this tab
getErrorMessage
public
String getErrorMessage()
-
Description copied from interface:
ILaunchConfigurationTab
- Returns the current error message for this tab.
May be
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.
-
-
Specified by:
-
getErrorMessage
in interface
ILaunchConfigurationTab
-
-
Returns:
- the error message, or
null
if none -
See Also:
-
ILaunchConfigurationTab.getErrorMessage()
getMessage
public
String getMessage()
-
Description copied from interface:
ILaunchConfigurationTab
- Returns the current message for this tab.
A message provides instruction or information to the
user, as opposed to an error message which should
describe some error state.
-
-
Specified by:
-
getMessage
in interface
ILaunchConfigurationTab
-
-
Returns:
- the message, or
null
if none -
See Also:
-
ILaunchConfigurationTab.getMessage()
launched
public void launched(
ILaunch launch)
-
Deprecated.
- By default, do nothing.
-
-
Specified by:
-
launched
in interface
ILaunchConfigurationTab
-
-
Parameters:
-
launch
- the result of launching the current
launch configuration -
See Also:
-
ILaunchConfigurationTab.launched(ILaunch)
setLaunchConfigurationDialog
public void setLaunchConfigurationDialog(
ILaunchConfigurationDialog dialog)
-
Description copied from interface:
ILaunchConfigurationTab
- Sets the launch configuration dialog that hosts this tab.
This is the first method called on a launch configuration
tab, and marks the beginning of this tab's lifecycle.
-
-
Specified by:
-
setLaunchConfigurationDialog
in interface
ILaunchConfigurationTab
-
-
Parameters:
-
dialog
- launch configuration dialog -
See Also:
-
ILaunchConfigurationTab.setLaunchConfigurationDialog(ILaunchConfigurationDialog)
setErrorMessage
protected void setErrorMessage(
String errorMessage)
- Sets this page's error message, possibly
null
.
-
-
-
Parameters:
-
errorMessage
- the error message or null
setMessage
protected void setMessage(
String message)
- Sets this page's message, possibly
null
.
-
-
-
Parameters:
-
message
- the message or null
getLaunchManager
protected
ILaunchManager getLaunchManager()
- Convenience method to return the launch manager.
-
-
-
Returns:
- the launch manager
dispose
public void dispose()
- By default, do nothing.
-
-
Specified by:
-
dispose
in interface
ILaunchConfigurationTab
-
-
See Also:
-
ILaunchConfigurationTab.dispose()
getShell
protected
Shell getShell()
- Returns the shell this tab is contained in, or
null
.
-
-
-
Returns:
- the shell this tab is contained in, or
null
createPushButton
protected
Button createPushButton(
Composite parent,
String label,
Image image)
- Creates and returns a new push button with the given
label and/or image.
-
-
-
Parameters:
-
parent
- parent control -
label
- button label or null
-
image
- image of null
-
Returns:
- a new push button
createRadioButton
protected
Button createRadioButton(
Composite parent,
String label)
- Creates and returns a new radio button with the given
label and/or image.
-
-
-
Parameters:
-
parent
- parent control -
label
- button label or null
-
Returns:
- a new radio button
createCheckButton
protected
Button createCheckButton(
Composite parent,
String label)
- Creates and returns a new check button with the given
label.
-
-
-
Parameters:
-
parent
- the parent composite -
label
- the button label
-
Returns:
- a new check button
-
Since:
- 3.0
canSave
public boolean canSave()
-
Description copied from interface:
ILaunchConfigurationTab
- Returns whether this tab is in a state that allows the launch configuration whose values
this tab is showing to be saved. This differs from
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.
-
-
Specified by:
-
canSave
in interface
ILaunchConfigurationTab
-
-
Returns:
- whether this tab is in a state that allows the current launch configuration to be saved
-
See Also:
-
ILaunchConfigurationTab.canSave()
isValid
public boolean isValid(
ILaunchConfiguration launchConfig)
-
Description copied from interface:
ILaunchConfigurationTab
- Returns whether this tab is in a valid state in the context of the specified launch configuration.
This information is typically used by the launch configuration
dialog to decide when it is okay to launch.
-
-
Specified by:
-
isValid
in interface
ILaunchConfigurationTab
-
-
Parameters:
-
launchConfig
- launch configuration which provides context for validating this tab.
This value must not be null
.
-
Returns:
- whether this tab is in a valid state
-
See Also:
-
ILaunchConfigurationTab.isValid(ILaunchConfiguration)
createVerticalSpacer
protected void createVerticalSpacer(
Composite comp,
int colSpan)
- Creates vertical space in the parent
Composite
-
-
-
Parameters:
-
comp
- the parent to add the vertical space to -
colSpan
- the number of line of vertical space to add
createSeparator
protected void createSeparator(
Composite comp,
int colSpan)
- Create a horizontal separator.
-
-
-
Parameters:
-
comp
- parent widget -
colSpan
- number of columns to span -
Since:
- 3.0
getImage
public
Image getImage()
-
Description copied from interface:
ILaunchConfigurationTab
- Returns the image for this tab, or
null
if none
-
-
Specified by:
-
getImage
in interface
ILaunchConfigurationTab
-
-
Returns:
- the image for this tab, or
null
if none -
See Also:
-
ILaunchConfigurationTab.getImage()
getId
public
String getId()
- Returns this tab's unique identifier or
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.
-
-
-
Returns:
- tab id or
null
-
Since:
- 3.3
setAttribute
protected void setAttribute(
String attribute,
ILaunchConfigurationWorkingCopy configuration,
boolean value,
boolean defaultValue)
- Convenience method to set a boolean attribute of on a launch
configuration. If the value being set is the default, the attribute's
value is set to
null
.
-
-
-
Parameters:
-
attribute
- attribute identifier -
configuration
- the configuration on which to set the attribute -
value
- the value of the attribute -
defaultValue
- the default value of the attribute -
Since:
- 2.1
isDirty
protected boolean isDirty()
- Returns if this tab has pending changes that need to be saved.
It is up to clients to set/reset and consult this attribute as required.
By default, a tab is initialized to dirty for backwards compatibility.
-
-
-
Returns:
- whether this tab is dirty
-
Since:
- 2.1
setDirty
protected void setDirty(boolean dirty)
- Sets the dirty state of the tab. Setting this flag allows clients to
explicitly say whether this tab has pending changes or not.
It is up to clients to set/reset and consult this attribute as required.
By default, a tab is initialized to dirty for backwards compatibility.
-
-
-
Parameters:
-
dirty
- what to set the dirty flag to -
Since:
- 2.1
activated
public 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. 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.
-
-
Specified by:
-
activated
in interface
ILaunchConfigurationTab
-
-
Parameters:
-
workingCopy
- the launch configuration being edited -
Since:
- 3.0
-
See Also:
-
ILaunchConfigurationTab.activated(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy)
deactivated
public 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. 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.
-
-
Specified by:
-
deactivated
in interface
ILaunchConfigurationTab
-
-
Parameters:
-
workingCopy
- the launch configuration being edited -
Since:
- 3.0
-
See Also:
-
ILaunchConfigurationTab.deactivated(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy)
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.