|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectWizardPage
org.eclipse.wst.jsdt.ui.wizards.NewElementWizardPage
org.eclipse.wst.jsdt.ui.wizards.JavaCapabilityConfigurationPage
public class JavaCapabilityConfigurationPage
Standard wizard page for creating new JavaScript projects. This page can be used in project creation wizards. The page shows UI to configure the project with a JavaScript build path and output location. On finish the page will also configure the JavaScript nature.
This is a replacement for NewJavaProjectWizardPage
with a cleaner API.
Clients may instantiate or subclass.
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.
Constructor Summary | |
---|---|
JavaCapabilityConfigurationPage()
Creates a wizard page that can be used in a JavaScript project creation wizard. |
Method Summary | |
---|---|
void |
configureJavaProject(IProgressMonitor monitor)
Adds the JavaScript nature to the project (if not set yet) and configures the build classpath. |
void |
createControl(Composite parent)
|
static void |
createProject(IProject project,
java.net.URI locationURI,
IProgressMonitor monitor)
Helper method to create and open a IProject. |
void |
dispose()
|
IJavaScriptProject |
getJavaProject()
Returns the JavaScript project that was passed in #init(IJavaScriptProject, IPath, IIncludePathEntry[], boolean) or null if the
page has not been initialized yet. |
IPath |
getOutputLocation()
Returns the currently configured output location. |
IIncludePathEntry[] |
getRawClassPath()
Returns the currently configured classpath. |
IRunnableWithProgress |
getRunnable()
Returns the runnable that will create the JavaScript project or null if the page has
not been initialized. |
void |
init(IJavaScriptProject jproject,
IIncludePathEntry[] defaultEntries,
boolean defaultsOverrideExistingClasspath)
Initializes the page with the project and default classpath. |
Methods inherited from class org.eclipse.wst.jsdt.ui.wizards.NewElementWizardPage |
---|
setVisible |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavaCapabilityConfigurationPage()
After constructing, a call to #init(IJavaScriptProject, IPath, IIncludePathEntry[], boolean)
is required.
Method Detail |
---|
public void dispose()
public void init(IJavaScriptProject jproject, IIncludePathEntry[] defaultEntries, boolean defaultsOverrideExistingClasspath)
The default classpath entries must correspond the given project.
The caller of this method is responsible for creating the underlying project. The page will create the output, source and library folders if required.
The project does not have to exist at the time of initialization, but must exist when executing the runnable
obtained by getRunnable()
.
jproject
- The JavaScript project.defaultOutputLocation
- The default classpath entries or null
to let the page choose the defaultdefaultEntries
- The folder to be taken as the default output path or null
to let the page choose the defaultdefaultsOverrideExistingClasspath
- If set to true
, an existing '.classpath' file is ignored. If set to false
the given default classpath and output location is only used if no '.classpath' exists.public void createControl(Composite parent)
public IPath getOutputLocation()
public IIncludePathEntry[] getRawClassPath()
public IJavaScriptProject getJavaProject()
#init(IJavaScriptProject, IPath, IIncludePathEntry[], boolean)
or null
if the
page has not been initialized yet.
null
public IRunnableWithProgress getRunnable()
null
if the page has
not been initialized. The runnable sets the project's classpath and output location to the values
configured in the page and adds the JavaScript nature if not set yet. The method requires that the
project is created and opened.
public static void createProject(IProject project, java.net.URI locationURI, IProgressMonitor monitor) throws CoreException
project
- The handle of the project to create.locationURI
- The location of the project or null
to create the project in the workspacemonitor
- a progress monitor to report progress or null
if
progress reporting is not desired
CoreException
- if the project couldn't be createdorg.eclipse.core.resources.IProjectDescription#setLocationURI(java.net.URI)
public void configureJavaProject(IProgressMonitor monitor) throws CoreException, java.lang.InterruptedException
monitor
- a progress monitor to report progress or null
if
progress reporting is not desired
CoreException
- Thrown when the configuring the JavaScript project failed.
java.lang.InterruptedException
- Thrown when the operation has been canceled.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |