TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.tptp.trace.ui.provisional.launcher
Interface IConfigurationPage


public interface IConfigurationPage

Represents a configuration page displayed as part of a configuration wizard that can be associated with either a data collector or an analysis type.


Method Summary
 void addErrorListener(IStatusListener statusListener)
          Clients should be able to register listners that will be notified when there is a change in a page that might possibly cause an error.
 void createControl(org.eclipse.swt.widgets.Composite parent)
          Create the controls of the page using 'parent' as the parent composite
 java.lang.String getDescription()
          Return the description for this configuration page.
 java.lang.String getPageName()
          Returns the page name of this page.
 java.lang.String getTitle()
          Returns the title of the configuration page that will displayed as part of the wizard.
 org.eclipse.jface.resource.ImageDescriptor getWizardBanner()
          Return the wizard banner for this page.
 void reset(org.eclipse.debug.core.ILaunchConfiguration launchConfiguration)
          This method is invoked to reset the values of controls displayed as part of the wizard page.
 

Method Detail

reset

public void reset(org.eclipse.debug.core.ILaunchConfiguration launchConfiguration)
This method is invoked to reset the values of controls displayed as part of the wizard page. The argument will commonly be used to extract known attribute values that can be used as the value for displayed controls. This method can be invoked before or after the invocation of createControl(Composite)

Parameters:
launchConfiguration - The launch configuration that is currently selected.

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)
Create the controls of the page using 'parent' as the parent composite

Parameters:
parent - The parent composite

getPageName

public java.lang.String getPageName()
Returns the page name of this page. The value return CANNOT be null.

Returns:
The page name

getTitle

public java.lang.String getTitle()
Returns the title of the configuration page that will displayed as part of the wizard.

Returns:
The title of the page

getWizardBanner

public org.eclipse.jface.resource.ImageDescriptor getWizardBanner()
Return the wizard banner for this page.

Returns:
A wizard banner

getDescription

public java.lang.String getDescription()
Return the description for this configuration page.

Returns:
The description of the page

addErrorListener

public void addErrorListener(IStatusListener statusListener)
Clients should be able to register listners that will be notified when there is a change in a page that might possibly cause an error.

This class is obligated to:

  1. invoke statusListener.handleErrorEvent(String) when there is an error in the current page.
  2. invoke statusListener.handleOKEvent () when there are not errors in the current page.
  3. Parameters:
    statusListener - The listener object to be registered

TPTP 4.2.0 Platform Project
Public API Specification