<change id="adding-TemplateWizardFactory">

             <api name="general"/>

             <summary>Adding TemplateWizardFactory and TemplateWizardProvider</summary>

             <version major="1" minor="3"/>

             <date day="25" month="9" year="2011"/>

             <author login="jhorvath"/>

             <compatibility binary="compatible" modification="yes" semantic="compatible" source="compatible"/>

             <description>

                 Adding TemplateWizardFactory and TemplateWizardProvider to allow template wizards 

                 to have a single entry point in JDev and NetBeans.

             </description>

             <class package="org.netbeans.modules.java.source.queries.api" name="TemplateWizardFactory"/>

             <class package="org.netbeans.modules.java.source.queries.spi" name="TemplateWizardProvider"/>

             <issue number="202516"/>

        </change>

                    <code-name-base>org.openide.dialogs</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.23</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2011 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.source.queries.api;

import org.netbeans.modules.java.source.queries.spi.TemplateWizardProvider;

import org.openide.WizardDescriptor;

import org.openide.util.Lookup;

/**

 *

 * @author jhorvath

 */

public class TemplateWizardFactory {

    static TemplateWizardProvider provider = null;

    private TemplateWizardFactory () {

    }

    /**

     * Returns an {@link WizardDescriptor.InstantiatingIterator} for template wizard

     * @return an {@link WizardDescriptor.InstantiatingIterator} 

     */

    public static WizardDescriptor.InstantiatingIterator<WizardDescriptor> create() {

        return getProvider().createWizard();

    }

    /**

     * Returns an {@link WizardDescriptor.InstantiatingIterator} for template wizard,

     * with editable superclass

     * @return an {@link WizardDescriptor.InstantiatingIterator} 

     */

    public static WizardDescriptor.InstantiatingIterator<WizardDescriptor> createForSuperClass() {

        return getProvider().createWizardForSuperClass();

    }

    private static TemplateWizardProvider getProvider() {

        if (provider == null) {

            provider = Lookup.getDefault().lookup(TemplateWizardProvider.class);

            if (provider == null) {

                throw new IllegalStateException("No TemplateWizardProvider found in the Lookup");    //NOI18N

            }

        }

        return provider;

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2011 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.source.queries.spi;

import org.openide.WizardDescriptor;

/**

 *

 * @author jhorvath

 */

public interface TemplateWizardProvider {

    /**

     * Returns an {@link WizardDescriptor.InstantiatingIterator} for template wizard

     * @return an {@link WizardDescriptor.InstantiatingIterator} 

     */

    public WizardDescriptor.InstantiatingIterator<WizardDescriptor> createWizard();

    /**

     * Returns an {@link WizardDescriptor.InstantiatingIterator} for template wizard,

     * with editable superclass

     * @return an {@link WizardDescriptor.InstantiatingIterator} 

     */

    public WizardDescriptor.InstantiatingIterator<WizardDescriptor> createWizardForSuperClass();

}

                    <code-name-base>org.netbeans.api.annotations.common</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>1.10</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.dialogs</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.23</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.loaders</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.32</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.nodes</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.25</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.util</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>8.18</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

CTL_SuperclassTitle=Form Superclass

CTL_SuperclassName=Superclass:

CTL_SuperclassName_Hint=Fully qualified name of the superclass of the new form

ACSD_SuperclassPanel=N/A

ACSD_SuperclassTextField=N/A

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2011 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.source.queriesimpl;

import org.netbeans.modules.java.source.queries.spi.TemplateWizardProvider;

import org.openide.WizardDescriptor;

import org.openide.util.lookup.ServiceProvider;

/**

 *

 * @author jhorvath

 */

@ServiceProvider(service=TemplateWizardProvider.class, position=200)

public class NbTemplateWizardProviderImpl implements TemplateWizardProvider {

    @Override

    public WizardDescriptor.InstantiatingIterator createWizard() {

        return TemplateWizardIterator.create();

    }

    @Override

    public WizardDescriptor.InstantiatingIterator createWizardForSuperClass() {

        return TemplateWizardIterator.createForSuperclass();

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.modules.java.source.queriesimpl;

import com.sun.source.tree.ClassTree;

import com.sun.source.tree.ExpressionTree;

import com.sun.source.tree.Tree;

import java.awt.Component;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.awt.event.FocusAdapter;

import java.io.IOException;

import java.util.NoSuchElementException;

import java.util.ResourceBundle;

import java.util.Set;

import java.util.logging.Level;

import java.util.logging.LogRecord;

import java.util.logging.Logger;

import javax.lang.model.element.TypeElement;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JTextField;

import javax.swing.event.ChangeListener;

import org.netbeans.api.java.source.CancellableTask;

import org.netbeans.api.java.source.JavaSource;

import org.netbeans.api.java.source.TreeMaker;

import org.netbeans.api.java.source.TreeUtilities;

import org.netbeans.api.java.source.WorkingCopy;

import org.netbeans.modules.java.source.queries.spi.TemplateWizardProvider;

import org.netbeans.spi.java.project.support.ui.templates.JavaTemplates;

import org.openide.WizardDescriptor;

import org.openide.filesystems.FileObject;

import org.openide.loaders.TemplateWizard;

import org.openide.util.NbBundle;

import org.openide.util.lookup.ServiceProvider;

/**

 * Special template wizard iterator for BeanForm template - requires to

 * specify superclass additionally.

 *

 * @author Tomas Pavek, Jan Stola

 */

public class TemplateWizardIterator implements WizardDescriptor.InstantiatingIterator {

    private transient WizardDescriptor wiz;

    private transient WizardDescriptor.Panel superclassPanel;

    private transient boolean superclassPanelCurrent;

    private transient WizardDescriptor.InstantiatingIterator delegateIterator;

    private boolean specifySuperclass;

    public static TemplateWizardIterator createForSuperclass() {

        return new TemplateWizardIterator(true);

    }

    public static TemplateWizardIterator create() {

        return new TemplateWizardIterator(false);

    }

    public TemplateWizardIterator(boolean specifySuperclass) {

        delegateIterator = JavaTemplates.createJavaTemplateIterator();

        this.specifySuperclass = specifySuperclass;

    }

    @Override

    public void initialize(WizardDescriptor wizard) {

        wiz = wizard;

        delegateIterator.initialize(wizard);

        superclassPanelCurrent = false;

        if (superclassPanel == null && specifySuperclass) {

            superclassPanel = new SuperclassWizardPanel();

            ResourceBundle bundle = NbBundle.getBundle(TemplateWizardIterator.class);

            JComponent comp = (JComponent)delegateIterator.current().getComponent();

            String[] contentData = (String[])comp.getClientProperty(WizardDescriptor.PROP_CONTENT_DATA); // NOI18N

            String[] newContentData = new String[contentData.length+1];

            System.arraycopy(contentData, 0, newContentData, 0, contentData.length);

            newContentData[contentData.length] = bundle.getString("CTL_SuperclassTitle"); // NOI18N

            comp.putClientProperty(WizardDescriptor.PROP_CONTENT_DATA, newContentData); // NOI18N

        }    

    }

    @Override

    public void uninitialize(WizardDescriptor wizard) {

        delegateIterator.uninitialize(wizard);

        superclassPanel = null;

    }

    @Override

    public Set instantiate() throws IOException, IllegalArgumentException {

        Set set = delegateIterator.instantiate();

        FileObject template = (FileObject) set.iterator().next();

        if (wiz instanceof TemplateWizard) {

            Logger logger = Logger.getLogger("org.netbeans.ui.metrics.form"); // NOI18N

            LogRecord rec = new LogRecord(Level.INFO, "USG_FORM_CREATED"); // NOI18N

            rec.setLoggerName(logger.getName());

            rec.setParameters(new Object[] { ((TemplateWizard)wiz).getTemplate().getName() });

            logger.log(rec);

        }

        if (specifySuperclass) {

            final String className = template.getName();

            final String superclassName = 

                    ((SuperclassWizardPanel) superclassPanel).getSuperclassName();           

            JavaSource js = JavaSource.forFileObject(template);

            js.runModificationTask(new CancellableTask<WorkingCopy>() {

                @Override

                public void cancel() {

                }

                @Override

                public void run(WorkingCopy wcopy) throws Exception {

                    wcopy.toPhase(JavaSource.Phase.RESOLVED);

                    for (Tree t: wcopy.getCompilationUnit().getTypeDecls()) {

                        if (TreeUtilities.CLASS_TREE_KINDS.contains(t.getKind()) && className.equals(((ClassTree) t).getSimpleName().toString())) {

                            ClassTree orig = (ClassTree) t;

                            TreeMaker maker = wcopy.getTreeMaker();

                            TypeElement superclassElm = wcopy.getElements().getTypeElement(superclassName);

                            ExpressionTree extendsTree = superclassElm != null

                                ? maker.QualIdent(superclassElm)

                                : maker.Identifier(superclassName);

                            ClassTree copy = maker.Class(

                                orig.getModifiers(),

                                orig.getSimpleName(),

                                orig.getTypeParameters(),

                                extendsTree,

                                orig.getImplementsClause(),

                                orig.getMembers());

                            wcopy.rewrite(orig, copy);

                            break;

                        }

                    }

                }

            }).commit();

        }

        template.setAttribute("justCreatedByNewWizard", Boolean.TRUE); // NOI18N

        return set;

    }

    @Override

    public WizardDescriptor.Panel current() {

        return superclassPanelCurrent ? superclassPanel : delegateIterator.current();

    }

    @Override

    public boolean hasNext() {

        return delegateIterator.hasNext() || (!superclassPanelCurrent && superclassPanel != null);

    }

    @Override

    public boolean hasPrevious() {

        return superclassPanelCurrent ? true : delegateIterator.hasPrevious();

    }

    @Override

    public void nextPanel() {

        if (delegateIterator.hasNext()) {

            delegateIterator.nextPanel();

        } else {

            if (superclassPanelCurrent || superclassPanel == null) {

                throw new NoSuchElementException();

            } else {

                superclassPanelCurrent = true;

            }

        }

    }

    @Override

    public void previousPanel() {

        if (superclassPanelCurrent) {

            superclassPanelCurrent = false;

        } else {

            delegateIterator.previousPanel();

        }

    }

    @Override

    public void addChangeListener(ChangeListener l) {

        delegateIterator.addChangeListener(l);

    }

    @Override

    public String name() {

        return superclassPanelCurrent ? "" : delegateIterator.name(); // NOI18N

    }

    @Override

    public void removeChangeListener(ChangeListener l) {

        delegateIterator.removeChangeListener(l);

    }

    // ---------

    static class SuperclassWizardPanel implements WizardDescriptor.FinishablePanel {

        private SuperclassPanel panelUI;

        String getSuperclassName() {

            String name = panelUI != null ?

                          panelUI.superclassTextField.getText() : null;

            return name != null && !"".equals(name) ? name : "java.lang.Object"; // NOI18N

        }

        @Override

        public Component getComponent() {

            if (panelUI == null)

                panelUI = new SuperclassPanel();

            return panelUI;

        }

        @Override

        public boolean isValid() {

            return true;

        }

        @Override

        public void readSettings(Object settings) {

        }

        @Override

        public void storeSettings(Object settings) {

        }

        @Override

        public void addChangeListener(ChangeListener l) {

        }

        @Override

        public void removeChangeListener(ChangeListener l) {

        }

        @Override

        public org.openide.util.HelpCtx getHelp () {

            return new org.openide.util.HelpCtx("gui.creatingforms"); // NOI18N

        }

        @Override

        public boolean isFinishPanel() {

            return true;

        }

    }

    // -------

    static class SuperclassPanel extends javax.swing.JPanel {

        SuperclassPanel() {

            ResourceBundle bundle = NbBundle.getBundle(TemplateWizardIterator.class);

            setName(bundle.getString("CTL_SuperclassTitle")); // NOI18N

            putClientProperty(WizardDescriptor.PROP_CONTENT_SELECTED_INDEX, new Integer(1)); //NOI18N

            getAccessibleContext()

                .setAccessibleDescription(bundle.getString("ACSD_SuperclassPanel")); // NOI18N

            setLayout(new GridBagLayout());

            setBorder(new javax.swing.border.EmptyBorder(8, 8, 8, 8));

            label1 = new JLabel();

            superclassTextField = new JTextField();

            label1.setLabelFor(superclassTextField);

            label1.setText(bundle.getString("CTL_SuperclassName")); // NOI18N

            GridBagConstraints gridBagConstraints = new GridBagConstraints();

            gridBagConstraints.gridx = 0;

            gridBagConstraints.gridy = 0;

            gridBagConstraints.anchor = GridBagConstraints.WEST;

            gridBagConstraints.insets = new Insets(0, 0, 0, 12);

            add(label1, gridBagConstraints);

            superclassTextField.setText("java.lang.Object"); // NOI18N

            superclassTextField.setToolTipText(bundle.getString("CTL_SuperclassName_Hint")); // NOI18N

            superclassTextField.getAccessibleContext()

                .setAccessibleDescription(bundle.getString("ACSD_SuperclassTextField"));  // NOI18N

            superclassTextField.addFocusListener(new FocusAdapter() {

                @Override

                public void focusGained(java.awt.event.FocusEvent evt) {

                    superclassTextField.selectAll();

                }

            });

            gridBagConstraints = new GridBagConstraints();

            gridBagConstraints.gridx = 1;

            gridBagConstraints.gridy = 0;

            gridBagConstraints.gridwidth = GridBagConstraints.REMAINDER;

            gridBagConstraints.fill = GridBagConstraints.HORIZONTAL;

            gridBagConstraints.weightx = 1.0;

            gridBagConstraints.weighty = 1.0;

            add(superclassTextField, gridBagConstraints);

        }

        @Override

        public void addNotify() {

            super.addNotify();

            superclassTextField.requestFocus();

        }

        private JLabel label1;

        private JTextField superclassTextField;

    }

}