Package org.eclipse.ui.wizards.newresource

Class BasicNewFileResourceWizard

java.lang.Object

org.eclipse.jface.wizard.Wizard

org.eclipse.ui.wizards.newresource.BasicNewResourceWizard

org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard

All Implemented Interfaces:

IShellProvider, IWizard, INewWizard, IWorkbenchWizard

public class BasicNewFileResourceWizard
extends BasicNewResourceWizard

Standard workbench wizard that create a new file 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 BasicNewFileResourceWizard();
 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 file resource at the user-specified workspace path is created, the dialog closes, and the call to open returns.

Restriction:

This class is not intended to be subclassed by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WIZARD_ID	The wizard id for creating new files 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

Constructors

Constructor	Description
BasicNewFileResourceWizard()	Creates a wizard for creating a new file resource in the workspace.

Method Summary

Modifier and Type	Method	Description
void	addPages()	The Wizard implementation of this IWizard method does nothing.
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.

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

public static final String WIZARD_ID

The wizard id for creating new files in the workspace.

Since:

3.4

See Also:

• Constant Field Values

Constructor Details

BasicNewFileResourceWizard

public BasicNewFileResourceWizard()

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

Method Details

addPages

public void addPages()

Description copied from class: Wizard

The 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.

Specified by:

addPages in interface IWizard

Overrides:

addPages in class Wizard

init

public void init(IWorkbench workbench,
 IStructuredSelection currentSelection)

Description copied from class: BasicNewResourceWizard

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. Subclasses may extend.

Specified by:

init in interface IWorkbenchWizard

Overrides:

init in class BasicNewResourceWizard

Parameters:

workbench - the current workbench

currentSelection - the current object selection

initializeDefaultPageImageDescriptor

protected void initializeDefaultPageImageDescriptor()

Description copied from class: BasicNewResourceWizard

Initializes the default page image descriptor to an appropriate banner. By calling setDefaultPageImageDescriptor. The default implementation of this method uses a generic new wizard image.

Subclasses may reimplement.

Overrides:

initializeDefaultPageImageDescriptor in class BasicNewResourceWizard

performFinish

public boolean performFinish()

Description copied from class: Wizard

Subclasses must implement this IWizard method to perform any special finish processing for their wizard.

Specified by:

performFinish in interface IWizard

Specified by:

performFinish in class Wizard

Returns:

true to indicate the finish request was accepted, and false to indicate that the finish request was refused