bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/actions/CreateProjectAction.java

/*******************************************************************************
 * Copyright (c) 2000, 2005 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.ui.actions;

import java.util.ArrayList;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.ide.Category;
import org.eclipse.ui.internal.ide.IDEWorkbenchMessages;
import org.eclipse.ui.internal.ide.IDEWorkbenchPlugin;
import org.eclipse.ui.internal.ide.IIDEHelpContextIds;
import org.eclipse.ui.internal.ide.dialogs.MultiStepWizardDialog;
import org.eclipse.ui.internal.ide.dialogs.NewProjectWizard;
import org.eclipse.ui.internal.ide.registry.Capability;
import org.eclipse.ui.internal.ide.registry.CapabilityRegistry;

/**
 * Standard action for launching the new project creation
 * wizard.
 * <p>
 * This class may be instantiated and subclassed by clients.
 * </p>
 * @deprecated This new experimental API is being temporary
 * 		deprecated for release 2.0  New project creation should
 * 		continue to make use of NewProjectAction.
 */
public class CreateProjectAction extends Action {
    /**
     * The wizard dialog width
     */
    private static final int SIZING_WIZARD_WIDTH = 500;

    /**
     * The wizard dialog height
     */
    private static final int SIZING_WIZARD_HEIGHT = 500;

    /**
     * The workbench window this action will run in
     */
    private IWorkbenchWindow window;

    /**
     * The suggested name for the new project
     */
    private String initialProjectName;

    /**
     * The suggested capabilities for the new project
     */
    private Capability[] initialProjectCapabilities;

    /**
     * The suggested categories to be selected
     */
    private Category[] initialSelectedCategories;

    /**
     * Creates a new action for launching the new project
     * selection wizard.
     *
     * @param window the workbench window to query the current
     * 		selection and shell for opening the wizard.
     */
    public CreateProjectAction(IWorkbenchWindow window) {
        super(IDEWorkbenchMessages.CreateProjectAction_text);
        if (window == null) {
            throw new IllegalArgumentException();
        }
        this.window = window;
        ISharedImages images = PlatformUI.getWorkbench().getSharedImages();
        setImageDescriptor(images
                .getImageDescriptor(ISharedImages.IMG_TOOL_NEW_WIZARD));
        setDisabledImageDescriptor(images
                .getImageDescriptor(ISharedImages.IMG_TOOL_NEW_WIZARD_DISABLED));
        setToolTipText(IDEWorkbenchMessages.CreateProjectAction_toolTip);
        PlatformUI.getWorkbench().getHelpSystem().setHelp(this,
				org.eclipse.ui.internal.IWorkbenchHelpContextIds.NEW_ACTION);
    }

    /**
     * Returns the selection to initialized the wizard with
     */
    protected IStructuredSelection getInitialSelection() {
        ISelection selection = window.getSelectionService().getSelection();
        IStructuredSelection selectionToPass = StructuredSelection.EMPTY;
        if (selection instanceof IStructuredSelection)
            selectionToPass = (IStructuredSelection) selection;
        return selectionToPass;
    }

    /**
     * Sets the initial categories to be selected. Ignores
     * any IDs which do not represent valid categories.
     * 
     * @param ids initial category ids to select
     */
    public void setInitialSelectedCategories(String[] ids) {
        if (ids == null || ids.length == 0)
            initialSelectedCategories = null;
        else {
            CapabilityRegistry reg = IDEWorkbenchPlugin.getDefault()
                    .getCapabilityRegistry();
            ArrayList results = new ArrayList(ids.length);
            for (int i = 0; i < ids.length; i++) {
                Category cat = reg.findCategory(ids[i]);
                if (cat != null)
                    results.add(cat);
            }
            if (results.isEmpty())
                initialSelectedCategories = null;
            else {
                initialSelectedCategories = new Category[results.size()];
                results.toArray(initialSelectedCategories);
            }
        }
    }

    /**
     * Sets the initial project capabilities to be selected.
     * Ignores any IDs which do not represent valid capabilities.
     * 
     * @param ids initial project capability ids to select
     */
    public void setInitialProjectCapabilities(String[] ids) {
        if (ids == null || ids.length == 0)
            initialProjectCapabilities = null;
        else {
            CapabilityRegistry reg = IDEWorkbenchPlugin.getDefault()
                    .getCapabilityRegistry();
            ArrayList results = new ArrayList(ids.length);
            for (int i = 0; i < ids.length; i++) {
                Capability cap = reg.findCapability(ids[i]);
                if (cap != null && cap.isValid())
                    results.add(cap);
            }
            if (results.isEmpty())
                initialProjectCapabilities = null;
            else {
                initialProjectCapabilities = new Capability[results.size()];
                results.toArray(initialProjectCapabilities);
            }
        }
    }

    /**
     * Sets the initial project name. Leading and trailing
     * spaces in the name are ignored.
     * 
     * @param name initial project name
     */
    public void setInitialProjectName(String name) {
        if (name == null)
            initialProjectName = null;
        else
            initialProjectName = name.trim();
    }

    /* (non-Javadoc)
     * Method declared on IAction.
     */
    public void run() {
        // Create a new project wizard 
        NewProjectWizard wizard = new NewProjectWizard();
        wizard.init(window.getWorkbench(), getInitialSelection());
        wizard.setInitialProjectName(initialProjectName);
        wizard.setInitialProjectCapabilities(initialProjectCapabilities);
        wizard.setInitialSelectedCategories(initialSelectedCategories);

        // Create a wizard dialog.
        WizardDialog dialog = new MultiStepWizardDialog(window.getShell(),
                wizard);
        dialog.create();
        dialog.getShell().setSize(
                Math.max(SIZING_WIZARD_WIDTH, dialog.getShell().getSize().x),
                SIZING_WIZARD_HEIGHT);
        PlatformUI.getWorkbench().getHelpSystem().setHelp(dialog.getShell(),
                IIDEHelpContextIds.NEW_PROJECT_WIZARD);

        // Open the wizard.
        dialog.open();
    }
}