bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/dialogs/NewWizard.java

package org.eclipse.ui.internal.dialogs;

/************************************************************************
Copyright (c) 2000, 2003 IBM Corporation and others.
All rights reserved.   This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/cpl-v10.html

Contributors:
    IBM - Initial implementation
************************************************************************/

import java.util.StringTokenizer;

import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.internal.*;
import org.eclipse.ui.internal.registry.NewWizardsRegistryReader;

/**
 * The new wizard is responsible for allowing the user to choose which
 * new (nested) wizard to run. The set of available new wizards comes
 * from the new extension point.
 */
public class NewWizard extends Wizard {
	private static final String CATEGORY_SEPARATOR = "/"; //$NON-NLS-1$

	private IWorkbench workbench;
	private IStructuredSelection selection;
	private NewWizardSelectionPage mainPage;
	private boolean projectsOnly = false;
	private String categoryId = null;
	/**
	 * Create the wizard pages
	 */
	public void addPages() {
		NewWizardsRegistryReader rdr =
			new NewWizardsRegistryReader(projectsOnly);
		WizardCollectionElement wizards =
			(WizardCollectionElement) rdr.getWizards();

		if (categoryId != null) {
			WizardCollectionElement categories = wizards;
			StringTokenizer familyTokenizer =
				new StringTokenizer(categoryId, CATEGORY_SEPARATOR);
			while (familyTokenizer.hasMoreElements()) {
				categories =
					getChildWithID(categories, familyTokenizer.nextToken());
				if (categories == null)
					break;
			}
			if (categories != null)
				wizards = categories;
		}

		mainPage =
			new NewWizardSelectionPage(this.workbench, this.selection, wizards);
		addPage(mainPage);
	}
	/**
	 * Returns the child collection element for the given id
	 */
	private WizardCollectionElement getChildWithID(
		WizardCollectionElement parent,
		String id) {
		Object[] children = parent.getChildren();
		for (int i = 0; i < children.length; ++i) {
			WizardCollectionElement currentChild =
				(WizardCollectionElement) children[i];
			if (currentChild.getId().equals(id))
				return currentChild;
		}
		return null;
	}
	/**
	 * Returns the id of the category of wizards to show
	 * or <code>null</code> to show all categories.
	 * If no entries can be found with this id then all 
	 * categories are shown.
	 * @return String or <code>null</code>.
	 */
	public String getCategoryId() {
		return categoryId;
	}
	/**
	 * Sets the id of the category of wizards to show
	 * or <code>null</code> to show all categories.
	 * If no entries can be found with this id then all
	 * categories are shown.
	 * @param id. String or <code>null</code>.
	 */
	public void setCategoryId(String id) {
		categoryId = id;
	}
	/**
	 *	Lazily create the wizards pages
	 */
	public void init(
		IWorkbench aWorkbench,
		IStructuredSelection currentSelection) {
		this.workbench = aWorkbench;
		this.selection = currentSelection;

		if (projectsOnly)
			setWindowTitle(WorkbenchMessages.getString("NewProject.title")); //$NON-NLS-1$
		else
			setWindowTitle(WorkbenchMessages.getString("NewWizard.title")); //$NON-NLS-1$
		setDefaultPageImageDescriptor(
			WorkbenchImages.getImageDescriptor(
				IWorkbenchGraphicConstants.IMG_WIZBAN_NEW_WIZ));
		setNeedsProgressMonitor(true);
	}
	/**
	 *	The user has pressed Finish.  Instruct self's pages to finish, and
	 *	answer a boolean indicating success.
	 *
	 *	@return boolean
	 */
	public boolean performFinish() {
		//save our selection state
		mainPage.saveWidgetValues();
		return true;
	}
	/**
	 * Sets the projects only flag.  If <code>true</code> only projects will
	 * be shown in this wizard.
	 */
	public void setProjectsOnly(boolean b) {
		projectsOnly = b;
	}
}