org.povclipse2.wizards

Class BasicNewProjectResourceWizard

java.lang.Object

BasicNewResourceWizard

org.povclipse2.wizards.BasicNewProjectResourceWizard

Direct Known Subclasses:

PovClipseProjectWizard

public class BasicNewProjectResourceWizard
extends BasicNewResourceWizard

Standard workbench wizard that creates a new project resource in the workspace.

This class may be instantiated and used without further configuration; this class is not intended to be subclassed.

Example:

 IWorkbenchWizard wizard = new BasicNewProjectResourceWizard();
 wizard.init(workbench, selection);
 WizardDialog dialog = new WizardDialog(shell, wizard);
 dialog.open();
 

During the call to open, the wizard dialog is presented to the user. When the user hits Finish, a project resource with the user-specified name is created, the dialog closes, and the call to open returns.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WIZARD_ID The wizard id for creating new projects in the workspace.

Constructor Summary

Constructors

Constructor and Description
BasicNewProjectResourceWizard() Creates a wizard for creating a new project resource in the workspace.

Method Summary

Modifier and Type	Method and Description
void	addPages()
WizardNewProjectCreationPage	getMainPage()
IProject	getNewProject() Returns the newly created project.
void	init(IWorkbench workbench, IStructuredSelection currentSelection)
protected void	initializeDefaultPageImageDescriptor()
boolean	performFinish()
void	setInitializationData(IConfigurationElement cfig, java.lang.String propertyName, java.lang.Object data) Stores the configuration element for the wizard.
protected void	updatePerspective() Updates the perspective for the active page within the window.
static void	updatePerspective(IConfigurationElement configElement) Updates the perspective based on the current settings in the Workbench/Perspectives preference page.

Methods inherited from class java.lang.Object

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

Field Detail

WIZARD_ID

public static final java.lang.String WIZARD_ID

The wizard id for creating new projects in the workspace.

Since:

3.4

See Also:

Constant Field Values

Constructor Detail

BasicNewProjectResourceWizard

public BasicNewProjectResourceWizard()

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

Method Detail

getMainPage

public WizardNewProjectCreationPage getMainPage()

addPages

public void addPages()

getNewProject

public IProject getNewProject()

Returns the newly created project.

Returns:

the created project, or null if project not created

init

public void init(IWorkbench workbench,
                 IStructuredSelection currentSelection)

initializeDefaultPageImageDescriptor

protected void initializeDefaultPageImageDescriptor()

performFinish

public boolean performFinish()

setInitializationData

public void setInitializationData(IConfigurationElement cfig,
                                  java.lang.String propertyName,
                                  java.lang.Object data)

Stores the configuration element for the wizard. The config element will be used in performFinish to set the result perspective.

updatePerspective

protected void updatePerspective()

Updates the perspective for the active page within the window.

updatePerspective

public static void updatePerspective(IConfigurationElement configElement)

Updates the perspective based on the current settings in the Workbench/Perspectives preference page. Use the setting for the new perspective opening if we are set to open in a new perspective.

A new project wizard class will need to implement the IExecutableExtension interface so as to gain access to the wizard's IConfigurationElement. That is the configuration element to pass into this method.

Parameters:

configElement - - the element we are updating with

See Also:

IPreferenceConstants#OPM_NEW_WINDOW, IPreferenceConstants#OPM_ACTIVE_PAGE, IWorkbenchPreferenceConstants#NO_NEW_PERSPECTIVE