IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.testeditor.wizard
Class WizardPageProvider

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.wizard.WizardPage
          extended by com.ibm.rational.test.lt.testeditor.wizard.WizardPageProvider
All Implemented Interfaces:
IExecutableExtension, IDialogPage, IMessageProvider, IWizardPage

public abstract class WizardPageProvider
extends WizardPage
implements IExecutableExtension

This class is used in com.ibm.rational.test.lt.testeditor.WizardPageProvider extension point.

Since:
7.0.2

Field Summary
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
WizardPageProvider()
          Default constructor, called by extension point loader.
 
Method Summary
abstract  void createControl(Composite arg0)
          Create UI widgets for protocol options.
 void dispose()
           
 String getFeatureDescription()
          Returns the name of the feature.
 String getFeatureID()
          Returns feature ID defined by wizardPageForFeature attribute.
 IWizardPage getNextPage()
          Returns next contributed page (for multiple protocols) or summary page, if this is last contributed protocol page.
 String getSummaryText()
          Returns text summarizing the outcome of the initialization that this contributor provides.
 boolean isPageComplete()
          Returns true if page is not active, or super.isPageComplete() otherwise.
 boolean isRequired()
          Returns the value of required attribute.
 void setActive(boolean b)
          Sets active flag.
 void setInitializationData(IConfigurationElement config, String propertyName, Object data)
          Extracts extension information from IConfigurationElement.
protected  void testCreated(LTTest testSuite)
          This method is called for each active wizardPageContributor after the test has been created, so protocol-specific initialization can be made.
 
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible
 

Constructor Detail

WizardPageProvider

public WizardPageProvider()
Default constructor, called by extension point loader.

Method Detail

createControl

public abstract void createControl(Composite arg0)
Create UI widgets for protocol options.

Specified by:
createControl in interface IDialogPage
See Also:
IDialogPage.createControl(org.eclipse.swt.widgets.Composite)

setInitializationData

public void setInitializationData(IConfigurationElement config,
                                  String propertyName,
                                  Object data)
                           throws CoreException
Extracts extension information from IConfigurationElement.

Specified by:
setInitializationData in interface IExecutableExtension
Throws:
CoreException
Since:
7.0.1 The com.ibm.rational.test.lt.testeditor.wizardPageContributor extension point defines new attribute, wizardPageForFeature that defines feature ID. This attribute is added as a child element to wizardPage element.

The wizardPage element itself is marked as deprecated, so that existing extensions would know to update it accordingly.

See Also:
IExecutableExtension.setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)

testCreated

protected void testCreated(LTTest testSuite)
This method is called for each active wizardPageContributor after the test has been created, so protocol-specific initialization can be made. The by this time, the test already has the correct features added.

Parameters:
testSuite - LTTest

dispose

public void dispose()
Specified by:
dispose in interface IDialogPage
Overrides:
dispose in class DialogPage

getSummaryText

public String getSummaryText()
Returns text summarizing the outcome of the initialization that this contributor provides. This text will be displayed inside summary page.

Returns:
String text. Must not be null. Can be an empty string if there is no summary.

getFeatureID

public final String getFeatureID()
Returns feature ID defined by wizardPageForFeature attribute.

Returns:
String. feature ID.

getFeatureDescription

public String getFeatureDescription()
Returns the name of the feature. This name is taken from FeatureManager. Subclasses may override.

Returns:
String. The ame of the feature as defined in the com.ibm.rational.test.lt.licensing.feature extension point.
See Also:
Feature, FeatureManager

isRequired

public final boolean isRequired()
Returns the value of required attribute. The required is used to decide if the Finish button can be enabled right at the SelectFeaturePage, in other words, whether this WizardPageProvider is complete by default.

Returns:

getNextPage

public IWizardPage getNextPage()
Returns next contributed page (for multiple protocols) or summary page, if this is last contributed protocol page.

Specified by:
getNextPage in interface IWizardPage
Overrides:
getNextPage in class WizardPage

setActive

public void setActive(boolean b)
Sets active flag. When page is active, it will be displayed in the wizard. Page becomes active when the feature it represents is selected in the SelectFeaturePage. If active is false, then page state is set to complete, to allow for Finish button enablement.

Parameters:
active. -
Since:
7.0.1
See Also:
#isPageComplete()}

isPageComplete

public boolean isPageComplete()
Returns true if page is not active, or super.isPageComplete() otherwise. This ensures that the page returns true if it is not needed for current selection of features.

Specified by:
isPageComplete in interface IWizardPage
Overrides:
isPageComplete in class WizardPage
Since:
7.0.1
See Also:
WizardPageProvider.setActive(boolean)

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.