blob: b604c59091524f33fef63ff328cb1f24ae7619a5 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.ui.templates;
import java.util.ArrayList;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.*;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.pde.core.plugin.IPluginModelBase;
import org.eclipse.pde.core.plugin.IPluginReference;
import org.eclipse.pde.internal.ui.*;
import org.eclipse.pde.ui.IBundleContentWizard;
import org.eclipse.pde.ui.IFieldData;
/**
* This class is used as a common base for plug-in content wizards that are
* implemented using PDE template support. The assumption is that one or more
* templates will be used to generate plug-in content. Dependencies, new files
* and wizard pages are all computed based on the templates.
*
* @since 2.0
*/
public abstract class AbstractNewPluginTemplateWizard extends Wizard implements IBundleContentWizard {
private IFieldData data;
/**
* Creates a new template wizard.
*/
public AbstractNewPluginTemplateWizard() {
super();
setDialogSettings(PDEPlugin.getDefault().getDialogSettings());
setDefaultPageImageDescriptor(PDEPluginImages.DESC_NEWEXPRJ_WIZ);
setNeedsProgressMonitor(true);
}
/* (non-Javadoc)
* @see org.eclipse.pde.ui.IPluginContentWizard#init(org.eclipse.pde.ui.IFieldData)
*/
public void init(IFieldData data) {
this.data = data;
setWindowTitle(PDEUIMessages.PluginCodeGeneratorWizard_title);
}
/**
* Returns the field data passed to the wizard during the initialization.
*
* @return the parent wizard field data
*/
public IFieldData getData() {
return data;
}
/**
* This wizard adds a mandatory first page. Subclasses implement this method
* to add additional pages to the wizard.
*/
protected abstract void addAdditionalPages();
/**
* Implements wizard method. Subclasses cannot override it.
*/
public final void addPages() {
addAdditionalPages();
}
/* (non-Javadoc)
* @see org.eclipse.jface.wizard.Wizard#performFinish()
*/
public boolean performFinish() {
// do nothing - all the work is in the other 'performFinish'
return true;
}
/**
* Implements the interface method by looping through template sections and
* executing them sequentially.
*
* @param project
* the project
* @param model
* the plug-in model
* @param monitor
* the progress monitor to track the execution progress as part
* of the overall new project creation operation
* @return <code>true</code> if the wizard completed the operation with
* success, <code>false</code> otherwise.
*/
public boolean performFinish(IProject project, IPluginModelBase model, IProgressMonitor monitor) {
try {
ITemplateSection[] sections = getTemplateSections();
monitor.beginTask("", sections.length); //$NON-NLS-1$
for (int i = 0; i < sections.length; i++) {
sections[i].execute(project, model, new SubProgressMonitor(monitor, 1));
}
//No reason to do this any more with the new editors
//saveTemplateFile(project, null);
} catch (CoreException e) {
PDEPlugin.logException(e);
return false;
} finally {
monitor.done();
}
return true;
}
/**
* Returns the template sections used in this wizard.
*
* @return the array of template sections
*/
public abstract ITemplateSection[] getTemplateSections();
/* (non-Javadoc)
* @see org.eclipse.pde.ui.IPluginContentWizard#getDependencies(java.lang.String)
*/
public IPluginReference[] getDependencies(String schemaVersion) {
ArrayList<IPluginReference> result = new ArrayList<IPluginReference>();
ITemplateSection[] sections = getTemplateSections();
for (int i = 0; i < sections.length; i++) {
IPluginReference[] refs = sections[i].getDependencies(schemaVersion);
for (int j = 0; j < refs.length; j++) {
if (!result.contains(refs[j]))
result.add(refs[j]);
}
}
return result.toArray(new IPluginReference[result.size()]);
}
/* (non-Javadoc)
* @see org.eclipse.pde.ui.IPluginContentWizard#getNewFiles()
*/
public String[] getNewFiles() {
ArrayList<String> result = new ArrayList<String>();
ITemplateSection[] sections = getTemplateSections();
for (int i = 0; i < sections.length; i++) {
String[] newFiles = sections[i].getNewFiles();
for (int j = 0; j < newFiles.length; j++) {
if (!result.contains(newFiles[j]))
result.add(newFiles[j]);
}
}
return result.toArray(new String[result.size()]);
}
/**
* Returns whether this wizard has at least one page
* @return whether this wizard has at least one page
*/
public boolean hasPages() {
return getTemplateSections().length > 0;
}
public String[] getImportPackages() {
return new String[0];
}
}
|
