How To Create Gallery Wizard in Jdev 10.1.3.1?

Question

Folks,
I'm working on an extension that will add a new file extension to JDeveloper. I would my extension to show up in the File/New Gallery. I know that this will involve code in the extension.xml and one or more Java classes.
I've looked at the PHP extension and the extension.xml adds a PHPFileWizard to the File/New Gallery:
     <gallery>
        <item>
          <name>oracle.jdeveloper.addin.php.gallery.PHPFileWizard</name>
          <category>Web Tier</category>
          <folder>PHP</folder>
          <technologyKey>Web</technologyKey>
          <description>${PHP_FILE_DESC}</description>
        </item>
...Presumably PHPFileWizard implements one or more interfaces so that it is a 'legal' Gallery Wizard. Presumably my Java class needs to implement them as well. What are they? :)
David Rolfe
Orinda Software
Dublin, Ireland
Message was edited by:
[email protected]
(edited for clarity)

Answer 1

The Extension SDK comes with a sample called class wizard that shows you how to implement a new wizard.
There is a little error in one of the files there though.
Here is the correct version of that file:
package oracle.jdeveloper.extsamples.classgeneratorwizard;
import java.awt.Dimension;
import java.awt.Image;
import java.io.File;
import java.lang.reflect.Modifier;
import java.net.URL;
import javax.swing.JOptionPane;
import oracle.bali.ewt.wizard.ImageWizardPage;
import oracle.bali.ewt.wizard.Wizard;
import oracle.bali.ewt.wizard.WizardDialog;
import oracle.bali.ewt.wizard.WizardEvent;
import oracle.bali.ewt.wizard.WizardListener;
import oracle.ide.Context;
import oracle.ide.editor.EditorManager;
import oracle.ide.Ide;
import oracle.ide.model.NodeFactory;
import oracle.ide.model.Project;
import oracle.ide.net.URLFactory;
import oracle.ide.util.GraphicsUtils;
import oracle.ide.wizard.WizardWelcomePage;
import oracle.javatools.parser.java.v2.JavaConstants;
import oracle.javatools.parser.java.v2.model.SourceBlock;
import oracle.javatools.parser.java.v2.model.SourceClass;
import oracle.javatools.parser.java.v2.model.SourceFile;
import oracle.javatools.parser.java.v2.model.SourceMethod;
import oracle.javatools.parser.java.v2.SourceFactory;
import oracle.javatools.parser.java.v2.write.SourceTransaction;
import oracle.jdeveloper.java.JavaManager;
import oracle.jdeveloper.java.TransactionDescriptor;
import oracle.jdeveloper.model.JavaProject;
import oracle.jdeveloper.model.JavaSourceNode;
import oracle.jdeveloper.model.PathsConfiguration;
public class RealWizard extends Wizard implements WizardListener {
// In this example, all images are the same. They could be different.
private static final String WIZARD_LEFT_IMAGE_01 = "150x300_Generic.gif";
private static final String WIZARD_LEFT_IMAGE_02 = "150x300_Generic.gif";
private static final String WIZARD_LEFT_IMAGE_03 = "150x300_Generic.gif";
private static final String WIZARD_LEFT_IMAGE_04 = "150x300_Generic.gif";
private Context context;
ImageWizardPage[] wizardPage;
WizardWelcomePage wwp;
ImageWizardPage iwpOne;
ImageWizardPage iwpTwo;
SummaryPage wsp;
/** @snippet_reference {@start WizardContext.2} */
private Model model;
/** @snippet_reference {@end WizardContext.2} */
public
RealWizard(Context ctx) {
this.context = ctx;
this.model = new Model();
this.setPreferredSize(new Dimension(166, 387));
wwp = createWelcomePage();
this.addPage(wwp.getWizardPage());
/** @snippet_reference {@start WizardContext.3} */
iwpOne = createWizardPageOne(model);
this.addPage(iwpOne);
PanelOne panelOne = (PanelOne)iwpOne.getInteractiveArea();
iwpOne.addWizardValidateListener(panelOne);
iwpTwo = createWizardPageTwo(model);
this.addPage(iwpTwo);
PanelTwo panelTwo = (PanelTwo)iwpTwo.getInteractiveArea();
iwpTwo.addWizardValidateListener(panelTwo);
wsp = createSummaryPage(model);
/** @snippet_reference {@start WizardContext.3} */
this.addPage(wsp);
if (!wwp.isHidden())
this.setSelectedPage(wwp.getWizardPage());
else
this.setSelectedPage(iwpOne);
this.setMustFinish(true);
wizardPage =
new ImageWizardPage[] { wwp.getWizardPage(), iwpOne, iwpTwo,
wsp };
// Create wizard Dialog
WizardDialog wDialog = createWizardDialog();
wDialog.setTitle("Create a Java Class");
this.addWizardListener(this);
wDialog.runDialog();
public void wizardApplyState(WizardEvent p0) {
public void wizardCanceled(WizardEvent p0) {
public void wizardFinished(WizardEvent p0) {
try {
// Get Current Project
Project prj = Ide.getActiveProject();
JavaSourceNode jsn = null;
String greeting = this.model.getHelloWord();
String greetee = this.model.getName2Greet();
String className = "Hello" + greetee.replace(' ', '_');
String packageName =
JavaProject.getInstance(prj).getDefaultPackage();
String srcPath =
PathsConfiguration.getInstance(prj).getSourcePath().toString();
String srcDir = "";
if (srcPath.indexOf(File.pathSeparatorChar) > -1)
srcDir =
srcPath.substring(0,
srcPath.indexOf(File.pathSeparatorChar));
else
srcDir = srcPath;
URL dirURL =
new File(srcDir + File.separator + packageName.replace('.',
File.separatorChar)).toURL();
URL classURL = URLFactory.newURL(dirURL, className + ".java");
if (classURL == null) {
JOptionPane.showMessageDialog(null,
"Cannot create URL for " +
className +
".java", "Ooops",
JOptionPane.ERROR_MESSAGE);
} else { // Let's go on
jsn =
(JavaSourceNode)NodeFactory.findOrCreate(JavaSourceNode.class, classURL);
JavaManager javaMgr = JavaManager.getJavaManager(prj);
SourceFile javaFile = javaMgr.getSourceFile(jsn.getURL());
if (javaFile != null) {
JOptionPane.showMessageDialog(null,
"Cannot create URL for " +
className + ".java" + "\n"
+
"Source Already Exists",
"Error",
JOptionPane.ERROR_MESSAGE);
return;
jsn =
(JavaSourceNode)NodeFactory.findOrCreate(JavaSourceNode.class, classURL);
prj.add(jsn, true);
jsn.open();
jsn.save();
// Now the Node is created, let's create its content
boolean success =
createContent(jsn, prj, packageName, className, greeting,
greetee);
if (success) {
jsn.save();
EditorManager.getEditorManager().openDefaultEditorInFrame(jsn.getURL());
} else {
JOptionPane.showMessageDialog(null,
"Cannot create node
content",
"Ooops",
JOptionPane.ERROR_MESSAGE);
} catch (Exception ex) {
ex.printStackTrace();
JOptionPane.showMessageDialog(null, ex.toString(), "Ooops",
JOptionPane.ERROR_MESSAGE);
public void wizardSelectionChanged(WizardEvent wEvent) {
int pageNo = 0;
try {
pageNo = wEvent.getPage().getIndex();
} catch (Exception ignore) {
if (pageNo == 0) // to Welcome
else if (pageNo == 1) {
PanelOne p1 = (PanelOne)iwpOne.getInteractiveArea();
p1.setDefaultValues();
} else if (pageNo == 2) {
PanelTwo p2 = (PanelTwo)iwpTwo.getInteractiveArea();
p2.setDefaultValues();
} else if (pageNo == 3) // to Summary and generation
wsp.enterPage();
private WizardWelcomePage createWelcomePage() {
// This key is used to remember the "Show next time" check box!
final String strShowAgainKey = "SAMPLE_EIGHT_REF";
WizardWelcomePage wp = new WizardWelcomePage(strShowAgainKey);
// Set the image
java.awt.Image img =
GraphicsUtils.loadFromResource(WIZARD_LEFT_IMAGE_01,
this.getClass());
// java.awt.Image img =
GraphicsUtils.createImageIcon(GraphicsUtils.loadFromResource(WIZARD_LEFT_IMAGE
_01, this.getClass())).getImage();
if (img != null)
wp.setImage(img);
else
System.out.println(WIZARD_LEFT_IMAGE_01 + " not found");
// Set the Title
final String welcomeTitle = "Creating a Java Class";
wp.setTitle(welcomeTitle);
// Set the Description Text for first page
final String welcomeDesc =
"This wizard will help you to create a Java Class." + "\n" +
"This is a sample from the JDeveloper Extensions SDK
demonstrating " +
"how to integrate a wizard into the product." + "\n" +
"Press Next to continue\n";
wp.setDescription(welcomeDesc);
// Return results
return wp;
private ImageWizardPage createWizardPageOne(Model m) {
PanelOne panel = new PanelOne(m);
final String title = "A dummy title";
Image img =
GraphicsUtils.createImageIcon(GraphicsUtils.loadFromResource(WIZARD_LEFT_IMAGE
_02,
this.getClass())).getImage();
ImageWizardPage iwp = new ImageWizardPage(panel, img, title);
return iwp;
private ImageWizardPage createWizardPageTwo(Model m) {
PanelTwo panel = new PanelTwo(m);
final String title = "A dummy title";
Image img =
GraphicsUtils.createImageIcon(GraphicsUtils.loadFromResource(WIZARD_LEFT_IMAGE
_03,
this.getClass())).getImage();
ImageWizardPage iwp = new ImageWizardPage(panel, img, title);
return iwp;
private SummaryPage createSummaryPage(Model m) {
Image img =
GraphicsUtils.createImageIcon(GraphicsUtils.loadFromResource(WIZARD_LEFT_IMAGE
_04,
this.getClass())).getImage();
return new SummaryPage(m, img);
private WizardDialog createWizardDialog() {
WizardDialog wdlg = new WizardDialog(this, Ide.getMainWindow());
return wdlg;
private static final boolean createContent(JavaSourceNode node,
Project prj, String
packageName,
String className,
String greeting,
String greetee) {
boolean ret = true;
JavaManager javaMgr = JavaManager.getJavaManager(prj);
SourceFile javaFile = javaMgr.getSourceFile(node.getURL());
final String QUOTE = "\"";
String greet =
QUOTE + greeting + QUOTE + " + \" \" + " + QUOTE + greetee +
QUOTE + " + \"!\"";
//logMessage("Step 1 - Initializing...");
if (javaFile == null)
return false;
//logMessage("Step 2 - Getting Source File...");
SourceTransaction st = javaFile.beginTransaction();
try {
SourceFactory factory = javaFile.getFactory();
javaFile.setPackageName(packageName);
//logMessage("Step 3 - Setting Package Name...");
// Class Description
SourceClass helloClass = factory.createClass(0, className);
helloClass.addSelf(javaFile);
helloClass.setModifiers(Modifier.PUBLIC);
//logMessage("Step 4 - Setting Class Name...");
// Create main method
SourceBlock block = factory.createBlock();
SourceMethod meth =
factory.createMethod(factory.createType(JavaConstants.PRIMITIVE_VOID),
"main",
factory.createFormalParameterList(factory.createLocalVariable(factory.createTy
pe("String",
1),
"args")),
null,
(SourceBlock)factory.createBlock("\n\n{\n\n\t" +
"System.out.println(" +
greet +
");" +
"\n\t}"));
meth.setModifiers(Modifier.PUBLIC | Modifier.STATIC);
meth.addSelf(helloClass);
//logMessage("Step 5 - Creating Main Method...");
// Write the file
javaMgr.commitTransaction(st,
new TransactionDescriptor("Generate
file"));
//logMessage("Step 6 - Commiting Work...");
} catch (Exception e) {
st.abort();
//logMessage(e.getMessage());
ret = false;
return ret;
}