com.ibm.xtools.common.ui.wizards.pagegroups

Interface ITemplateConfigurationPageGroup

All Known Implementing Classes:

AbstractTemplateConfigurationPageGroup, ActivitiesTemplateConfigurationPageGroup, LinearTemplateConfigurationPageGroup

public interface ITemplateConfigurationPageGroup

Template configuration page groups allow for additional configuration of templates in the new model wizard. The group can produce 1 or more wizard pages and create a workflow between the pages.

Method Summary

Modifier and Type	Method and Description
boolean	canFinish() Returns whether all pages could be finished without further user interaction.
boolean	finish(org.eclipse.core.runtime.IProgressMonitor progressMonitor) Called by the wizard whenever the user presses the finish button.
ITemplateConfigurationPage	getNextPage(org.eclipse.jface.wizard.IWizardPage page) Returns the successor of the given page.
ITemplateConfigurationPage	getPreviousPage(org.eclipse.jface.wizard.IWizardPage page) Returns the predecessor of the given page.
TemplateConfiguration	getTemplateConfiguration() Gets the template configuration.
void	initPages(org.eclipse.jface.wizard.IWizard wizard) This method is called after the template configuration has been set.
void	setTemplateConfiguration(TemplateConfiguration templateConfiguration) Sets the template configuration.

Method Detail

getNextPage

ITemplateConfigurationPage getNextPage(org.eclipse.jface.wizard.IWizardPage page)

Returns the successor of the given page. If the given page is null, return the starting page.

Parameters:

page - the page

Returns:

the next page, or null if none

getPreviousPage

ITemplateConfigurationPage getPreviousPage(org.eclipse.jface.wizard.IWizardPage page)

Returns the predecessor of the given page. If the given page is null, return the last page.

Parameters:

page - the page

Returns:

the previous page, or null if none

canFinish

boolean canFinish()

Returns whether all pages could be finished without further user interaction.

Returns:

true if all pages could be finished, false otherwise

initPages

void initPages(org.eclipse.jface.wizard.IWizard wizard)

This method is called after the template configuration has been set. The group should initialize all of it's pages it will be contributing. This will allow clients to finish the wizard earlier if all the pages are valid by default.

Parameters:

wizard - the wizard

setTemplateConfiguration

void setTemplateConfiguration(TemplateConfiguration templateConfiguration)

Sets the template configuration.

Parameters:

templateConfiguration -

getTemplateConfiguration

TemplateConfiguration getTemplateConfiguration()

Gets the template configuration.

Returns:

the template configuration

finish

boolean finish(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Called by the wizard whenever the user presses the finish button.

Parameters:

progressMonitor - the progress monitor

Returns:

true if successfully finished, false otherwise