Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui
Interface ICapabilityUninstallWizard

All Superinterfaces:

IWizard

public interface ICapabilityUninstallWizard

extends IWizard

Interface for project capability uninstall wizard. The wizard is responsible for collecting any necessary information from the user and removing this capability's nature. Also must remove natures from capabilities that the user wants removed - capabilites that this capability handles the UI for. These other capabilities that the user wants removed will be provided in the init method.

The uninstall wizard must only remove natures that are passed in its init method.

The IProject passed in the init method will exist and can be queried for the existance of other natures. The uninstall wizard must not close nor delete the project passed in the init method. The install wizard must not rename the project passed in the init method.

The uninstall wizard can change the location of the project if required, but must inform the user of this action.

Clients should implement this interface and include the name of their class in an extension contributed to the workbench's capabilities wizard extension point (named "org.eclipse.ui.capabilities").

NOTE: This is experimental API, which may be changed or removed at any point in time. This API should not be called, overridden or otherwise used in production code.

Since:

2.0

See Also:

IWizard, ICapabilityInstallWizard

Method Summary

void	init(IWorkbench workbench, IStructuredSelection selection, IProject project, String[] natureIds) Initializes this capability wizard using the passed workbench, object selection, project, and nature IDs.

Methods inherited from interface org.eclipse.jface.wizard.IWizard

addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer

Method Detail

init

public void init(IWorkbench workbench,
                 IStructuredSelection selection,
                 IProject project,
                 String[] natureIds)

Initializes this capability wizard using the passed workbench, object selection, project, and nature IDs.

This method is called after the no argument constructor and before other methods are called.

The list of nature IDs contains the nature ID for this capability. Also includes nature IDs for capabilities that the user wants removed - capabilites that this capability handles the UI for.

Parameters:

workbench - the current workbench

selection - the current object selection

project - the project to configure with a capability

natureIds - the nature ids to be removed from the project