org.eclipse.emfforms.spi.example.wizards

Class EMFFormsExampleInstallerWizard

java.lang.Object

org.eclipse.jface.wizard.Wizard

org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

org.eclipse.emf.common.ui.wizard.ExampleInstallerWizard

org.eclipse.emfforms.spi.example.wizards.EMFFormsExampleInstallerWizard

All Implemented Interfaces:

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

Direct Known Subclasses:

CoffeeExampleWizard

public class EMFFormsExampleInstallerWizard
extends org.eclipse.emf.common.ui.wizard.ExampleInstallerWizard

Wizard to create example projects in the workspace. This implementation uses a generic page title and description for the project overview page. To customize these, the following methods can be overwritten:

• getProjectPageTitle()
• getProjectPageDescription()

Since:

1.18

Author:

Lucas Koehler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EMFFormsExampleInstallerWizard.ExampleInstallerPage The project page for the EMFFormsExampleInstallerWizard.

Nested classes/interfaces inherited from class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard.FileToOpen, org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard.ProjectDescriptor, org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard.ProjectPage

Field Summary

Fields inherited from class org.eclipse.emf.common.ui.wizard.ExampleInstallerWizard

filesToOpen, projectDescriptors, wizardConfigurationElement

Fields inherited from class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

OVERWRITE_ALL_QUERY, structuredSelection, workbench

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

DEFAULT_IMAGE

Constructor Summary

Constructors

Constructor and Description
EMFFormsExampleInstallerWizard()

Method Summary

Modifier and Type	Method and Description
void	addPages()
protected org.eclipse.emf.common.util.Diagnostic	deleteExistingProjects(org.eclipse.core.runtime.IProgressMonitor monitor) The EMFFormsExampleInstallerWizard doesn't delete any projects.
void	dispose()
protected String	getProjectPageDescription() Returns the description for the project page that shows the projects that are to be created in the workspace.
protected String	getProjectPageTitle() Returns the title for the project page that shows the projects that are to be created in the workspace.
protected void	installExample(org.eclipse.core.runtime.IProgressMonitor progressMonitor) In contrast to the AbstractExampleInstallerWizard, the EMFFormsExampleInstallerWizard only installs projects if they do not already exist in the workspace.

Methods inherited from class org.eclipse.emf.common.ui.wizard.ExampleInstallerWizard

getFilesToOpen, getProjectDescriptors, loadFromExtensionPoints, setInitializationData

Methods inherited from class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

createDirectoryImportOperation, createFileImportOperation, createImportOperation, createProject, createZipFile, createZipImportOperation, getSelection, getWorkbench, init, installProject, installProject, installProjectFromDirectory, installProjectFromFile, isZipFile, openEditor, openErrorDialog, openFiles, performFinish

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

addPage, canFinish, createPageControls, 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, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

Methods inherited from interface org.eclipse.jface.window.IShellProvider

getShell

Constructor Detail

EMFFormsExampleInstallerWizard

public EMFFormsExampleInstallerWizard()

Method Detail

addPages

public void addPages()

Specified by:

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

Overrides:

addPages in class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

dispose

public void dispose()

Specified by:

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

Overrides:

dispose in class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

getProjectPageTitle

protected String getProjectPageTitle()

Returns the title for the project page that shows the projects that are to be created in the workspace.

Override this method to provide a custom page title.

Returns:

The project page's title

getProjectPageDescription

protected String getProjectPageDescription()

Returns the description for the project page that shows the projects that are to be created in the workspace.

Override this method to provide a custom page description.

Returns:

The project page's description

deleteExistingProjects

protected org.eclipse.emf.common.util.Diagnostic deleteExistingProjects(org.eclipse.core.runtime.IProgressMonitor monitor)

The EMFFormsExampleInstallerWizard doesn't delete any projects.

Overrides:

deleteExistingProjects in class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

Parameters:

monitor - progress monitor

Returns:

OK

installExample

protected void installExample(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
                       throws org.eclipse.core.commands.ExecutionException

In contrast to the AbstractExampleInstallerWizard, the EMFFormsExampleInstallerWizard only installs projects if they do not already exist in the workspace.

Overrides:

installExample in class org.eclipse.emf.common.ui.wizard.AbstractExampleInstallerWizard

Parameters:

progressMonitor - the progress monitor

Throws:

org.eclipse.core.commands.ExecutionException - if something goes wrong while installing the example.

See Also:

AbstractExampleInstallerWizard.installExample(org.eclipse.core.runtime.IProgressMonitor)