eu.geclipse.ui.wizards.wizardselection
Class WizardSelectionListPage

java.lang.Object
  WizardSelectionPage
      eu.geclipse.ui.wizards.wizardselection.WizardSelectionListPage

Direct Known Subclasses:

ExtPointWizardSelectionListPage

public class WizardSelectionListPage
extends WizardSelectionPage

Wizard page for providing a list of other wizards which can be used for the next steps in the wizard.

Constructor Summary

WizardSelectionListPage(java.lang.String pageName, IWizardSelectionNode[] wizardSelectionNodes, java.lang.String title, java.lang.String desc, java.lang.String emptyListErrMsg)
Creates a wizard page which allows to select a wizard for the next steps.

WizardSelectionListPage(java.lang.String pageName, IWizardSelectionNode[] wizardSelectionNodes, java.lang.String title, java.lang.String desc, java.lang.String emptyListErrMsg, boolean quickSelection)
Creates a wizard page which allows to select a wizard for the next steps.

Method Summary

void	createControl(Composite parent)
void	dispose()
java.lang.String	getDescription()
IWizardPage	getNextPage()
IWizardSelectionNode[]	getNodes()
java.lang.String	getTitle()
void	pageChanged(PageChangedEvent event)
void	removeSelectionNode(IWizardSelectionNode nodeToRemove)
void	resetNodesVisibility()
void	setCheatSheetManager(ICheatSheetManager cheatSheetManager) Sets the cheat sheet manager.
void	setInitData(java.lang.Object initData) Sets the data to initialize a selected wizard with in case the wizard implements IInitializableWizard.
void	setPreselectedNode(IWizardNode node, boolean hidePrevPage) Sets the node of the wizard which should be preselected.

Methods inherited from class java.lang.Object

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

Constructor Detail

WizardSelectionListPage

public WizardSelectionListPage(java.lang.String pageName,
                               IWizardSelectionNode[] wizardSelectionNodes,
                               java.lang.String title,
                               java.lang.String desc,
                               java.lang.String emptyListErrMsg)

Creates a wizard page which allows to select a wizard for the next steps.

Parameters:

pageName - Name of the wizard page.

wizardSelectionNodes - list of the IWizardSelectionNodes to be displayed in the WizardSelectionListPage.

title - Title of the page.

desc - Description text of the page.

emptyListErrMsg - error message that should be displayed if the list is empty

WizardSelectionListPage

public WizardSelectionListPage(java.lang.String pageName,
                               IWizardSelectionNode[] wizardSelectionNodes,
                               java.lang.String title,
                               java.lang.String desc,
                               java.lang.String emptyListErrMsg,
                               boolean quickSelection)

Creates a wizard page which allows to select a wizard for the next steps.

Parameters:

pageName - Name of the wizard page.

wizardSelectionNodes - list of the IWizardSelectionNodes to be displayed in the WizardSelectionListPage.

title - Title of the page.

desc - Description text of the page.

emptyListErrMsg - error message that should be displayed if the list is empty

quickSelection - flag to define wizard behavior in case there is only one wizard to select. If true wizard should skip this (wizard selection) page. If false wizard should stop on this page (the normal wizard behavior).

Method Detail

setInitData

public void setInitData(java.lang.Object initData)

Sets the data to initialize a selected wizard with in case the wizard implements IInitializableWizard.

Parameters:

initData - the data to initialize the wizard with.

setPreselectedNode

public void setPreselectedNode(IWizardNode node,
                               boolean hidePrevPage)

Sets the node of the wizard which should be preselected. If set the WizardSelectionListPage will be skipped and the first page of the preselected wizard will be displayed.

Parameters:

node - IWizardNode representing the wizard to be preselected.

hidePrevPage - true if it should not be possible to go back to the WizardSelectionListPage to select another wizard, false otherwise.

dispose

public void dispose()

getTitle

public java.lang.String getTitle()

getDescription

public java.lang.String getDescription()

createControl

public void createControl(Composite parent)

getNextPage

public IWizardPage getNextPage()

pageChanged

public void pageChanged(PageChangedEvent event)

setCheatSheetManager

public void setCheatSheetManager(ICheatSheetManager cheatSheetManager)

Sets the cheat sheet manager. The "startingPageName" cheat sheet variable of the manager will be set to the name of the first page of the selected wizard when the user selects a wizard.

Parameters:

cheatSheetManager - the cheat sheet manager.

getNodes

public IWizardSelectionNode[] getNodes()

removeSelectionNode

public void removeSelectionNode(IWizardSelectionNode nodeToRemove)

resetNodesVisibility

public void resetNodesVisibility()