KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > ui > IExtensionEditorWizard


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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.pde.ui;
12 import org.eclipse.core.resources.IProject;
13 import org.eclipse.jface.viewers.IStructuredSelection;
14 import org.eclipse.pde.core.plugin.IPluginModelBase;
15 /**
16  * An interface for extension editor wizards. Clients should implement this
17  * interface if they are plugging into PDE using
18  * <samp>org.eclipse.pde.ui.newExtension </samp> extension point and want to
19  * register wizards for custom editing of the selected extensions and extension
20  * elements in the plug-in manifest wizard.
21  *
22  * @since 3.0
23  */
24 public interface IExtensionEditorWizard extends IBasePluginWizard {
25     /**
26      * Initializes the wizard with the project of the plug-in and the model
27      * object for the plug-in manifest file. Java code and other resorces should
28      * be created in the source folder under the provided project. Changes in
29      * the plug-in manifest should be made using the APIs of the provided model.
30      * Changing the model will make the model dirty. This will show up in the UI
31      * indicating that the currently opened manifest file is modified and needs
32      * to be saved.
33      * <p>
34      * The wizard is opened on a current selection in the extension tree. It is
35      * supposed to modify the selected element and/or its children using plug-in
36      * model APIs. The setters on the APIs will cause the model to be dirty and
37      * make the editor dirty as well. Saving the editor will commit the changes
38      * made by the wizard to the edited file.
39      *
40      * @param project
41      * the plug-in project resource where the new code and resources
42      * should go
43      * @param pluginModel
44      * the model instance that should be used to modify the plug-in
45      * manifest
46      * @param selection
47      * the currently selected extension or extension element in the
48      * manifest editor extension tree
49      *
50      */
51     public void init(IProject project, IPluginModelBase pluginModel,
52             IStructuredSelection selection);
53 }
54
Popular Tags