com.ibm.rational.test.lt.testgen.ui.wizards

Class NewTestGeneratorWizard

java.lang.Object

org.eclipse.jface.wizard.Wizard

com.ibm.rational.test.lt.recorder.ui.wizards.SubWizard

com.ibm.rational.test.lt.testgen.ui.wizards.NewTestGeneratorWizard

All Implemented Interfaces:

IShellProvider, IWizard, INewWizard, IWorkbenchWizard

public abstract class NewTestGeneratorWizard
extends SubWizard
implements INewWizard

Base class for implementing a test generator wizard. Test Generator wizards are embedded in the "Generate Test" wizards and interacts with the user for collecting options about a specific test generator.

Field Summary

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

Constructors

Constructor and Description
NewTestGeneratorWizard()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applySubWizardAdditionalPacketConverters(com.ibm.rational.test.lt.testgen.ui.wizards.TestGenerationContentWizard subWizard) Adds to this wizard's {additional converters the additional converters (early and not early) from the specified wizard.
List<PacketConverterConfiguration>	getAdditionalPacketConverters(boolean early) Returns the configurations of the additional converters required by the test generator.
protected ITestGenerationWizardContext	getContext() Returns context information about this wizard.
TestGeneratorConfiguration	getTestGeneratorConfiguration() Returns the configuration, filled from the user input, if exactly one configuration is configured by this wizard.
List<TestGeneratorConfiguration>	getTestGeneratorConfigurations() Returns the configurations, filled from the user input.
void	initialize(TestGeneratorConfiguration configuration, ITestGenerationWizardContext context) Initializes the wizard with one test generator configured by the given test generator configuration.

Methods inherited from class com.ibm.rational.test.lt.recorder.ui.wizards.SubWizard

canFinish, canFinishThisWizard, doPerformCancel, doPerformFinish, getNextPage, getNextPage, getNextPageForThisWizard, getNextPageForThisWizard, performCancel, performFinish, setParentWizard

Methods inherited from class org.eclipse.jface.wizard.Wizard

addPage, addPages, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchWizard

init

Methods inherited from interface org.eclipse.jface.wizard.IWizard

addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer

Constructor Detail

NewTestGeneratorWizard

public NewTestGeneratorWizard()

Method Detail

initialize

public void initialize(TestGeneratorConfiguration configuration,
              ITestGenerationWizardContext context)

Initializes the wizard with one test generator configured by the given test generator configuration. The wizard may either modify this configuration (that can be retrieved using NewTestGeneratorWizard.getTestGeneratorConfiguration()), or modify the list of test generators.

Parameters:

configuration - The initial configuration to be configured by this wizard.

getContext

protected final ITestGenerationWizardContext getContext()

Returns context information about this wizard.

Returns:

context information about this wizard.

getTestGeneratorConfiguration

public final TestGeneratorConfiguration getTestGeneratorConfiguration()

Returns the configuration, filled from the user input, if exactly one configuration is configured by this wizard.

Returns:

the configuration, filled from the user input, if exactly one configuration is configured by this wizard, or null if more than one configuration is configured by this wizard.

getTestGeneratorConfigurations

public final List<TestGeneratorConfiguration> getTestGeneratorConfigurations()

Returns the configurations, filled from the user input. This method is invoked by the framework only when SubWizard.canFinish() returns true (implementations are free to call this at other phases). After initialization, this list has exactly one element. It can be modified by the caller.

Returns:

getAdditionalPacketConverters

public final List<PacketConverterConfiguration> getAdditionalPacketConverters(boolean early)

Returns the configurations of the additional converters required by the test generator. Note that this list should be populated only with the converters that are not automatically inserted because of a requirement declared in the test generator declaration in plugin.xml. The list is by default empty.

Parameters:

-

Returns:

the configurations of the additional converters required by the test generator.

applySubWizardAdditionalPacketConverters

protected void applySubWizardAdditionalPacketConverters(com.ibm.rational.test.lt.testgen.ui.wizards.TestGenerationContentWizard subWizard)

Adds to this wizard's {additional converters the additional converters (early and not early) from the specified wizard.