KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > ICapabilityInstallWizard


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 install wizard. The wizard is
19  * responsible for collecting any necessary information from the
20  * user.
21  * <p>
22  * The install wizard must only add natures that represent the
23  * capability and any capabilities it handles the UI for. The
24  * install wizard must handle the situation where some or all
25  * of the required capabilites are already installed.
26  * </p><p>
27  * The <code>IProject</code> passed in the init method will exist
28  * and can be queried for the existance of other natures. The
29  * install wizard must <b>not</b> close nor delete the project
30  * passed in the init method. The install wizard must <b>not</b>
31  * rename the project passed in the init method.
32  * </p><p>
33  * The install wizard can change the location of the project if
34  * required, but must inform the user of this action.
35  * </p><p>
36  * Clients should implement this interface and include the name of their class
37  * in an extension contributed to the workbench's capabilities wizard extension point
38  * (named <code>"org.eclipse.ui.capabilities"</code>).
39  * </p>
40  * <p>
41  * <b>NOTE:</b> This is experimental API, which may be changed or removed at any point
42  * in time. This API should not be called, overridden or otherwise used in production code.
43  * </p>
44  *
45  * @see org.eclipse.jface.wizard.IWizard
46  * @see org.eclipse.ui.ICapabilityUninstallWizard
47  * @since 2.0
48  */
49 public interface ICapabilityInstallWizard extends IWizard {
50
51     /**
52      * Initializes this capability wizard using the passed workbench,
53      * object selection, and project.
54      * <p>
55      * This method is called after the no argument constructor and
56      * before other methods are called.
57      * </p>
58      *
59      * @param workbench the current workbench
60      * @param selection the current object selection
61      * @param project the project to configure with a capability
62      */
63     public void init(IWorkbench workbench, IStructuredSelection selection,
64             IProject project);
65 }
66
Popular Tags