Class BasicNewProjectResourceWizard
java.lang.Object
org.eclipse.jface.wizard.Wizard
org.eclipse.ui.wizards.newresource.BasicNewResourceWizard
org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard
- All Implemented Interfaces:
IExecutableExtension
,IShellProvider
,IWizard
,INewWizard
,IWorkbenchWizard
public class BasicNewProjectResourceWizard
extends BasicNewResourceWizard
implements IExecutableExtension
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.
- Restriction:
- This class is not intended to be subclassed by clients.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The wizard id for creating new projects in the workspace.Fields inherited from class org.eclipse.ui.wizards.newresource.BasicNewResourceWizard
selection
Fields inherited from class org.eclipse.jface.wizard.Wizard
DEFAULT_IMAGE
-
Constructor Summary
ConstructorDescriptionCreates a wizard for creating a new project resource in the workspace. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPages()
TheWizard
implementation of thisIWizard
method does nothing.Returns the newly created project.void
init
(IWorkbench workbench, IStructuredSelection currentSelection) TheBasicNewResourceWizard
implementation of thisIWorkbenchWizard
method records the given workbench and selection, and initializes the default banner image for the pages by callinginitializeDefaultPageImageDescriptor
.protected void
Initializes the default page image descriptor to an appropriate banner.boolean
Subclasses must implement thisIWizard
method to perform any special finish processing for their wizard.void
setInitializationData
(IConfigurationElement cfig, String propertyName, Object data) Stores the configuration element for the wizard.protected void
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 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, getMinimumWizardSize, 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, getMinimumWizardSize, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer
-
Field Details
-
WIZARD_ID
The wizard id for creating new projects in the workspace.- Since:
- 3.4
- See Also:
-
-
Constructor Details
-
BasicNewProjectResourceWizard
public BasicNewProjectResourceWizard()Creates a wizard for creating a new project resource in the workspace.
-
-
Method Details
-
addPages
public void addPages()Description copied from class:Wizard
TheWizard
implementation of thisIWizard
method does nothing. Subclasses should extend if extra pages need to be added before the wizard opens. New pages should be added by callingaddPage
. -
getNewProject
Returns the newly created project.- Returns:
- the created project, or
null
if project not created
-
init
Description copied from class:BasicNewResourceWizard
TheBasicNewResourceWizard
implementation of thisIWorkbenchWizard
method records the given workbench and selection, and initializes the default banner image for the pages by callinginitializeDefaultPageImageDescriptor
. Subclasses may extend.- Specified by:
init
in interfaceIWorkbenchWizard
- Overrides:
init
in classBasicNewResourceWizard
- Parameters:
workbench
- the current workbenchcurrentSelection
- the current object selection
-
initializeDefaultPageImageDescriptor
protected void initializeDefaultPageImageDescriptor()Description copied from class:BasicNewResourceWizard
Initializes the default page image descriptor to an appropriate banner. By callingsetDefaultPageImageDescriptor
. The default implementation of this method uses a generic new wizard image.Subclasses may reimplement.
- Overrides:
initializeDefaultPageImageDescriptor
in classBasicNewResourceWizard
-
performFinish
public boolean performFinish()Description copied from class:Wizard
Subclasses must implement thisIWizard
method to perform any special finish processing for their wizard.- Specified by:
performFinish
in interfaceIWizard
- Specified by:
performFinish
in classWizard
- Returns:
true
to indicate the finish request was accepted, andfalse
to indicate that the finish request was refused
-
setInitializationData
Stores the configuration element for the wizard. The config element will be used inperformFinish
to set the result perspective.- Specified by:
setInitializationData
in interfaceIExecutableExtension
- Parameters:
cfig
- the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration propertiespropertyName
- the name of an attribute of the configuration element used on thecreateExecutableExtension(String)
call. This argument can be used in the cases where a single configuration element is used to define multiple executable extensions.data
- adapter data in the form of aString
, aHashtable
, ornull
.- See Also:
-
updatePerspective
protected void updatePerspective()Updates the perspective for the active page within the window. -
updatePerspective
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'sIConfigurationElement
. That is the configuration element to pass into this method.- Parameters:
configElement
- - the element we are updating with- See Also:
-