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

Class NewRecorderClientWizard

java.lang.Object

org.eclipse.jface.wizard.Wizard

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

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

All Implemented Interfaces:

IShellProvider, IWizard, IWorkbenchWizard

public abstract class NewRecorderClientWizard
extends SubWizard
implements IWorkbenchWizard

A wizard that configures a specific type of client and one or more type of recorders. Implementations should fill the wizard's client and recorders configurations in their SubWizard.doPerformFinish() implementation.

Field Summary

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

DEFAULT_IMAGE

Constructor Summary

Constructors

Constructor and Description
NewRecorderClientWizard()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doPerformCancel() Resets the configuration to its original state.
ClientConfiguration	getClientConfiguration() Returns the first client configuration, filled from the user input.
RecordingSessionConfiguration	getConfiguration() Returns the recording session configuration fragment configured by this wizard.
RecorderConfiguration[]	getRecorderConfigurations() Returns the recorder configurations, filled with properties from the user input This method is invoked only when SubWizard.canFinishThisWizard() returns true.
void	initialize(ClientConfiguration clientConfiguration, List<String> recordersToConfigure, List<String> optionalRecordersToConfigure) Initializes the wizard with the specified configurations.
void	initialize(ClientConfiguration clientConfiguration, RecorderConfiguration recorderConfiguration) Initializes the wizard with the specified configurations.
void	setConfiguration(RecordingSessionConfiguration configuration) Replaces the current configuration with the specified one.
protected void	setRecorderConfigurations(RecorderConfiguration[] recorderConfigurations) Sets the recorder configurations edited by this wizard.

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

canFinish, canFinishThisWizard, 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

NewRecorderClientWizard

public NewRecorderClientWizard()

Method Detail

initialize

public void initialize(ClientConfiguration clientConfiguration,
              RecorderConfiguration recorderConfiguration)

Initializes the wizard with the specified configurations.

Parameters:

clientConfiguration - An empty client configuration, with the type chosen by the user prior to this wizard.

recorderConfiguration - Either null, if this wizard is declared to perform the recorder type selection (see performsRecorderSelection in the extension point), or an empty recorder configuration, with the type chosen by the user prior to this wizard.

initialize

public void initialize(ClientConfiguration clientConfiguration,
              List<String> recordersToConfigure,
              List<String> optionalRecordersToConfigure)

Initializes the wizard with the specified configurations. This method is called when the wizard is declared to perform the recorder selection per definition in plugin.xml.

Parameters:

clientConfiguration - An empty client configuration, with the type chosen by the user prior to this wizard.

recordersToConfigure - The list of recorders that this wizard must configure. This is the list of non-optional configured recorders declared in the corresponding definition in plugin.xml.

getRecorderConfigurations

public final RecorderConfiguration[] getRecorderConfigurations()

Returns the recorder configurations, filled with properties from the user input This method is invoked only when SubWizard.canFinishThisWizard() returns true. If this wizard does not perform recorder selection, this method should return only one recorder configuration.

Returns:

getClientConfiguration

public final ClientConfiguration getClientConfiguration()

Returns the first client configuration, filled from the user input. This method is invoked only when SubWizard.canFinishThisWizard() returns true.

Returns:

setRecorderConfigurations

protected final void setRecorderConfigurations(RecorderConfiguration[] recorderConfigurations)

Sets the recorder configurations edited by this wizard.

Parameters:

recorderConfigurations -

getConfiguration

public final RecordingSessionConfiguration getConfiguration()

Returns the recording session configuration fragment configured by this wizard. The returned object content may be edited by the wizard (usually during the SubWizard.doPerformFinish() execution), and will be consulted by the framework after SubWizard.doPerformFinish().

Returns:

setConfiguration

public final void setConfiguration(RecordingSessionConfiguration configuration)

Replaces the current configuration with the specified one.

Parameters:

configuration -

doPerformCancel

public boolean doPerformCancel()

Resets the configuration to its original state. Sub-classes must either call their super implementation, or either handle this case by resetting their configuration so doPerformFinish() can be called again.

Overrides:

doPerformCancel in class SubWizard

Returns: