com.ibm.xtools.common.ui.wizards

Class AbstractBasicModelWizard

java.lang.Object

org.eclipse.jface.wizard.Wizard

org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

com.ibm.xtools.common.ui.wizards.AbstractBasicModelWizard

All Implemented Interfaces:

org.eclipse.jface.window.IShellProvider, org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard

Direct Known Subclasses:

NewModelWizard

public abstract class AbstractBasicModelWizard
extends org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

An abstract class to generalize behavior of wizards creating new models.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	EXISTING_PAGE_DESCRIPTION
protected static java.lang.String	EXISTING_PAGE_NAME
protected static java.lang.String	EXISTING_PAGE_TITLE
protected static java.lang.String	MAIN_PAGE_DESCRIPTION page descriptions
protected static java.lang.String	MAIN_PAGE_NAME page names (non-UI)
protected static java.lang.String	MAIN_PAGE_TITLE page titles
protected NewModelFromExistingModelPage	newModelFromExistingModelPage The second (existing model page) of the wizard
protected NewModelFromTemplatePage	newModelFromTemplatePage The second (template) page of the wizard
protected INewModelMainPage	newModelMainPage The main page of the new model wizard
protected static java.lang.String	TEMPLATE_PAGE_DESCRIPTION
protected static java.lang.String	TEMPLATE_PAGE_NAME
protected static java.lang.String	TEMPLATE_PAGE_TITLE

Fields inherited from class org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

selection

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

Constructors

Constructor and Description
AbstractBasicModelWizard() Create instance of the wizard

Method Summary

Modifier and Type	Method and Description
protected abstract NewModelFromExistingModelPage	createNewModelFromExistingModelPage() Create and return an instance of NewModelFromExistingModelPage
protected abstract NewModelFromTemplatePage	createNewModelFromTemplatePage() Create and return an instance of NewModelFromTemplatePage
protected abstract INewModelMainPage	createNewModelMainPage() Create and return an instance of INewModelMainPage
protected abstract boolean	finishPage(org.eclipse.core.runtime.IProgressMonitor monitor) Subclasses should override to perform the actions of the wizard.
protected NewModelFromExistingModelPage	getNewModelFromExistingModelPage()
protected NewModelFromTemplatePage	getNewModelFromTemplatePage()
protected INewModelMainPage	getNewModelMainPage()
protected NewModelFromExistingModelPage	initNewModelFromExistingModelPage()
protected NewModelFromTemplatePage	initNewModelFromTemplatePage() Create and return a new model from a standard template page for a new model creation
protected INewModelMainPage	initNewModelMainPage() Create and return main page for a new model creation
boolean	performFinish()

Methods inherited from class org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

getSelection, getWorkbench, init, initializeDefaultPageImageDescriptor, selectAndReveal, selectAndReveal

Methods inherited from class org.eclipse.jface.wizard.Wizard

addPage, addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.wizard.IWizard

addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

Field Detail

newModelMainPage

protected INewModelMainPage newModelMainPage

The main page of the new model wizard

newModelFromTemplatePage

protected NewModelFromTemplatePage newModelFromTemplatePage

The second (template) page of the wizard

newModelFromExistingModelPage

protected NewModelFromExistingModelPage newModelFromExistingModelPage

The second (existing model page) of the wizard

MAIN_PAGE_NAME

protected static final java.lang.String MAIN_PAGE_NAME

page names (non-UI)

See Also:

Constant Field Values

TEMPLATE_PAGE_NAME

protected static final java.lang.String TEMPLATE_PAGE_NAME

See Also:

Constant Field Values

EXISTING_PAGE_NAME

protected static final java.lang.String EXISTING_PAGE_NAME

See Also:

Constant Field Values

MAIN_PAGE_TITLE

protected static final java.lang.String MAIN_PAGE_TITLE

page titles

TEMPLATE_PAGE_TITLE

protected static final java.lang.String TEMPLATE_PAGE_TITLE

EXISTING_PAGE_TITLE

protected static final java.lang.String EXISTING_PAGE_TITLE

MAIN_PAGE_DESCRIPTION

protected static final java.lang.String MAIN_PAGE_DESCRIPTION

page descriptions

TEMPLATE_PAGE_DESCRIPTION

protected static final java.lang.String TEMPLATE_PAGE_DESCRIPTION

EXISTING_PAGE_DESCRIPTION

protected static final java.lang.String EXISTING_PAGE_DESCRIPTION

Constructor Detail

AbstractBasicModelWizard

public AbstractBasicModelWizard()

Create instance of the wizard

Method Detail

initNewModelMainPage

protected INewModelMainPage initNewModelMainPage()

Create and return main page for a new model creation

Returns:

Create and return main page for a new model creation

initNewModelFromTemplatePage

protected NewModelFromTemplatePage initNewModelFromTemplatePage()

Create and return a new model from a standard template page for a new model creation

Returns:

Create and return a new model from a standard template page for a new model creation

initNewModelFromExistingModelPage

protected NewModelFromExistingModelPage initNewModelFromExistingModelPage()

Returns:

Create and return a new model from an existing model page for a new model creation

createNewModelMainPage

protected abstract INewModelMainPage createNewModelMainPage()

Create and return an instance of INewModelMainPage

Returns:

- an instance of INewModelMainPage

createNewModelFromTemplatePage

protected abstract NewModelFromTemplatePage createNewModelFromTemplatePage()

Create and return an instance of NewModelFromTemplatePage

Returns:

- an instance of NewModelFromTemplatePage

createNewModelFromExistingModelPage

protected abstract NewModelFromExistingModelPage createNewModelFromExistingModelPage()

Create and return an instance of NewModelFromExistingModelPage

Returns:

- an instance of NewModelFromExistingModelPage

finishPage

protected abstract boolean finishPage(org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws java.lang.InterruptedException,
                                      org.eclipse.core.runtime.CoreException

Subclasses should override to perform the actions of the wizard. This method is run in the wizard container's context as a workspace runnable.

Throws:

java.lang.InterruptedException

org.eclipse.core.runtime.CoreException

performFinish

public boolean performFinish()

Specified by:

performFinish in interface org.eclipse.jface.wizard.IWizard

Specified by:

performFinish in class org.eclipse.jface.wizard.Wizard

getNewModelFromExistingModelPage

protected NewModelFromExistingModelPage getNewModelFromExistingModelPage()

Returns:

Returns the NewModelFromExistingModelPage.

getNewModelMainPage

protected INewModelMainPage getNewModelMainPage()

Returns:

Returns the INewModelMainPage.

getNewModelFromTemplatePage

protected NewModelFromTemplatePage getNewModelFromTemplatePage()

Returns:

Returns the NewModelFromTemplatePage.