plugins/org.eclipse.epf.authoring.ui/src/org/eclipse/epf/authoring/ui/wizards/NewConfigurationWizard.java

//------------------------------------------------------------------------------
// Copyright (c) 2005, 2006 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 implementation
//------------------------------------------------------------------------------
package org.eclipse.epf.authoring.ui.wizards;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.epf.authoring.ui.AuthoringUIPlugin;
import org.eclipse.epf.authoring.ui.AuthoringUIResources;
import org.eclipse.epf.library.LibraryService;
import org.eclipse.epf.library.edit.LibraryEditResources;
import org.eclipse.epf.library.edit.validation.IValidator;
import org.eclipse.epf.library.edit.validation.IValidatorFactory;
import org.eclipse.epf.uma.MethodConfiguration;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.INewWizard;
import org.eclipse.ui.IWorkbench;

/**
 * A wizard that guides the user to create a new Method Configuration.
 * 
 * @author Kelvin Low
 * @author Bingxue Xu
 * @author Phong Nguyen Le
 * @since 1.0
 */
public class NewConfigurationWizard extends Wizard implements INewWizard {

	/**
	 * The wizard ID.
	 */
	public static final String WIZARD_ID = NewConfigurationWizard.class
			.getName();

	protected NewConfigurationMainPage mainPage;

	protected MethodConfiguration config;

	/**
	 * Creates a new instance.
	 */
	public NewConfigurationWizard() {
		super();
		setWindowTitle(AuthoringUIResources.AuthoringUIPlugin_newConfigurationWizard_title); //$NON-NLS-1$
	}

	/**
	 * @see org.eclipse.ui.IWorkbenchWizard#init(IWorkbench,
	 *      IStructuredSelection)
	 */
	public void init(IWorkbench workbench, IStructuredSelection selection) {
		setWindowTitle(AuthoringUIResources.AuthoringUIPlugin_newConfigurationWizard_title); //$NON-NLS-1$		
	}
	
	

	/**
	 * @see org.eclipse.jface.wizard.Wizard#addPages()
	 */
	public void addPages() {
		mainPage = createMainPage();
		addPage(mainPage);
	}

	protected NewConfigurationMainPage createMainPage() {
		return new NewConfigurationMainPage();
	}

	/**
	 * @see org.eclipse.jface.wizard.Wizard#createPageControls(Composite)
	 */
	public void createPageControls(Composite pageContainer) {
		super.createPageControls(pageContainer);
		pageContainer.getShell().setImage(
				AuthoringUIPlugin.getDefault().getSharedImage(
						"full/obj16/MethodConfiguration.gif")); //$NON-NLS-1$
	}

	/**
	 * @see org.eclipse.jface.wizard.IWizard#canFinish()
	 */
	public boolean canFinish() {
		if (LibraryService.getInstance().getCurrentMethodLibrary() == null) {
			return false;
		}
		return super.canFinish();
	}
	
	protected MethodConfiguration createMethodConfiguration() {
		String configName = mainPage.getConfigurationName();
		if (configName != null) {
			try {
				MethodConfiguration config;
				if(this.config == null) {
					config = LibraryService.getInstance()
							.createMethodConfiguration(
									configName,
									LibraryService.getInstance()
											.getCurrentMethodLibrary());
				}
				else {
					config = this.config;
					config.setName(configName);
				}
				String briefDescription = mainPage
						.getConfigurationBriefDescription();
				if (briefDescription != null) {
					config.setBriefDescription(briefDescription);
				}
				
				// 178462	
				String msg = null;
				if (configName.indexOf("&") > -1) {
					msg = NLS
							.bind(
									LibraryEditResources.invalidElementNameError4_msg,
									configName);
				} else {
					IValidator validator = IValidatorFactory.INSTANCE.createNameValidator(config.eContainer(), config);
					msg = validator.isValid(configName);
				}
				if (msg != null) {
					AuthoringUIPlugin
							.getDefault()
							.getMsgDialog()
							.displayError(
									AuthoringUIResources.renameDialog_title, //$NON-NLS-1$
									msg);
					LibraryService.getInstance().getCurrentMethodLibrary().getPredefinedConfigurations().remove(config);
					return null;
				}
				
				return config;
			} catch (Exception e) {
				AuthoringUIPlugin
						.getDefault()
						.getMsgDialog()
						.displayError(
								AuthoringUIResources.AuthoringUIPlugin_newConfigurationWizard_title,
								AuthoringUIResources.internalError_msg, e);
			}
		}
		
		return null;
	}

	/**
	 * @see org.eclipse.jface.wizard.IWizard#performFinish()
	 */
	public boolean performFinish() {
		config = createMethodConfiguration();
		return true;
	}
	
	public MethodConfiguration getMethodConfiguration() {
		return config;
	}
	
	public static NewConfigurationWizard create() {
		NewConfigurationWizard wizard = null;
		
		IWizardRegistry wizardRegistry = WizardHelper.getWizardRegistry();		
		if(wizardRegistry != null) {
			if(wizardRegistry.getNewMethodConfigurationWizardId() != null) {
				try {
					wizard = (NewConfigurationWizard) WizardHelper.createNewWizard(wizardRegistry.getNewMethodConfigurationWizardId());
				} catch (CoreException e) {
					AuthoringUIPlugin.getDefault().getLogger().logError(e);
				}
			}
		}
		if(wizard == null) {
			wizard = new NewConfigurationWizard();
		}
		return wizard;
	}
	
	/**
	 * Sets new method configuration to populate its data user will specify in wizard.
	 * 
	 * @param config
	 */
	public void setMethodConfiguration(MethodConfiguration config) {
		this.config = config;
	}
}