public class BasicNewProjectResourceWizard extends BasicNewResourceWizard implements IExecutableExtension
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.
Modifier and Type | Field and Description |
---|---|
static String |
WIZARD_ID
The wizard id for creating new projects in the workspace.
|
selection
DEFAULT_IMAGE
Constructor and Description |
---|
BasicNewProjectResourceWizard()
Creates a wizard for creating a new project resource in the workspace.
|
Modifier and Type | Method and Description |
---|---|
void |
addPages()
The
Wizard implementation of this IWizard
method does nothing. |
IProject |
getNewProject()
Returns the newly created project.
|
void |
init(IWorkbench workbench,
IStructuredSelection currentSelection)
The
BasicNewResourceWizard implementation of this
IWorkbenchWizard method records the given workbench and
selection, and initializes the default banner image for the pages
by calling initializeDefaultPageImageDescriptor . |
protected void |
initializeDefaultPageImageDescriptor()
Initializes the default page image descriptor to an appropriate banner.
|
boolean |
performFinish()
Subclasses must implement this
IWizard 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 |
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.
|
getSelection, getWorkbench, selectAndReveal, selectAndReveal
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer
public static final String WIZARD_ID
public BasicNewProjectResourceWizard()
public void addPages()
Wizard
Wizard
implementation of this IWizard
method does nothing. Subclasses should extend if extra pages need to be
added before the wizard opens. New pages should be added by calling
addPage
.public IProject getNewProject()
null
if project not
createdpublic void init(IWorkbench workbench, IStructuredSelection currentSelection)
BasicNewResourceWizard
BasicNewResourceWizard
implementation of this
IWorkbenchWizard
method records the given workbench and
selection, and initializes the default banner image for the pages
by calling initializeDefaultPageImageDescriptor
.
Subclasses may extend.init
in interface IWorkbenchWizard
init
in class BasicNewResourceWizard
workbench
- the current workbenchcurrentSelection
- the current object selectionprotected void initializeDefaultPageImageDescriptor()
BasicNewResourceWizard
setDefaultPageImageDescriptor
.
The default implementation of this method uses a generic new wizard image.
Subclasses may reimplement.
initializeDefaultPageImageDescriptor
in class BasicNewResourceWizard
public boolean performFinish()
Wizard
IWizard
method to perform
any special finish processing for their wizard.performFinish
in interface IWizard
performFinish
in class Wizard
true
to indicate the finish request
was accepted, and false
to indicate
that the finish request was refusedpublic void setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
performFinish
to set the result perspective.setInitializationData
in interface IExecutableExtension
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 the createExecutableExtension(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 a String
,
a Hashtable
, or null
.IConfigurationElement.createExecutableExtension(String)
protected void updatePerspective()
public static void updatePerspective(IConfigurationElement configElement)
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.
configElement
- -
the element we are updating withIPreferenceConstants.OPM_NEW_WINDOW
,
IPreferenceConstants.OPM_ACTIVE_PAGE
,
IWorkbenchPreferenceConstants.NO_NEW_PERSPECTIVE
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.