org.eclipse.hyades.test.ui.launch.tabGroups
Class AbstractTabGroup

java.lang.Object
  org.eclipse.debug.ui.AbstractLaunchConfigurationTabGroup
      org.eclipse.hyades.test.ui.launch.tabGroups.AbstractTabGroup

All Implemented Interfaces:

org.eclipse.debug.ui.ILaunchConfigurationTabGroup

Direct Known Subclasses:

BasicTestComponentTabGroup, BasicTestTabGroup

public abstract class AbstractTabGroup

extends org.eclipse.debug.ui.AbstractLaunchConfigurationTabGroup

Provides an abstract tab group for TPTP launch configurations.

This class can be extended by external plugins to define their own launch configuration type, based on the Test launch configuration type.

This tab group is organized into five parts:

1. A runnable item selection tab. This tab allows to select the item to launch. This class does not implement this section. To provide this section, subclasses are required to implement addRunnableItemSelectionTab(List, String).
2. The Test Log tab. This tab enables the user to specify options about the Test Log that will produced during the Test execution. To override this section, subclasses needs to override addExecutionHistoryTab(List).
3. Additional tabs providing options specifying how the runnable item will be run. In this implementation, this section is empty. To override this section, subclasses need to override addAdditionalTabs(List, String).
4. Mode-specific tabs. This class allows to add tabs when the launch configuration displayed in the context of a specific mode. This implementation adds the "Profiling" tab when the launch configuration dialog is invoked using the "Profile..." command, and adds the Eclipse "Source Path Lookup" tab when the dialog is invoked using the "Debug..." command. To override this behavior, subclasses may override these methods: addProfilingTab(List, boolean) and addDebuggingTab(List).
5. The Eclipse Common Tab. To override this section, subclasses need to override addCommonTab(List).

Field Summary

Fields inherited from class org.eclipse.debug.ui.AbstractLaunchConfigurationTabGroup

fTabs

Constructor Summary

AbstractTabGroup()

Method Summary

