01: /*******************************************************************************
02: * Copyright (c) 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.pde.ui;
11:
12: /**
13: * Classes that implement this interface are contributed via the extension point
14: * <code>org.eclipse.pde.ui.pluginContent</code>. The expectation is that
15: * classes also extend JFace Wizard class. This wizard must be used when plug-in
16: * dependencies are to be specified via the Import-Package header of a manifest.mf.
17: * The role of this wizard is to provide additional plug-in content after the
18: * project and the critical plug-in project files have been created.
19: * The wizard is nested in the overall 'New' wizard and can contribute one or
20: * more pages that allow users to configure how this content will be generated.
21: * A typical implementation of this interface would be a template wizard that
22: * populates the plug-in project with content that can be useful right away
23: * (for example, a view or an editor extension).
24: * <p>
25: * Due to the call order of the method <code>performFinish</code> in nested
26: * wizards, classes that implement this interface should not place the code that
27: * generates new content in the implementation of the abstract method
28: * <code>Wizard.performFinish()</code>. Instead, they should simply return
29: * <code>true</code> and have all the real code in <code>performFinish</code>
30: * defined in this interface. This version of the method passes all the context
31: * required for the content generation and is called AFTER the project and vital
32: * plug-in files have been already created.
33: *
34: * @since 3.2
35: */
36: public interface IBundleContentWizard extends IPluginContentWizard {
37:
38: /**
39: * Returns names of packages that are required by this wizard.
40: * This information will be used to compose the Import-Package header of
41: * the manifest.mf being generated, so that the plug-in compiles without
42: * errors in the first build after creation.
43: *
44: * @return an array of package names required by this wizard
45: */
46: String[] getImportPackages();
47:
48: }
|