org.eclipse.tptp.test.provisional.recorder.ui.wizards
Interface IRecorderPageProvider

All Superinterfaces:

IRecorderProvider

All Known Implementing Classes:

DefaultRecWizardProvider

public interface IRecorderPageProvider

extends IRecorderProvider

A recorder provider which provides additonal custom wizard pages to the generic recording wizard. This provider is responsible for assembling the pages, collecting the page data, and providing a mechanism to provide this data to other providers.

Field Summary

static java.lang.String	WIZARD_KEY_APP_ADAPTER default key string for the recording instance's Application Adapter id
static java.lang.String	WIZARD_KEY_CONFIG_PARAMS default key string for the recording instance's init and config paramaters (String)
static java.lang.String	WIZARD_KEY_RECORDING_PATH default key string for defining path to a recording file
static java.lang.String	WIZARD_KEY_TESTGEN_ID default key string the defining the test generator's ID, or "-1" if none.
static java.lang.String	WIZARD_KEY_TESTGEN_PATH default key string for defining path to the test to be generated

Method Summary

boolean	doCancel() Called if wizard Cancel button is pressed.
boolean	doFinish() Called if wizard Finish button is pressed.
java.lang.Object	getObjectValue(java.lang.String key) Returns an Object value from the wizard providers internal storage facility.
java.lang.String	getValue(java.lang.String key) Returns a value from the wizard providers internal storage facility.
IGenericRecorderWizard	getWizard() Returns the containing wizard.
IGenericRecorderPage[]	getWizardPages(IGenericRecorderWizard wizard) Called by generic recorder wizard, provides additional recorder wizard pages

Methods inherited from interface org.eclipse.tptp.test.provisional.recorder.framework.IRecorderProvider

getRecorder, getRecorderID, setRecorder, setRecorder

Field Detail

WIZARD_KEY_RECORDING_PATH

public static final java.lang.String WIZARD_KEY_RECORDING_PATH

default key string for defining path to a recording file

See Also:

Constant Field Values

WIZARD_KEY_TESTGEN_PATH

public static final java.lang.String WIZARD_KEY_TESTGEN_PATH

default key string for defining path to the test to be generated

See Also:

Constant Field Values

WIZARD_KEY_CONFIG_PARAMS

public static final java.lang.String WIZARD_KEY_CONFIG_PARAMS

default key string for the recording instance's init and config paramaters (String)

See Also:

Constant Field Values

WIZARD_KEY_APP_ADAPTER

public static final java.lang.String WIZARD_KEY_APP_ADAPTER

default key string for the recording instance's Application Adapter id

See Also:

(schema), Constant Field Values

WIZARD_KEY_TESTGEN_ID

public static final java.lang.String WIZARD_KEY_TESTGEN_ID

default key string the defining the test generator's ID, or "-1" if none.

See Also:

(schema), TestGenerator, Constant Field Values

Method Detail

getWizardPages

public IGenericRecorderPage[] getWizardPages(IGenericRecorderWizard wizard)

Called by generic recorder wizard, provides additional recorder wizard pages

Returns:

IGenericRecorderPage[]

getValue

public java.lang.String getValue(java.lang.String key)

Returns a value from the wizard providers internal storage facility. Used by recorder framework to access key data set in the wizard.

Parameters:

key -

Returns:

String associated with the key value

key

or

null

if no data.

getObjectValue

public java.lang.Object getObjectValue(java.lang.String key)

Returns an Object value from the wizard providers internal storage facility. Used by recorder framework to access key data set in the wizard.

Parameters:

key -

Returns:

Object associated with the key value

key

or

null

if no data.

doFinish

public boolean doFinish()

Called if wizard Finish button is pressed. Note that initializing for recording is not intended to begin here, but in IRecorderClientHelper.preSetup()

Returns:

true if no errors

doCancel

public boolean doCancel()

Called if wizard Cancel button is pressed.

Returns:

true if no errors

getWizard

public IGenericRecorderWizard getWizard()

Returns the containing wizard. This should be the wizard that is a parameter in the constructor IRecorderPageProvider(IGenericRecorderWizard)

Returns: