org.eclipse.sphinx.emf.workspace.ui.wizards

Class AbstractNewModelFileWizard<T extends IMetaModelDescriptor>

java.lang.Object

org.eclipse.jface.wizard.Wizard

org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

org.eclipse.sphinx.emf.workspace.ui.wizards.AbstractNewModelFileWizard<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

GenericNewModelFileWizard

public abstract class AbstractNewModelFileWizard<T extends IMetaModelDescriptor>
extends org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

Abstract wizard for creating a new model file in the workspace. No pages are added by default. When being finished a new model file job is run to create and save the new model file in the workspace.

Field Summary

Fields

Modifier and Type	Field and Description
protected NewModelFileCreationPage<T>	mainPage
protected java.lang.String	metaModelName

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
AbstractNewModelFileWizard() Creates a wizard for creating a new model file in the workspace.
AbstractNewModelFileWizard(java.lang.String metaModelName) Creates a wizard for creating a new model file in the workspace.

Method Summary

Modifier and Type	Method and Description
void	addPages()
protected abstract org.eclipse.core.runtime.jobs.Job	createCreateNewModelFileJob(java.lang.String jobName, org.eclipse.core.resources.IFile newFile) Creates a new instance of CreateNewModelFileJob.
protected abstract NewModelFileCreationPage<T>	createMainPage() Creates the main page for the creation of the new model file.
void	init(org.eclipse.ui.IWorkbench workbench, org.eclipse.jface.viewers.IStructuredSelection selection)
protected void	openNewModelInEditor(org.eclipse.core.resources.IFile newFile) Opens newly created model in an editor.
boolean	performFinish()

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

getSelection, getWorkbench, initializeDefaultPageImageDescriptor, selectAndReveal, selectAndReveal

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

addPage, 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

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

Field Detail

mainPage

protected NewModelFileCreationPage<T extends IMetaModelDescriptor> mainPage

metaModelName

protected java.lang.String metaModelName

Constructor Detail

AbstractNewModelFileWizard

public AbstractNewModelFileWizard()

Creates a wizard for creating a new model file in the workspace.

AbstractNewModelFileWizard

public AbstractNewModelFileWizard(java.lang.String metaModelName)

Creates a wizard for creating a new model file in the workspace.

Parameters:

metaModelName - the name of the metamodel the new model file should be based on

Method Detail

init

public void init(org.eclipse.ui.IWorkbench workbench,
                 org.eclipse.jface.viewers.IStructuredSelection selection)

Specified by:

init in interface org.eclipse.ui.IWorkbenchWizard

Overrides:

init in class org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

addPages

public void addPages()

Specified by:

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

Overrides:

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

createMainPage

protected abstract NewModelFileCreationPage<T> createMainPage()

Creates the main page for the creation of the new model file. This method must be overridden by clients to create a specific main page as appropriate.

Returns:

a main page for the creation of the new model file

performFinish

public boolean performFinish()

Specified by:

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

Specified by:

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

createCreateNewModelFileJob

protected abstract org.eclipse.core.runtime.jobs.Job createCreateNewModelFileJob(java.lang.String jobName,
                                                                                 org.eclipse.core.resources.IFile newFile)

Creates a new instance of CreateNewModelFileJob. This method must be overridden by clients to create a specific model file creation job as appropriate.

Parameters:

jobName - the pre-calculated name of the job

newFile - the new model file to be created

Returns:

a new instance of job that creates a new model file. This job is a unit of runnable work that can be scheduled to be run with the job manager.

openNewModelInEditor

protected void openNewModelInEditor(org.eclipse.core.resources.IFile newFile)

Opens newly created model in an editor.

Parameters:

newFile - the new model file to be opened