protected void	addAdditionalTabs(java.util.List tabList, java.lang.String mode) Adds any additional tabs that do not belong to any other sections.
protected void	addCommonTab(java.util.List tabList) Adds Eclise common tab.
protected void	addDebuggingTab(java.util.List tabList) Adds tabs that are specific to the "debug" mode.
protected void	addExecutionHistoryTab(java.util.List tabList) Adds the Test Log related tabs.
protected void	addProfilingTab(java.util.List tabList, boolean attach) Adds tabs that are specific to the "profile" mode.
protected abstract void	addRunnableItemSelectionTab(java.util.List tabList, java.lang.String mode) Adds the Runnable Item selection tab (Runnable Item is typically what is to be run, e.g.
protected void	addTestAndDeploymentTab(java.util.List tabList, java.lang.String mode) Deprecated. To instantiate a TestAndDeploymentTab, use TestLaunchConfigurationTabFactory.createTestAndDeploymentTab(String, String) instead. To define a tab group that extends the Test launch configuration tab group, extend the class BasicTestTabGroup so a call to this method will become unnecessary.
protected void	addTestComponentAndDeploymentTab(java.util.List tabList, java.lang.String mode) Deprecated. To instantiate a TestComponentAndDeploymentTab, use TestLaunchConfigurationTabFactory.createTestComponentAndDeploymentTab(String, String) instead. To define a tab group that extends the Test Component launch configuration tab group, extend the class BasicTestComponentTabGroup so a call to this method will become unnecessary.
void	createTabs(org.eclipse.debug.ui.ILaunchConfigurationDialog dialog, java.lang.String mode) Creates the tabs.
protected java.lang.String	getLaunchConfigurationType() Returns the Launch Configuration Type this tab group applies for.
protected boolean	getProfilingAttachOption() Return the attach option for constructing the Profile tab (if applicable).
protected boolean	isDebugMode(java.lang.String mode) Is the supplied mode the Debug mode.
protected boolean	isProfilingMode(java.lang.String mode) Is the supplied mode the Profiling mode.

Methods inherited from class org.eclipse.debug.ui.AbstractLaunchConfigurationTabGroup

dispose, getTabs, initializeFrom, launched, performApply, setDefaults, setTabs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTabGroup

public AbstractTabGroup()

Method Detail

createTabs

public void createTabs(org.eclipse.debug.ui.ILaunchConfigurationDialog dialog,
                       java.lang.String mode)

Creates the tabs. This method method is not meant to be overrided.

See Also:

ILaunchConfigurationTabGroup.createTabs(org.eclipse.debug.ui.ILaunchConfigurationDialog, java.lang.String)

isProfilingMode

protected boolean isProfilingMode(java.lang.String mode)

Is the supplied mode the Profiling mode. This method is a conveniency method for the use of sub-classes and should not be overrided.

Parameters:

mode -

Returns:

isDebugMode

protected boolean isDebugMode(java.lang.String mode)

Is the supplied mode the Debug mode. This method is a conveniency method for the use of sub-classes and should not be overrided.

Parameters:

mode -

Returns:

addRunnableItemSelectionTab

protected abstract void addRunnableItemSelectionTab(java.util.List tabList,
                                                    java.lang.String mode)

Adds the Runnable Item selection tab (Runnable Item is typically what is to be run, e.g. Test(s) or Test Component(s)). This method must be implemented in the sub-class.

Parameters:

tabList -

addExecutionHistoryTab

protected void addExecutionHistoryTab(java.util.List tabList)

Adds the Test Log related tabs. This implementation adds the "Test Log" tab to the list. This method may be overrided in sub-classes.

Parameters:

tabList -

addAdditionalTabs

protected void addAdditionalTabs(java.util.List tabList,
                                 java.lang.String mode)

Adds any additional tabs that do not belong to any other sections. This implementation does nothing. This method may be overrided in sub-classes.

Parameters:

tabList -

addProfilingTab

protected void addProfilingTab(java.util.List tabList,
                               boolean attach)

Adds tabs that are specific to the "profile" mode. This implementation adds the TPTP Profiling tab to the list. This method may be overrided in sub-classes.

Parameters:

tabList - The list the tab is to be added to.

attach - Provides the auto-attach option of the Profiling tab.

See Also:

ProfileTab.ProfileTab(boolean)

addDebuggingTab

protected void addDebuggingTab(java.util.List tabList)

Adds tabs that are specific to the "debug" mode. This implementation adds the JDT Source Path Lookup tab to the list. This method may be overrided in sub-classes.

Parameters:

tabList -

addCommonTab

protected void addCommonTab(java.util.List tabList)

Adds Eclise common tab. This implementation adds the Eclipse "Common" tab. This method may be overrided, typically when the common tab should not be displayed.

Parameters:

tabList -

getProfilingAttachOption

protected boolean getProfilingAttachOption()

Return the attach option for constructing the Profile tab (if applicable). By default, return true. This method may be redefined by subclasses.

Returns:

getLaunchConfigurationType

protected java.lang.String getLaunchConfigurationType()

Returns the Launch Configuration Type this tab group applies for. null is valid and means "Regular TPTP Test Launch Configuration Type". Subclasses should redefine this method (unless no particular type-based tab is used).

Returns:

addTestAndDeploymentTab

protected void addTestAndDeploymentTab(java.util.List tabList,
                                       java.lang.String mode)

Deprecated. To instantiate a TestAndDeploymentTab, use TestLaunchConfigurationTabFactory.createTestAndDeploymentTab(String, String) instead. To define a tab group that extends the Test launch configuration tab group, extend the class BasicTestTabGroup so a call to this method will become unnecessary.

addTestComponentAndDeploymentTab

protected void addTestComponentAndDeploymentTab(java.util.List tabList,
                                                java.lang.String mode)

Deprecated. To instantiate a TestComponentAndDeploymentTab, use TestLaunchConfigurationTabFactory.createTestComponentAndDeploymentTab(String, String) instead. To define a tab group that extends the Test Component launch configuration tab group, extend the class BasicTestComponentTabGroup so a call to this method will become unnecessary.