/*******************************************************************************
* Copyright (c) 2000, 2008 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.wst.jsdt.ui.wizards;
import java.lang.reflect.InvocationTargetException;
import org.eclipse.core.filesystem.URIUtil;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.WizardNewProjectCreationPage;
import org.eclipse.wst.jsdt.core.IIncludePathEntry;
import org.eclipse.wst.jsdt.core.IJavaScriptProject;
import org.eclipse.wst.jsdt.core.JavaScriptCore;
import org.eclipse.wst.jsdt.internal.ui.IJavaHelpContextIds;
import org.eclipse.wst.jsdt.internal.ui.preferences.NewJavaProjectPreferencePage;
import org.eclipse.wst.jsdt.internal.ui.util.BusyIndicatorRunnableContext;
import org.eclipse.wst.jsdt.internal.ui.wizards.IStatusChangeListener;
import org.eclipse.wst.jsdt.internal.ui.wizards.NewWizardMessages;
import org.eclipse.wst.jsdt.internal.ui.wizards.buildpaths.BuildPathsBlock;
/**
* Standard wizard page for creating new JavaScript projects. This page can be used in
* project creation wizards for projects and will configure the project with the
* JavaScript nature. This page also allows the user to configure the JavaScript project's
* output location for class files generated by the JavaScript builder.
* <p>
* Whenever possible clients should use the class <code>JavaCapabilityConfigurationPage
* </code> in favor of this class.
* </p>
* <p>
* Clients may instantiate or subclass.
* </p>
*
* Provisional API: This class/interface is part of an interim API that is still under development and expected to
* change significantly before reaching stability. It is being made available at this early stage to solicit feedback
* from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
* (repeatedly) as the API evolves.
*/
public class NewJavaProjectWizardPage extends NewElementWizardPage {
private static final String PAGE_NAME= "NewJavaProjectWizardPage"; //$NON-NLS-1$
private WizardNewProjectCreationPage fMainPage;
// private IPath fOutputLocation;
private IIncludePathEntry[] fClasspathEntries;
private BuildPathsBlock fBuildPathsBlock;
private boolean fProjectModified;
/**
* Creates a JavaScript project wizard creation page.
* <p>
* The JavaScript project wizard reads project name and location from the main page.
* </p>
*
* @param root the workspace root
* @param mainpage the main page of the wizard
*/
public NewJavaProjectWizardPage(IWorkspaceRoot root, WizardNewProjectCreationPage mainpage) {
super(PAGE_NAME);
setTitle(NewWizardMessages.NewJavaProjectWizardPage_title);
setDescription(NewWizardMessages.NewJavaProjectWizardPage_description);
fMainPage= mainpage;
IStatusChangeListener listener= new IStatusChangeListener() {
public void statusChanged(IStatus status) {
updateStatus(status);
}
};
fBuildPathsBlock= new BuildPathsBlock(new BusyIndicatorRunnableContext(), listener, 0, false, null);
fProjectModified= true;
// fOutputLocation= null;
fClasspathEntries= null;
}
/*
* @see org.eclipse.jface.dialogs.DialogPage#dispose()
*
*/
public void dispose() {
try {
super.dispose();
} finally {
if (fBuildPathsBlock != null) {
fBuildPathsBlock.dispose();
fBuildPathsBlock= null;
}
}
}
/**
* Sets the default output location to be used for the new JavaScript project.
* This is the path of the folder (with the project) into which the JavaScript builder
* will generate binary class files corresponding to the project's JavaScript source
* files.
* <p>
* The wizard will create this folder if required.
* </p>
* <p>
* The default classpath will be applied when <code>initBuildPaths</code> is
* called. This is done automatically when the page becomes visible and
* the project or the default paths have changed.
* </p>
*
* @param path the folder to be taken as the default output path
*/
public void setDefaultOutputFolder(IPath path) {
// fOutputLocation= path;
setProjectModified();
}
/**
* Sets the default classpath to be used for the new JavaScript project.
* <p>
* The caller of this method is responsible for creating the classpath entries
* for the <code>IJavaScriptProject</code> that corresponds to the created project.
* The caller is responsible for creating any new folders that might be mentioned
* on the classpath.
* </p>
* <p>
* The default output location will be applied when <code>initBuildPaths</code> is
* called. This is done automatically when the page becomes visible and
* the project or the default paths have changed.
* </p>
*
* @param entries the default classpath entries
* @param appendDefaultJRE <code>true</code> a variable entry for the
* default JRE (specified in the preferences) will be added to the classpath.
*/
public void setDefaultClassPath(IIncludePathEntry[] entries, boolean appendDefaultJRE) {
if (entries != null && appendDefaultJRE) {
IIncludePathEntry[] jreEntry= NewJavaProjectPreferencePage.getDefaultJRELibrary();
IIncludePathEntry[] newEntries= new IIncludePathEntry[entries.length + jreEntry.length];
System.arraycopy(entries, 0, newEntries, 0, entries.length);
System.arraycopy(jreEntry, 0, newEntries, entries.length, jreEntry.length);
entries= newEntries;
}
fClasspathEntries= entries;
setProjectModified();
}
/**
* Sets the project state to modified. Doing so will initialize the page
* the next time it becomes visible.
*
*
*/
public void setProjectModified() {
fProjectModified= true;
}
/**
* Returns the project handle. Subclasses should override this
* method if they don't provide a main page or if they provide
* their own main page implementation.
*
* @return the project handle
*/
protected IProject getProjectHandle() {
Assert.isNotNull(fMainPage);
return fMainPage.getProjectHandle();
}
/**
* Returns the project location path. Subclasses should override this
* method if they don't provide a main page or if they provide
* their own main page implementation.
*
* @return the project location path
*/
protected IPath getLocationPath() {
Assert.isNotNull(fMainPage);
return fMainPage.getLocationPath();
}
/**
* Returns the JavaScript project handle by converting the result of
* <code>getProjectHandle()</code> into a JavaScript project.
*
* @return the JavaScript project handle
* @see #getProjectHandle()
*/
public IJavaScriptProject getNewJavaProject() {
return JavaScriptCore.create(getProjectHandle());
}
/* (non-Javadoc)
* @see WizardPage#createControl
*/
public void createControl(Composite parent) {
Composite composite= new Composite(parent, SWT.NONE);
composite.setFont(parent.getFont());
composite.setLayout(new GridLayout(1, false));
Control control= fBuildPathsBlock.createControl(composite);
control.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
Dialog.applyDialogFont(composite);
PlatformUI.getWorkbench().getHelpSystem().setHelp(composite, IJavaHelpContextIds.NEW_JAVAPROJECT_WIZARD_PAGE);
setControl(composite);
}
/**
* Forces the initialization of the JavaScript project page. Default classpath or buildpath
* will be used if set. The initialization should only be performed when the project
* or default paths have changed. Toggling back and forward the pages without
* changes should not re-initialize the page, as changes from the user will be
* overwritten.
*
*
*/
protected void initBuildPaths() {
fBuildPathsBlock.init(getNewJavaProject(), fClasspathEntries);
}
/**
* Extend this method to set a user defined default classpath or output location.
* The method <code>initBuildPaths</code> is called when the page becomes
* visible the first time or the project or the default paths have changed.
*
* @param visible if <code>true</code> the page becomes visible; otherwise
* it becomes invisible
*/
public void setVisible(boolean visible) {
super.setVisible(visible);
if (visible) {
// evaluate if a initialization is required
if (fProjectModified || isNewProjectHandle()) {
// only initialize the project when needed
initBuildPaths();
fProjectModified= false;
}
}
}
private boolean isNewProjectHandle() {
IProject oldProject= fBuildPathsBlock.getJavaProject().getProject();
return !oldProject.equals(getProjectHandle());
}
/**
* Returns the currently configured output location. Note that the returned path
* might not be valid.
*
* @return the configured output location
*
*
*/
public IPath getOutputLocation() {
return fBuildPathsBlock.getOutputLocation();
}
/**
* Returns the currently configured classpath. Note that the classpath might
* not be valid.
*
* @return the configured classpath
*
*
*/
public IIncludePathEntry[] getRawClassPath() {
return fBuildPathsBlock.getRawClassPath();
}
/**
* Returns the runnable that will create the JavaScript project. The runnable will create
* and open the project if needed. The runnable will add the JavaScript nature to the
* project, and set the project's classpath and output location.
* <p>
* To create the new JavaScript project, execute this runnable
* </p>
*
* @return the runnable
*/
public IRunnableWithProgress getRunnable() {
return new IRunnableWithProgress() {
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
if (monitor == null) {
monitor= new NullProgressMonitor();
}
monitor.beginTask(NewWizardMessages.NewJavaProjectWizardPage_op_desc, 10);
// initialize if needed
if (fProjectModified || isNewProjectHandle()) {
initBuildPaths();
}
// create the project
try {
IPath locationPath= getLocationPath();
BuildPathsBlock.createProject(getProjectHandle(),
locationPath != null ? URIUtil.toURI(locationPath) : null,
new SubProgressMonitor(monitor, 2));
BuildPathsBlock.addJavaNature(getProjectHandle(), new SubProgressMonitor(monitor, 2));
fBuildPathsBlock.configureJavaProject(new SubProgressMonitor(monitor, 6));
} catch (CoreException e) {
throw new InvocationTargetException(e);
} catch (OperationCanceledException e) {
throw new InterruptedException();
} finally {
monitor.done();
}
}
};
}
}