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

Class AbstractNewModelProjectWizard<T extends IMetaModelDescriptor>

java.lang.Object

org.eclipse.jface.wizard.Wizard

org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard

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

All Implemented Interfaces:

org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard

Direct Known Subclasses:

BasicNewModelProjectWizard

public abstract class AbstractNewModelProjectWizard<T extends IMetaModelDescriptor>
extends org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard

Abstract wizard for creating a new model project in the workspace. Two pages are added for selecting the properties of the model project and references to other projects. When being finished a new model project job is run to create the model project in the workspace.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	baseMetaModelDescriptor
protected boolean	createWorkingSetGroup
protected org.eclipse.ui.dialogs.WizardNewProjectCreationPage	mainPage
protected java.lang.String	metaModelName
protected IProjectWorkspacePreference<T>	metaModelVersionPreference
protected java.lang.String	metaModelVersionPreferencePageId
protected org.eclipse.ui.dialogs.WizardNewProjectReferencePage	referencePage

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

WIZARD_ID

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
AbstractNewModelProjectWizard() Creates a wizard for creating a new model project in the workspace.
AbstractNewModelProjectWizard(boolean createWorkingSetGroup, T baseMetaModelDescriptor, IProjectWorkspacePreference<T> metaModelVersionPreference, java.lang.String metaModelVersionPreferencePageId) Creates a wizard for creating a new model project in the workspace with required metamodel version descriptor and metamodel version preference.
AbstractNewModelProjectWizard(java.lang.String metaModelName) Creates a wizard for creating a new model project in the workspace.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPages()
protected CreateNewModelProjectJob<T>	createCreateNewModelProjectJob(java.lang.String jobName, org.eclipse.core.resources.IProject newProject, java.net.URI location) Creates a new instance of CreateNewModelProjectJob.
protected org.eclipse.ui.dialogs.WizardNewProjectCreationPage	createMainPage() Creates the main page for the creation of the new model project.
protected org.eclipse.ui.dialogs.WizardNewProjectReferencePage	createReferencePage() Creates the reference page.
void	init(org.eclipse.ui.IWorkbench workbench, org.eclipse.jface.viewers.IStructuredSelection selection)
boolean	performFinish()

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

getNewProject, initializeDefaultPageImageDescriptor, setInitializationData, updatePerspective, updatePerspective

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

getSelection, getWorkbench, 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 org.eclipse.ui.dialogs.WizardNewProjectCreationPage mainPage

referencePage

protected org.eclipse.ui.dialogs.WizardNewProjectReferencePage referencePage

metaModelName

protected java.lang.String metaModelName

createWorkingSetGroup

protected boolean createWorkingSetGroup

baseMetaModelDescriptor

protected T extends IMetaModelDescriptor baseMetaModelDescriptor

metaModelVersionPreference

protected IProjectWorkspacePreference<T extends IMetaModelDescriptor> metaModelVersionPreference

metaModelVersionPreferencePageId

protected java.lang.String metaModelVersionPreferencePageId

Constructor Detail

AbstractNewModelProjectWizard

public AbstractNewModelProjectWizard()

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

AbstractNewModelProjectWizard

public AbstractNewModelProjectWizard(java.lang.String metaModelName)

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

Parameters:

metaModelName - the name of the metamodel the new model project should be dedicated to

AbstractNewModelProjectWizard

public AbstractNewModelProjectWizard(boolean createWorkingSetGroup,
                             T baseMetaModelDescriptor,
                             IProjectWorkspacePreference<T> metaModelVersionPreference,
                             java.lang.String metaModelVersionPreferencePageId)

Creates a wizard for creating a new model project in the workspace with required metamodel version descriptor and metamodel version preference.

Parameters:

createWorkingSetGroup - true if a group for choosing a working set for the new model project should be added to the wizard's main page, false otherwise

baseMetaModelDescriptor - the base meta-model of the model project to be created; when set to null no metamodel version will be configured

metaModelVersionPreference - the metamodel version preference of the model project; when set to null no metamodel version will be configured

metaModelVersionPreferencePageId - the id of the metamodel version preference page

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.BasicNewProjectResourceWizard

addPages

public void addPages()

Specified by:

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

Overrides:

addPages in class org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard

createMainPage

protected org.eclipse.ui.dialogs.WizardNewProjectCreationPage createMainPage()

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

Returns:

a main page for the creation of the new model project

createReferencePage

protected org.eclipse.ui.dialogs.WizardNewProjectReferencePage createReferencePage()

Creates the reference page.

performFinish

public boolean performFinish()

Specified by:

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

Overrides:

performFinish in class org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard

createCreateNewModelProjectJob

protected CreateNewModelProjectJob<T> createCreateNewModelProjectJob(java.lang.String jobName,
                                                         org.eclipse.core.resources.IProject newProject,
                                                         java.net.URI location)

Creates a new instance of CreateNewModelProjectJob. This method may be overridden by clients to create a specific model project creation job as appropriate.

Parameters:

jobName - the pre-calculated name of the job

newProject - the project resource to be created

location - the location where the project will be created. If null the default location will be used.

Returns:

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