ICapabilityUninstallWizard


1   /*******************************************************************************
2    * Copyright (c) 2000, 2004 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.ui;
12  
13  import org.eclipse.core.resources.IProject;
14  import org.eclipse.jface.viewers.IStructuredSelection;
15  import org.eclipse.jface.wizard.IWizard;
16  
17  /**
18   * Interface for project capability uninstall wizard. The wizard is
19   * responsible for collecting any necessary information from the
20   * user and removing this capability's nature. Also must remove natures
21   * from capabilities that the user wants removed - capabilites that this
22   * capability handles the UI for. These other capabilities that the user
23   * wants removed will be provided in the <code>init</code> method.
24   * <p>
25   * The uninstall wizard must only remove natures that are passed in
26   * its <code>init</code> method.
27   * </p><p>
28   * The <code>IProject</code> passed in the init method will exist
29   * and can be queried for the existance of other natures. The
30   * uninstall wizard must <b>not</b> close nor delete the project
31   * passed in the <code>init</code> method. The install wizard must
32   * <b>not</b> rename the project passed in the <code>init</code> method.
33   * </p><p>
34   * The uninstall wizard can change the location of the project if
35   * required, but must inform the user of this action.
36   * </p><p>
37   * Clients should implement this interface and include the name of their class
38   * in an extension contributed to the workbench's capabilities wizard extension point 
39   * (named <code>"org.eclipse.ui.capabilities"</code>).
40   * </p>
41   * <p>
42   * <b>NOTE:</b> This is experimental API, which may be changed or removed at any point
43   * in time. This API should not be called, overridden or otherwise used in production code.
44   * </p>
45   *
46   * @see org.eclipse.jface.wizard.IWizard
47   * @see org.eclipse.ui.ICapabilityInstallWizard
48   * @since 2.0
49   */
50  public interface ICapabilityUninstallWizard extends IWizard {
51  
52      /**
53       * Initializes this capability wizard using the passed workbench,
54       * object selection, project, and nature IDs.
55       * <p>
56       * This method is called after the no argument constructor and
57       * before other methods are called.
58       * </p><p>
59       * The list of nature IDs contains the nature ID for this
60       * capability. Also includes nature IDs for capabilities that
61       * the user wants removed - capabilites that this capability
62       * handles the UI for.
63       * </p>
64       *
65       * @param workbench the current workbench
66       * @param selection the current object selection
67       * @param project the project to configure with a capability
68       * @param natureIds the nature ids to be removed from the project
69       */
70      public void init(IWorkbench workbench, IStructuredSelection selection,
71              IProject project, String  [] natureIds);
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags