|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.wizard.Wizard
org.eclipse.ui.wizards.newresource.BasicNewResourceWizard
org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard
public class BasicNewProjectResourceWizard
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 | |
|---|---|
static java.lang.String |
WIZARD_ID
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 | |
|---|---|
BasicNewProjectResourceWizard()
Creates a wizard for creating a new project resource in the workspace. |
|
| Method Summary | |
|---|---|
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,
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 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 |
|---|
public static final java.lang.String WIZARD_ID
| Constructor Detail |
|---|
public BasicNewProjectResourceWizard()
| Method Detail |
|---|
public void addPages()
WizardWizard 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.
addPages in interface IWizardaddPages in class Wizardpublic IProject getNewProject()
null if project not
created
public void init(IWorkbench workbench,
IStructuredSelection currentSelection)
BasicNewResourceWizardBasicNewResourceWizard 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 IWorkbenchWizardinit in class BasicNewResourceWizardworkbench - the current workbenchcurrentSelection - the current object selectionprotected void initializeDefaultPageImageDescriptor()
BasicNewResourceWizardsetDefaultPageImageDescriptor.
The default implementation of this method uses a generic new wizard image.
Subclasses may reimplement.
initializeDefaultPageImageDescriptor in class BasicNewResourceWizardpublic boolean performFinish()
WizardIWizard method to perform
any special finish processing for their wizard.
performFinish in interface IWizardperformFinish in class Wizardtrue to indicate the finish request
was accepted, and false to indicate
that the finish request was refused
public void setInitializationData(IConfigurationElement cfig,
java.lang.String propertyName,
java.lang.Object data)
performFinish to set the result perspective.
setInitializationData in interface IExecutableExtensioncfig - 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
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.