| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:15:48 CDT 2008 --> |
| <TITLE> |
| IJavaScriptProject |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IJavaScriptProject interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IJavaScriptProject"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IJavaScriptProject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptModelStatusConstants.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IJavaScriptProject.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavaScriptProject.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.jsdt.core</FONT> |
| <BR> |
| Interface IJavaScriptProject</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core">ILookupScope</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core">IOpenable</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IJavaScriptProject</B><DT>extends <A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core">IOpenable</A></DL> |
| </PRE> |
| |
| <P> |
| A JavaScript project represents a view of a project resource in terms of JavaScript |
| elements such as package fragments, types, methods and fields. |
| A project may contain several source folders (package roots), which contain source folders (package fragments). |
| A package root corresponds to an underlying folder. |
| <p> |
| Each JavaScript project has a includepath, defining which folders contain source code and |
| where required libraries are located. A project that |
| references packages in another project can access the packages by including |
| the required project in a includepath entry. The JavaScript model will present the |
| source elements in the required project. The includepath format is a sequence of includepath entries |
| describing the location and contents of package fragment roots. |
| </p> |
| JavaScript project elements need to be opened before they can be navigated or manipulated. |
| The children of a JavaScript project are the package fragment roots that are |
| defined by the includepath and contained in this project (in other words, it |
| does not include package fragment roots for other projects). |
| </p> |
| <p> |
| This interface is not intended to be implemented by clients. An instance |
| of one of these handles can be created via |
| <code>JavaScriptCore.create(project)</code>. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><CODE>JavaScriptCore#create(org.eclipse.core.resources.IProject)</CODE>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>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.</CODE></A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.eclipse.wst.jsdt.core.IJavaScriptElement"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#CLASS_FILE">CLASS_FILE</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#FIELD">FIELD</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#IMPORT_CONTAINER">IMPORT_CONTAINER</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#IMPORT_DECLARATION">IMPORT_DECLARATION</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#INITIALIZER">INITIALIZER</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_MODEL">JAVASCRIPT_MODEL</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_PROJECT">JAVASCRIPT_PROJECT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_UNIT">JAVASCRIPT_UNIT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#LOCAL_VARIABLE">LOCAL_VARIABLE</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#METHOD">METHOD</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_DECLARATION">PACKAGE_DECLARATION</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_FRAGMENT">PACKAGE_FRAGMENT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_FRAGMENT_ROOT">PACKAGE_FRAGMENT_ROOT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#TYPE">TYPE</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#TYPE_PARAMETER">TYPE_PARAMETER</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#decodeIncludepathEntry(java.lang.String)">decodeIncludepathEntry</A></B>(java.lang.String encodedEntry)</CODE> |
| |
| <BR> |
| Decodes the includepath entry that has been encoded in the given string |
| in the context of this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#encodeIncludepathEntry(org.eclipse.wst.jsdt.core.IIncludePathEntry)">encodeIncludepathEntry</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> includepathEntry)</CODE> |
| |
| <BR> |
| Encodes the given includepath entry into a string in the context of this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findElement(IPath)">findElement</A></B>(IPath path)</CODE> |
| |
| <BR> |
| Returns the <code>IJavaScriptElement</code> corresponding to the given |
| includepath-relative path, or <code>null</code> if no such |
| <code>IJavaScriptElement</code> is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findElement(IPath, org.eclipse.wst.jsdt.core.WorkingCopyOwner)">findElement</A></B>(IPath path, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner)</CODE> |
| |
| <BR> |
| Returns the <code>IJavaScriptElement</code> corresponding to the given |
| includepath-relative path, or <code>null</code> if no such |
| <code>IJavaScriptElement</code> is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragment</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findPackageFragment(IPath)">findPackageFragment</A></B>(IPath path)</CODE> |
| |
| <BR> |
| Returns the first existing package fragment on this project's includepath |
| whose path matches the given (absolute) path, or <code>null</code> if none |
| exist.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findPackageFragmentRoot(IPath)">findPackageFragmentRoot</A></B>(IPath path)</CODE> |
| |
| <BR> |
| Returns the existing package fragment root on this project's includepath |
| whose path matches the given (absolute) path, or <code>null</code> if |
| one does not exist.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findPackageFragmentRoots(org.eclipse.wst.jsdt.core.IIncludePathEntry)">findPackageFragmentRoots</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> entry)</CODE> |
| |
| <BR> |
| Returns the existing package fragment roots identified by the given entry.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String)">findType</A></B>(java.lang.String fullyQualifiedName)</CODE> |
| |
| <BR> |
| Returns the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String, IProgressMonitor)">findType</A></B>(java.lang.String fullyQualifiedName, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Same functionality as <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String)"><CODE>findType(String)</CODE></A> but also look for secondary |
| types if given name does not match a javaScript unit name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String, java.lang.String, IProgressMonitor)">findType</A></B>(java.lang.String packageName, |
| java.lang.String typeQualifiedName, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Same functionality as <CODE>#findType(String, String)</CODE> but also look for |
| secondary types if given name does not match a javaScript unit name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String, java.lang.String, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)">findType</A></B>(java.lang.String packageName, |
| java.lang.String typeQualifiedName, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Same functionality as <CODE>#findType(String, String, WorkingCopyOwner)</CODE> |
| but also look for secondary types if given name does not match a javaScript unit name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)">findType</A></B>(java.lang.String fullyQualifiedName, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Same functionality as <CODE>#findType(String, WorkingCopyOwner)</CODE> |
| but also look for secondary types if given name does not match |
| a javaScript unit name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html" title="interface in org.eclipse.wst.jsdt.core">ITypeRoot</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findTypeRoot(java.lang.String)">findTypeRoot</A></B>(java.lang.String fullyQualifiedName)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getAllPackageFragmentRoots()">getAllPackageFragmentRoots</A></B>()</CODE> |
| |
| <BR> |
| Returns all of the existing package fragment roots that exist |
| on the includepath, in the order they are defined by the includepath.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IFile</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getJSDTScopeFile()">getJSDTScopeFile</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getNonJavaScriptResources()">getNonJavaScriptResources</A></B>()</CODE> |
| |
| <BR> |
| Returns an array of non-JavaScript resources directly contained in this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getOption(java.lang.String, boolean)">getOption</A></B>(java.lang.String optionName, |
| boolean inheritJavaCoreOptions)</CODE> |
| |
| <BR> |
| Helper method for returning one option value only.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getOptions(boolean)">getOptions</A></B>(boolean inheritJavaCoreOptions)</CODE> |
| |
| <BR> |
| Returns the table of the current custom options for this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IPath</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getOutputLocation()">getOutputLocation</A></B>()</CODE> |
| |
| <BR> |
| Returns the default output location for this project as a workspace- |
| relative absolute path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getPackageFragmentRoot(java.lang.String)">getPackageFragmentRoot</A></B>(java.lang.String filePath)</CODE> |
| |
| <BR> |
| Returns a package fragment root for the file at the specified file system path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getPackageFragmentRoots()">getPackageFragmentRoots</A></B>()</CODE> |
| |
| <BR> |
| Returns all of the package fragment roots contained in this |
| project, identified on this project's resolved includepath.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragment</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getPackageFragments()">getPackageFragments</A></B>()</CODE> |
| |
| <BR> |
| Returns all package fragments in all package fragment roots contained |
| in this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IProject</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getProject()">getProject</A></B>()</CODE> |
| |
| <BR> |
| Returns the <code>IProject</code> on which this <code>IJavaScriptProject</code> |
| was created.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getRawIncludepath()">getRawIncludepath</A></B>()</CODE> |
| |
| <BR> |
| Returns the raw includepath for the project, as a list of includepath |
| entries.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getRequiredProjectNames()">getRequiredProjectNames</A></B>()</CODE> |
| |
| <BR> |
| Returns the names of the projects that are directly required by this |
| project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getResolvedIncludepath(boolean)">getResolvedIncludepath</A></B>(boolean ignoreUnresolvedEntry)</CODE> |
| |
| <BR> |
| This is a helper method returning the resolved includepath for the project |
| as a list of simple (non-variable, non-container) includepath entries.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#hasBuildState()">hasBuildState</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this project has been built at least once and thus whether it has a build state.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#hasIncludepathCycle(org.eclipse.wst.jsdt.core.IIncludePathEntry[])">hasIncludepathCycle</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries)</CODE> |
| |
| <BR> |
| Returns whether setting this project's includepath to the given includepath entries |
| would result in a cycle.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#isOnIncludepath(org.eclipse.wst.jsdt.core.IJavaScriptElement)">isOnIncludepath</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> element)</CODE> |
| |
| <BR> |
| Returns whether the given element is on the includepath of this project, |
| that is, referenced from a includepath entry and not explicitly excluded |
| using an exclusion pattern.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/eval/IEvaluationContext.html" title="interface in org.eclipse.wst.jsdt.core.eval">IEvaluationContext</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#newEvaluationContext()">newEvaluationContext</A></B>()</CODE> |
| |
| <BR> |
| Creates a new evaluation context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#newTypeHierarchy(org.eclipse.wst.jsdt.core.IRegion, IProgressMonitor)">newTypeHierarchy</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Creates and returns a type hierarchy for all types in the given |
| region, considering subtypes within that region.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#newTypeHierarchy(org.eclipse.wst.jsdt.core.IRegion, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)">newTypeHierarchy</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Creates and returns a type hierarchy for all types in the given |
| region, considering subtypes within that region and considering types in the |
| working copies with the given owner.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#newTypeHierarchy(org.eclipse.wst.jsdt.core.IType, org.eclipse.wst.jsdt.core.IRegion, IProgressMonitor)">newTypeHierarchy</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Creates and returns a type hierarchy for the given type considering |
| subtypes in the specified region.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#newTypeHierarchy(org.eclipse.wst.jsdt.core.IType, org.eclipse.wst.jsdt.core.IRegion, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)">newTypeHierarchy</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Creates and returns a type hierarchy for the given type considering |
| subtypes in the specified region and considering types in the |
| working copies with the given owner.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IPath</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#readOutputLocation()">readOutputLocation</A></B>()</CODE> |
| |
| <BR> |
| Returns the default output location for the project as defined by its <code>.jsdtScope</code> file from disk, or <code>null</code> |
| if unable to read the file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#readRawIncludepath()">readRawIncludepath</A></B>()</CODE> |
| |
| <BR> |
| Returns the raw includepath for the project as defined by its |
| <code>.jsdtScope</code> file from disk, or <code>null</code> |
| if unable to read the file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setOption(java.lang.String, java.lang.String)">setOption</A></B>(java.lang.String optionName, |
| java.lang.String optionValue)</CODE> |
| |
| <BR> |
| Helper method for setting one option value only.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setOptions(java.util.Map)">setOptions</A></B>(java.util.Map newOptions)</CODE> |
| |
| <BR> |
| Sets the project custom options.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setOutputLocation(IPath, IProgressMonitor)">setOutputLocation</A></B>(IPath path, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Sets the default output location of this project to the location |
| described by the given workspace-relative absolute path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setRawIncludepath(org.eclipse.wst.jsdt.core.IIncludePathEntry[], boolean, IProgressMonitor)">setRawIncludepath</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries, |
| boolean canModifyResources, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Sets the includepath of this project using a list of includepath entries.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setRawIncludepath(org.eclipse.wst.jsdt.core.IIncludePathEntry[], IPath, boolean, IProgressMonitor)">setRawIncludepath</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries, |
| IPath outputLocation, |
| boolean canModifyResources, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Sets both the includepath of this project and its default output |
| location at once.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setRawIncludepath(org.eclipse.wst.jsdt.core.IIncludePathEntry[], IProgressMonitor)">setRawIncludepath</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Sets the includepath of this project using a list of includepath entries.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.IParent"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html#getChildren()">getChildren</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html#hasChildren()">hasChildren</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.IJavaScriptElement"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#exists()">exists</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getAncestor(int)">getAncestor</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getAttachedJavadoc(IProgressMonitor)">getAttachedJavadoc</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getCommonSuperType()">getCommonSuperType</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getCorrespondingResource()">getCorrespondingResource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getDisplayName()">getDisplayName</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getElementName()">getElementName</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getElementType()">getElementType</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getHandleIdentifier()">getHandleIdentifier</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getHostPath()">getHostPath</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getJavaScriptModel()">getJavaScriptModel</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getJavaScriptProject()">getJavaScriptProject</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getOpenable()">getOpenable</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getParent()">getParent</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getPath()">getPath</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getPrimaryElement()">getPrimaryElement</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getResource()">getResource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getSchedulingRule()">getSchedulingRule</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getUnderlyingResource()">getUnderlyingResource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#isReadOnly()">isReadOnly</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#isStructureKnown()">isStructureKnown</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#isVirtual()">isVirtual</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.ILookupScope"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core">ILookupScope</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newNameLookup(org.eclipse.wst.jsdt.core.IJavaScriptUnit[])">newNameLookup</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newNameLookup(org.eclipse.wst.jsdt.core.WorkingCopyOwner)">newNameLookup</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newSearchableNameEnvironment(org.eclipse.wst.jsdt.core.IJavaScriptUnit[])">newSearchableNameEnvironment</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newSearchableNameEnvironment(org.eclipse.wst.jsdt.core.WorkingCopyOwner)">newSearchableNameEnvironment</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.IOpenable"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core">IOpenable</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#close()">close</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#findRecommendedLineSeparator()">findRecommendedLineSeparator</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#getBuffer()">getBuffer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#hasUnsavedChanges()">hasUnsavedChanges</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#isConsistent()">isConsistent</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#isOpen()">isOpen</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#makeConsistent(IProgressMonitor)">makeConsistent</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#open(IProgressMonitor)">open</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#save(IProgressMonitor, boolean)">save</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getJSDTScopeFile()"><!-- --></A><H3> |
| getJSDTScopeFile</H3> |
| <PRE> |
| IFile <B>getJSDTScopeFile</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="decodeIncludepathEntry(java.lang.String)"><!-- --></A><H3> |
| decodeIncludepathEntry</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> <B>decodeIncludepathEntry</B>(java.lang.String encodedEntry)</PRE> |
| <DL> |
| <DD>Decodes the includepath entry that has been encoded in the given string |
| in the context of this project. |
| Returns null if the encoded entry is malformed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>encodedEntry</CODE> - the encoded includepath entry |
| <DT><B>Returns:</B><DD>the decoded includepath entry, or <code>null</code> if unable to decode it</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="encodeIncludepathEntry(org.eclipse.wst.jsdt.core.IIncludePathEntry)"><!-- --></A><H3> |
| encodeIncludepathEntry</H3> |
| <PRE> |
| java.lang.String <B>encodeIncludepathEntry</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> includepathEntry)</PRE> |
| <DL> |
| <DD>Encodes the given includepath entry into a string in the context of this project. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>includepathEntry</CODE> - the includepath entry to encode |
| <DT><B>Returns:</B><DD>the encoded includepath entry</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findElement(IPath)"><!-- --></A><H3> |
| findElement</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>findElement</B>(IPath path) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the <code>IJavaScriptElement</code> corresponding to the given |
| includepath-relative path, or <code>null</code> if no such |
| <code>IJavaScriptElement</code> is found. The result is one of an |
| <code>IJavaScriptUnit</code>, <code>IClassFile</code>, or |
| <code>IPackageFragment</code>. |
| <p> |
| When looking for a package fragment, there might be several potential |
| matches; only one of them is returned. |
| |
| <p>For example, the path "java/lang/Object.js", would result in the |
| <code>IJavaScriptUnit</code> or <code>IClassFile</code> corresponding to |
| "java.lang.Object". The path "java/lang" would result in the |
| <code>IPackageFragment</code> for "java.lang". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the given includepath-relative path |
| <DT><B>Returns:</B><DD>the <code>IJavaScriptElement</code> corresponding to the given |
| includepath-relative path, or <code>null</code> if no such |
| <code>IJavaScriptElement</code> is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the given path is <code>null</code> |
| or absolute</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findElement(IPath, org.eclipse.wst.jsdt.core.WorkingCopyOwner)"><!-- --></A><H3> |
| findElement</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>findElement</B>(IPath path, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the <code>IJavaScriptElement</code> corresponding to the given |
| includepath-relative path, or <code>null</code> if no such |
| <code>IJavaScriptElement</code> is found. The result is one of an |
| <code>IJavaScriptUnit</code>, <code>IClassFile</code>, or |
| <code>IPackageFragment</code>. If it is an <code>IJavaScriptUnit</code>, |
| its owner is the given owner. |
| <p> |
| When looking for a package fragment, there might be several potential |
| matches; only one of them is returned. |
| |
| <p>For example, the path "java/lang/Object.js", would result in the |
| <code>IJavaScriptUnit</code> or <code>IClassFile</code> corresponding to |
| "java.lang.Object". The path "java/lang" would result in the |
| <code>IPackageFragment</code> for "java.lang". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the given includepath-relative path<DD><CODE>owner</CODE> - the owner of the returned javaScript unit, ignored if it is |
| not a javaScript unit. |
| <DT><B>Returns:</B><DD>the <code>IJavaScriptElement</code> corresponding to the given |
| includepath-relative path, or <code>null</code> if no such |
| <code>IJavaScriptElement</code> is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the given path is <code>null</code> |
| or absolute</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findPackageFragment(IPath)"><!-- --></A><H3> |
| findPackageFragment</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragment</A> <B>findPackageFragment</B>(IPath path) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the first existing package fragment on this project's includepath |
| whose path matches the given (absolute) path, or <code>null</code> if none |
| exist. |
| The path can be: |
| - internal to the workbench: "/Project/src" |
| - external to the workbench: "c:/jdk/classes.zip/java/lang" |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the given absolute path |
| <DT><B>Returns:</B><DD>the first existing package fragment on this project's includepath |
| whose path matches the given (absolute) path, or <code>null</code> if none |
| exist |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findPackageFragmentRoot(IPath)"><!-- --></A><H3> |
| findPackageFragmentRoot</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A> <B>findPackageFragmentRoot</B>(IPath path) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the existing package fragment root on this project's includepath |
| whose path matches the given (absolute) path, or <code>null</code> if |
| one does not exist. |
| The path can be: |
| - internal to the workbench: "/Compiler/src" |
| - external to the workbench: "c:/jdk/classes.zip" |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the given absolute path |
| <DT><B>Returns:</B><DD>the existing package fragment root on this project's includepath |
| whose path matches the given (absolute) path, or <code>null</code> if |
| one does not exist |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findPackageFragmentRoots(org.eclipse.wst.jsdt.core.IIncludePathEntry)"><!-- --></A><H3> |
| findPackageFragmentRoots</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>[] <B>findPackageFragmentRoots</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> entry)</PRE> |
| <DL> |
| <DD>Returns the existing package fragment roots identified by the given entry. |
| Note that a includepath entry that refers to another project may |
| have more than one root (if that project has more than on root |
| containing source), and includepath entries within the current |
| project identify a single root. |
| <p> |
| If the includepath entry denotes a variable, it will be resolved and return |
| the roots of the target entry (empty if not resolvable). |
| <p> |
| If the includepath entry denotes a container, it will be resolved and return |
| the roots corresponding to the set of container entries (empty if not resolvable). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>entry</CODE> - the given entry |
| <DT><B>Returns:</B><DD>the existing package fragment roots identified by the given entry<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJsGlobalScopeContainer</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findType(java.lang.String)"><!-- --></A><H3> |
| findType</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>findType</B>(java.lang.String fullyQualifiedName) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found. |
| The fully qualified name is a dot-separated name. For example, |
| a class B defined as a member type of a class A in package x.y should have a |
| the fully qualified name "x.y.A.B". |
| |
| Note that in order to be found, a type name (or its toplevel enclosing |
| type name) must match its corresponding javaScript unit name. As a |
| consequence, secondary types cannot be found using this functionality. |
| To find secondary types use <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String, IProgressMonitor)"><CODE>findType(String, IProgressMonitor)</CODE></A> instead. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fullyQualifiedName</CODE> - the given fully qualified name |
| <DT><B>Returns:</B><DD>the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html#getFullyQualifiedName(char)"><CODE>IType.getFullyQualifiedName(char)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findType(java.lang.String, IProgressMonitor)"><!-- --></A><H3> |
| findType</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>findType</B>(java.lang.String fullyQualifiedName, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Same functionality as <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#findType(java.lang.String)"><CODE>findType(String)</CODE></A> but also look for secondary |
| types if given name does not match a javaScript unit name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fullyQualifiedName</CODE> - the given fully qualified name<DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, |
| or <code>null</code> if no progress monitor is provided |
| <DT><B>Returns:</B><DD>the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html#getFullyQualifiedName(char)"><CODE>IType.getFullyQualifiedName(char)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findType(java.lang.String, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)"><!-- --></A><H3> |
| findType</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>findType</B>(java.lang.String fullyQualifiedName, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Same functionality as <CODE>#findType(String, WorkingCopyOwner)</CODE> |
| but also look for secondary types if given name does not match |
| a javaScript unit name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fullyQualifiedName</CODE> - the given fully qualified name<DD><CODE>owner</CODE> - the owner of the returned type's javaScript unit<DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, |
| or <code>null</code> if no progress monitor is provided |
| <DT><B>Returns:</B><DD>the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html#getFullyQualifiedName(char)"><CODE>IType.getFullyQualifiedName(char)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findType(java.lang.String, java.lang.String, IProgressMonitor)"><!-- --></A><H3> |
| findType</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>findType</B>(java.lang.String packageName, |
| java.lang.String typeQualifiedName, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Same functionality as <CODE>#findType(String, String)</CODE> but also look for |
| secondary types if given name does not match a javaScript unit name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>packageName</CODE> - the given package name<DD><CODE>typeQualifiedName</CODE> - the given type qualified name<DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, |
| or <code>null</code> if no progress monitor is provided |
| <DT><B>Returns:</B><DD>the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html#getFullyQualifiedName(char)"><CODE>IType.getFullyQualifiedName(char)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findType(java.lang.String, java.lang.String, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)"><!-- --></A><H3> |
| findType</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>findType</B>(java.lang.String packageName, |
| java.lang.String typeQualifiedName, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Same functionality as <CODE>#findType(String, String, WorkingCopyOwner)</CODE> |
| but also look for secondary types if given name does not match a javaScript unit name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>packageName</CODE> - the given package name<DD><CODE>typeQualifiedName</CODE> - the given type qualified name<DD><CODE>owner</CODE> - the owner of the returned type's javaScript unit<DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, |
| or <code>null</code> if no progress monitor is provided |
| <DT><B>Returns:</B><DD>the first type found following this project's includepath |
| with the given fully qualified name or <code>null</code> if none is found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this project does not exist or if an |
| exception occurs while accessing its corresponding resource<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html#getFullyQualifiedName(char)"><CODE>IType.getFullyQualifiedName(char)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAllPackageFragmentRoots()"><!-- --></A><H3> |
| getAllPackageFragmentRoots</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>[] <B>getAllPackageFragmentRoots</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns all of the existing package fragment roots that exist |
| on the includepath, in the order they are defined by the includepath. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>all of the existing package fragment roots that exist |
| on the includepath |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNonJavaScriptResources()"><!-- --></A><H3> |
| getNonJavaScriptResources</H3> |
| <PRE> |
| java.lang.Object[] <B>getNonJavaScriptResources</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns an array of non-JavaScript resources directly contained in this project. |
| It does not transitively answer non-JavaScript resources contained in folders; |
| these would have to be explicitly iterated over. |
| <p> |
| Non-JavaScript resources includes other files and folders located in the |
| project not accounted for by any of it source or binary package fragment |
| roots. If the project is a source folder itself, resources excluded from the |
| corresponding source includepath entry by one or more exclusion patterns |
| are considered non-JavaScript resources and will appear in the result |
| (possibly in a folder) |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an array of non-JavaScript resources (<code>IFile</code>s and/or |
| <code>IFolder</code>s) directly contained in this project |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOption(java.lang.String, boolean)"><!-- --></A><H3> |
| getOption</H3> |
| <PRE> |
| java.lang.String <B>getOption</B>(java.lang.String optionName, |
| boolean inheritJavaCoreOptions)</PRE> |
| <DL> |
| <DD>Helper method for returning one option value only. Equivalent to <code>(String)this.getOptions(inheritJavaCoreOptions).get(optionName)</code> |
| Note that it may answer <code>null</code> if this option does not exist, or if there is no custom value for it. |
| <p> |
| For a complete description of the configurable options, see <code>JavaScriptCore#getDefaultOptions</code>. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>optionName</CODE> - the name of an option<DD><CODE>inheritJavaCoreOptions</CODE> - - boolean indicating whether JavaScriptCore options should be inherited as well |
| <DT><B>Returns:</B><DD>the String value of a given option<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getDefaultOptions()"><CODE>JavaScriptCore.getDefaultOptions()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOptions(boolean)"><!-- --></A><H3> |
| getOptions</H3> |
| <PRE> |
| java.util.Map <B>getOptions</B>(boolean inheritJavaCoreOptions)</PRE> |
| <DL> |
| <DD>Returns the table of the current custom options for this project. Projects remember their custom options, |
| in other words, only the options different from the the JavaScriptCore global options for the workspace. |
| A boolean argument allows to directly merge the project options with global ones from <code>JavaScriptCore</code>. |
| <p> |
| For a complete description of the configurable options, see <code>JavaScriptCore#getDefaultOptions</code>. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>inheritJavaCoreOptions</CODE> - - boolean indicating whether JavaScriptCore options should be inherited as well |
| <DT><B>Returns:</B><DD>table of current settings of all options |
| (key type: <code>String</code>; value type: <code>String</code>)<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getDefaultOptions()"><CODE>JavaScriptCore.getDefaultOptions()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOutputLocation()"><!-- --></A><H3> |
| getOutputLocation</H3> |
| <PRE> |
| IPath <B>getOutputLocation</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the default output location for this project as a workspace- |
| relative absolute path. |
| <p> |
| The default output location is where class files are ordinarily generated |
| (and resource files, copied). Each source includepath entry can also |
| specify an output location for the generated class files (and copied |
| resource files) corresponding to javaScript units under that source |
| folder. This makes it possible to arrange generated class files for |
| different source folders in different output folders, and not |
| necessarily the default output folder. This means that the generated |
| class files for the project may end up scattered across several folders, |
| rather than all in the default output folder (which is more standard). |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the workspace-relative absolute path of the default output folder |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist<DT><B>See Also:</B><DD><CODE>#setOutputLocation(org.eclipse.core.runtime.IPath, IProgressMonitor)</CODE>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#getOutputLocation()"><CODE>IIncludePathEntry.getOutputLocation()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPackageFragmentRoot(java.lang.String)"><!-- --></A><H3> |
| getPackageFragmentRoot</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A> <B>getPackageFragmentRoot</B>(java.lang.String filePath)</PRE> |
| <DL> |
| <DD>Returns a package fragment root for the file at the specified file system path. |
| This is a handle-only method. The underlying <code>java.io.File</code> |
| may or may not exist. No resource is associated with this local file |
| package fragment root. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>filePath</CODE> - the file system path |
| <DT><B>Returns:</B><DD>a package fragment root for the file at the specified file system path</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPackageFragmentRoots()"><!-- --></A><H3> |
| getPackageFragmentRoots</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>[] <B>getPackageFragmentRoots</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns all of the package fragment roots contained in this |
| project, identified on this project's resolved includepath. The result |
| does not include package fragment roots in other projects referenced |
| on this project's includepath. |
| |
| <p>NOTE: This is equivalent to <code>getChildren()</code>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>all of the package fragment roots contained in this |
| project, identified on this project's resolved includepath |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPackageFragments()"><!-- --></A><H3> |
| getPackageFragments</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragment</A>[] <B>getPackageFragments</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns all package fragments in all package fragment roots contained |
| in this project. This is a convenience method. |
| |
| Note that the package fragment roots corresponds to the resolved |
| includepath of the project. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>all package fragments in all package fragment roots contained |
| in this project |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProject()"><!-- --></A><H3> |
| getProject</H3> |
| <PRE> |
| IProject <B>getProject</B>()</PRE> |
| <DL> |
| <DD>Returns the <code>IProject</code> on which this <code>IJavaScriptProject</code> |
| was created. This is handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>IProject</code> on which this <code>IJavaScriptProject</code> |
| was created</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRawIncludepath()"><!-- --></A><H3> |
| getRawIncludepath</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] <B>getRawIncludepath</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the raw includepath for the project, as a list of includepath |
| entries. This corresponds to the exact set of entries which were assigned |
| using <code>setRawIncludepath</code>, in particular such a includepath may |
| contain includepath variable and includepath container entries. Includepath |
| variable and includepath container entries can be resolved using the |
| helper method <code>getResolvedIncludepath</code>; includepath variable |
| entries also can be resolved individually using |
| <code>JavaScriptCore#getIncludepathVariable</code>). |
| <p> |
| Both includepath containers and includepath variables provides a level of |
| indirection that can make the <code>.jsdtScope</code> file stable across |
| workspaces. |
| </p> |
| <p> |
| Note that in case the project isn't yet opened, the includepath will |
| be read directly from the associated <tt>.jsdtScope</tt> file. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the raw includepath for the project, as a list of includepath entries |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IIncludePathEntry</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRequiredProjectNames()"><!-- --></A><H3> |
| getRequiredProjectNames</H3> |
| <PRE> |
| java.lang.String[] <B>getRequiredProjectNames</B>() |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns the names of the projects that are directly required by this |
| project. A project is required if it is in its includepath. |
| <p> |
| The project names are returned in the order they appear on the includepath. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the names of the projects that are directly required by this |
| project in includepath order |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResolvedIncludepath(boolean)"><!-- --></A><H3> |
| getResolvedIncludepath</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] <B>getResolvedIncludepath</B>(boolean ignoreUnresolvedEntry) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>This is a helper method returning the resolved includepath for the project |
| as a list of simple (non-variable, non-container) includepath entries. |
| All includepath variable and includepath container entries in the project's |
| raw includepath will be replaced by the simple includepath entries they |
| resolve to. |
| <p> |
| The resulting resolved includepath is accurate for the given point in time. |
| If the project's raw includepath is later modified, or if includepath |
| variables are changed, the resolved includepath can become out of date. |
| Because of this, hanging on resolved includepath is not recommended. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ignoreUnresolvedEntry</CODE> - indicates how to handle unresolvable |
| variables and containers; <code>true</code> indicates that missing |
| variables and unresolvable includepath containers should be silently |
| ignored, and that the resulting list should consist only of the |
| entries that could be successfully resolved; <code>false</code> indicates |
| that a <code>JavaScriptModelException</code> should be thrown for the first |
| unresolved variable or container |
| <DT><B>Returns:</B><DD>the resolved includepath for the project as a list of simple |
| includepath entries, where all includepath variable and container entries |
| have been resolved and substituted with their final target entries |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - in one of the corresponding situation: |
| <ul> |
| <li>this element does not exist</li> |
| <li>an exception occurs while accessing its corresponding resource</li> |
| <li>a includepath variable or includepath container was not resolvable |
| and <code>ignoreUnresolvedEntry</code> is <code>false</code>.</li> |
| </ul><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IIncludePathEntry</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasBuildState()"><!-- --></A><H3> |
| hasBuildState</H3> |
| <PRE> |
| boolean <B>hasBuildState</B>()</PRE> |
| <DL> |
| <DD>Returns whether this project has been built at least once and thus whether it has a build state. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if this project has been built at least once, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasIncludepathCycle(org.eclipse.wst.jsdt.core.IIncludePathEntry[])"><!-- --></A><H3> |
| hasIncludepathCycle</H3> |
| <PRE> |
| boolean <B>hasIncludepathCycle</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries)</PRE> |
| <DL> |
| <DD>Returns whether setting this project's includepath to the given includepath entries |
| would result in a cycle. |
| |
| If the set of entries contains some variables, those are resolved in order to determine |
| cycles. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>entries</CODE> - the given includepath entries |
| <DT><B>Returns:</B><DD>true if the given includepath entries would result in a cycle, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isOnIncludepath(org.eclipse.wst.jsdt.core.IJavaScriptElement)"><!-- --></A><H3> |
| isOnIncludepath</H3> |
| <PRE> |
| boolean <B>isOnIncludepath</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> element)</PRE> |
| <DL> |
| <DD>Returns whether the given element is on the includepath of this project, |
| that is, referenced from a includepath entry and not explicitly excluded |
| using an exclusion pattern. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>element</CODE> - the given element |
| <DT><B>Returns:</B><DD><code>true</code> if the given element is on the includepath of |
| this project, <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#getInclusionPatterns()"><CODE>IIncludePathEntry.getInclusionPatterns()</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#getExclusionPatterns()"><CODE>IIncludePathEntry.getExclusionPatterns()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newEvaluationContext()"><!-- --></A><H3> |
| newEvaluationContext</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/eval/IEvaluationContext.html" title="interface in org.eclipse.wst.jsdt.core.eval">IEvaluationContext</A> <B>newEvaluationContext</B>()</PRE> |
| <DL> |
| <DD>Creates a new evaluation context. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new evaluation context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newTypeHierarchy(org.eclipse.wst.jsdt.core.IRegion, IProgressMonitor)"><!-- --></A><H3> |
| newTypeHierarchy</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A> <B>newTypeHierarchy</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Creates and returns a type hierarchy for all types in the given |
| region, considering subtypes within that region. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>monitor</CODE> - the given progress monitor<DD><CODE>region</CODE> - the given region |
| <DT><B>Returns:</B><DD>a type hierarchy for all types in the given |
| region, considering subtypes within that region |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if region is <code>null</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newTypeHierarchy(org.eclipse.wst.jsdt.core.IRegion, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)"><!-- --></A><H3> |
| newTypeHierarchy</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A> <B>newTypeHierarchy</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Creates and returns a type hierarchy for all types in the given |
| region, considering subtypes within that region and considering types in the |
| working copies with the given owner. |
| In other words, the owner's working copies will take |
| precedence over their original javaScript units in the workspace. |
| <p> |
| Note that if a working copy is empty, it will be as if the original javaScript |
| unit had been deleted. |
| <p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>monitor</CODE> - the given progress monitor<DD><CODE>region</CODE> - the given region<DD><CODE>owner</CODE> - the owner of working copies that take precedence over their original javaScript units |
| <DT><B>Returns:</B><DD>a type hierarchy for all types in the given |
| region, considering subtypes within that region |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if region is <code>null</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newTypeHierarchy(org.eclipse.wst.jsdt.core.IType, org.eclipse.wst.jsdt.core.IRegion, IProgressMonitor)"><!-- --></A><H3> |
| newTypeHierarchy</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A> <B>newTypeHierarchy</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Creates and returns a type hierarchy for the given type considering |
| subtypes in the specified region. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - the given type<DD><CODE>region</CODE> - the given region<DD><CODE>monitor</CODE> - the given monitor |
| <DT><B>Returns:</B><DD>a type hierarchy for the given type considering |
| subtypes in the specified region |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if type or region is <code>null</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newTypeHierarchy(org.eclipse.wst.jsdt.core.IType, org.eclipse.wst.jsdt.core.IRegion, org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)"><!-- --></A><H3> |
| newTypeHierarchy</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeHierarchy.html" title="interface in org.eclipse.wst.jsdt.core">ITypeHierarchy</A> <B>newTypeHierarchy</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IRegion.html" title="interface in org.eclipse.wst.jsdt.core">IRegion</A> region, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Creates and returns a type hierarchy for the given type considering |
| subtypes in the specified region and considering types in the |
| working copies with the given owner. |
| In other words, the owner's working copies will take |
| precedence over their original javaScript units in the workspace. |
| <p> |
| Note that if a working copy is empty, it will be as if the original javaScript |
| unit had been deleted. |
| <p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - the given type<DD><CODE>region</CODE> - the given region<DD><CODE>monitor</CODE> - the given monitor<DD><CODE>owner</CODE> - the owner of working copies that take precedence over their original javaScript units |
| <DT><B>Returns:</B><DD>a type hierarchy for the given type considering |
| subtypes in the specified region |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an |
| exception occurs while accessing its corresponding resource |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if type or region is <code>null</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readOutputLocation()"><!-- --></A><H3> |
| readOutputLocation</H3> |
| <PRE> |
| IPath <B>readOutputLocation</B>()</PRE> |
| <DL> |
| <DD>Returns the default output location for the project as defined by its <code>.jsdtScope</code> file from disk, or <code>null</code> |
| if unable to read the file. |
| <p> |
| This output location may differ from the in-memory one returned by <code>getOutputLocation</code>, in case the |
| automatic reconciliation mechanism has not been performed yet. Usually, any change to the <code>.classpath</code> file |
| is automatically noticed and reconciled at the next resource change notification event. |
| However, if the file is modified within an operation, where this change needs to be taken into account before the |
| operation ends, then the output location from disk can be read using this method, and further assigned to the project |
| using <code>setRawIncludepath(...)</code>. |
| <p> |
| The default output location is where class files are ordinarily generated |
| (and resource files, copied). Each source includepath entry can also |
| specify an output location for the generated class files (and copied |
| resource files) corresponding to javaScript units under that source |
| folder. This makes it possible to arrange generated class files for |
| different source folders in different output folders, and not |
| necessarily the default output folder. This means that the generated |
| class files for the project may end up scattered across several folders, |
| rather than all in the default output folder (which is more standard). |
| <p> |
| In order to manually force a project includepath refresh, one can simply assign the project includepath using the result of this |
| method, as follows: |
| <code>proj.setRawIncludepath(proj.readRawIncludepath(), proj.readOutputLocation(), monitor)</code> |
| (note that the <code>readRawIncludepath/readOutputLocation</code> methods could return <code>null</code>). |
| <p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the workspace-relative absolute path of the default output folder<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getOutputLocation()"><CODE>getOutputLocation()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readRawIncludepath()"><!-- --></A><H3> |
| readRawIncludepath</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] <B>readRawIncludepath</B>()</PRE> |
| <DL> |
| <DD>Returns the raw includepath for the project as defined by its |
| <code>.jsdtScope</code> file from disk, or <code>null</code> |
| if unable to read the file. |
| <p> |
| This includepath may differ from the in-memory includepath returned by |
| <code>getRawIncludepath</code>, in case the automatic reconciliation |
| mechanism has not been performed yet. Usually, any change to the |
| <code>.jsdtScope</code> file is automatically noticed and reconciled at |
| the next resource change notification event. However, if the file is |
| modified within an operation, where this change needs to be taken into |
| account before the operation ends, then the includepath from disk can be |
| read using this method, and further assigned to the project using |
| <code>setRawIncludepath(...)</code>. |
| </p> |
| <p> |
| Includepath variable and includepath container entries can be resolved using |
| the helper method <code>getResolvedIncludepath</code>; includepath variable |
| entries also can be resolved individually using |
| <code>JavaScriptCore#getIncludepathVariable</code>). |
| </p> |
| <p> |
| Note that no check is performed whether the project has the JavaScript nature |
| set, allowing an existing <code>.jsdtScope</code> file to be considered |
| independantly (unlike <code>getRawIncludepath</code> which requires the |
| JavaScript nature to be associated with the project). |
| </p> |
| <p> |
| In order to manually force a project includepath refresh, one can simply |
| assign the project includepath using the result of this method, as follows: |
| <code>proj.setRawIncludepath(proj.readRawIncludepath(), proj.readOutputLocation(), monitor)</code> |
| (note that the <code>readRawIncludepath/readOutputLocation</code> methods |
| could return <code>null</code>). |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the raw includepath from disk for the project, as a list of |
| includepath entries<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getRawIncludepath()"><CODE>getRawIncludepath()</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IIncludePathEntry</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOption(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setOption</H3> |
| <PRE> |
| void <B>setOption</B>(java.lang.String optionName, |
| java.lang.String optionValue)</PRE> |
| <DL> |
| <DD>Helper method for setting one option value only. Equivalent to <code>Map options = this.getOptions(false); map.put(optionName, optionValue); this.setOptions(map)</code> |
| <p> |
| For a complete description of the configurable options, see <code>JavaScriptCore#getDefaultOptions</code>. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>optionName</CODE> - the name of an option<DD><CODE>optionValue</CODE> - the value of the option to set<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getDefaultOptions()"><CODE>JavaScriptCore.getDefaultOptions()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOptions(java.util.Map)"><!-- --></A><H3> |
| setOptions</H3> |
| <PRE> |
| void <B>setOptions</B>(java.util.Map newOptions)</PRE> |
| <DL> |
| <DD>Sets the project custom options. All and only the options explicitly included in the given table |
| are remembered; all previous option settings are forgotten, including ones not explicitly |
| mentioned. |
| <p> |
| For a complete description of the configurable options, see <code>JavaScriptCore#getDefaultOptions</code>. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>newOptions</CODE> - the new options (key type: <code>String</code>; value type: <code>String</code>), |
| or <code>null</code> to flush all custom options (clients will automatically get the global JavaScriptCore options).<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getDefaultOptions()"><CODE>JavaScriptCore.getDefaultOptions()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOutputLocation(IPath, IProgressMonitor)"><!-- --></A><H3> |
| setOutputLocation</H3> |
| <PRE> |
| void <B>setOutputLocation</B>(IPath path, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Sets the default output location of this project to the location |
| described by the given workspace-relative absolute path. |
| <p> |
| The default output location is where class files are ordinarily generated |
| (and resource files, copied). Each source includepath entries can also |
| specify an output location for the generated class files (and copied |
| resource files) corresponding to javaScript units under that source |
| folder. This makes it possible to arrange that generated class files for |
| different source folders to end up in different output folders, and not |
| necessarily the default output folder. This means that the generated |
| class files for the project may end up scattered across several folders, |
| rather than all in the default output folder (which is more standard). |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the workspace-relative absolute path of the default output |
| folder<DD><CODE>monitor</CODE> - the progress monitor |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the includepath could not be set. Reasons include: |
| <ul> |
| <li> This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> |
| <li> The path refers to a location not contained in this project (<code>PATH_OUTSIDE_PROJECT</code>) |
| <li> The path is not an absolute path (<code>RELATIVE_PATH</code>) |
| <li> The path is nested inside a package fragment root of this project (<code>INVALID_PATH</code>) |
| <li> The output location is being modified during resource change event notification (CORE_EXCEPTION) |
| </ul><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getOutputLocation()"><CODE>getOutputLocation()</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#getOutputLocation()"><CODE>IIncludePathEntry.getOutputLocation()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRawIncludepath(org.eclipse.wst.jsdt.core.IIncludePathEntry[], IPath, boolean, IProgressMonitor)"><!-- --></A><H3> |
| setRawIncludepath</H3> |
| <PRE> |
| void <B>setRawIncludepath</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries, |
| IPath outputLocation, |
| boolean canModifyResources, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Sets both the includepath of this project and its default output |
| location at once. The includepath is defined using a list of includepath |
| entries. In particular such a includepath may contain includepath variable entries. |
| Includepath variable entries can be resolved individually (<A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getIncludepathVariable(java.lang.String)"><CODE>JavaScriptCore.getIncludepathVariable(String)</CODE></A>), |
| or the full includepath can be resolved at once using the helper method <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getResolvedIncludepath(boolean)"><CODE>getResolvedIncludepath(boolean)</CODE></A>. |
| <p> |
| </p><p> |
| If it is specified that this operation cannot modify resources, the .jsdtScope file will not be written to disk |
| and no error marker will be generated. To synchronize the .jsdtScope with the in-memory includepath, |
| one can use <code>setRawIncludepath(readRawIncludepath(), true, monitor)</code>. |
| </p><p> |
| Setting the includepath to <code>null</code> specifies a default includepath |
| (the project root). Setting the includepath to an empty array specifies an |
| empty includepath. |
| </p><p> |
| If a cycle is detected while setting this includepath (and if resources can be modified), an error marker will be added |
| to the project closing the cycle. |
| To avoid this problem, use <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#hasIncludepathCycle(org.eclipse.wst.jsdt.core.IIncludePathEntry[])"><CODE>hasIncludepathCycle(IIncludePathEntry[])</CODE></A> |
| before setting the includepath. |
| <p> |
| This operation acquires a lock on the workspace's root. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>entries</CODE> - a list of includepath entries<DD><CODE>outputLocation</CODE> - the default output location<DD><CODE>canModifyResources</CODE> - whether resources should be written to disk if needed<DD><CODE>monitor</CODE> - the given progress monitor |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the includepath could not be set. Reasons include: |
| <ul> |
| <li> This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> |
| <li> The includepath is being modified during resource change event notification (CORE_EXCEPTION) |
| <li> The includepath failed the validation check as defined by <CODE>JavaScriptConventions#validateIncludepath(IJavaScriptProject, IIncludePathEntry[], IPath)</CODE> |
| </ul><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IIncludePathEntry</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRawIncludepath(org.eclipse.wst.jsdt.core.IIncludePathEntry[], boolean, IProgressMonitor)"><!-- --></A><H3> |
| setRawIncludepath</H3> |
| <PRE> |
| void <B>setRawIncludepath</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries, |
| boolean canModifyResources, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Sets the includepath of this project using a list of includepath entries. In particular such a includepath may contain |
| includepath variable entries. Includepath variable entries can be resolved individually (<A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getIncludepathVariable(java.lang.String)"><CODE>JavaScriptCore.getIncludepathVariable(String)</CODE></A>), |
| or the full includepath can be resolved at once using the helper method <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getResolvedIncludepath(boolean)"><CODE>getResolvedIncludepath(boolean)</CODE></A>. |
| <p> |
| </p><p> |
| If it is specified that this operation cannot modify resources, the .jsdtScope file will not be written to disk |
| and no error marker will be generated. To synchronize the .jsdtScope with the in-memory includepath, |
| one can use <code>setRawIncludepath(readRawIncludepath(), true, monitor)</code>. |
| </p><p> |
| Setting the includepath to <code>null</code> specifies a default includepath |
| (the project root). Setting the includepath to an empty array specifies an |
| empty includepath. |
| </p><p> |
| If a cycle is detected while setting this includepath (and if resources can be modified), an error marker will be added |
| to the project closing the cycle. |
| To avoid this problem, use <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#hasIncludepathCycle(org.eclipse.wst.jsdt.core.IIncludePathEntry[])"><CODE>hasIncludepathCycle(IIncludePathEntry[])</CODE></A> |
| before setting the includepath. |
| <p> |
| This operation acquires a lock on the workspace's root. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>entries</CODE> - a list of includepath entries<DD><CODE>canModifyResources</CODE> - whether resources should be written to disk if needed<DD><CODE>monitor</CODE> - the given progress monitor |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the includepath could not be set. Reasons include: |
| <ul> |
| <li> This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> |
| <li> The includepath is being modified during resource change event notification (CORE_EXCEPTION) |
| <li> The includepath failed the validation check as defined by <CODE>JavaScriptConventions#validateIncludepath(IJavaScriptProject, IIncludePathEntry[], IPath)</CODE> |
| </ul><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IIncludePathEntry</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRawIncludepath(org.eclipse.wst.jsdt.core.IIncludePathEntry[], IProgressMonitor)"><!-- --></A><H3> |
| setRawIncludepath</H3> |
| <PRE> |
| void <B>setRawIncludepath</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] entries, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Sets the includepath of this project using a list of includepath entries. In particular such a includepath may contain |
| includepath variable entries. Includepath variable entries can be resolved individually (<A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getIncludepathVariable(java.lang.String)"><CODE>JavaScriptCore.getIncludepathVariable(String)</CODE></A>), |
| or the full includepath can be resolved at once using the helper method <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#getResolvedIncludepath(boolean)"><CODE>getResolvedIncludepath(boolean)</CODE></A>. |
| <p> |
| <p> |
| Setting the includepath to <code>null</code> specifies a default includepath |
| (the project root). Setting the includepath to an empty array specifies an |
| empty includepath. |
| <p> |
| If a cycle is detected while setting this includepath, an error marker will be added |
| to the project closing the cycle. |
| To avoid this problem, use <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#hasIncludepathCycle(org.eclipse.wst.jsdt.core.IIncludePathEntry[])"><CODE>hasIncludepathCycle(IIncludePathEntry[])</CODE></A> |
| before setting the includepath. |
| <p> |
| This operation acquires a lock on the workspace's root. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>entries</CODE> - a list of includepath entries<DD><CODE>monitor</CODE> - the given progress monitor |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the includepath could not be set. Reasons include: |
| <ul> |
| <li> This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> |
| <li> The includepath is being modified during resource change event notification (CORE_EXCEPTION) |
| <li> The includepath failed the validation check as defined by <CODE>JavaScriptConventions#validateIncludepath(IJavaScriptProject, IIncludePathEntry[], IPath)</CODE> |
| </ul><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IIncludePathEntry</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findTypeRoot(java.lang.String)"><!-- --></A><H3> |
| findTypeRoot</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html" title="interface in org.eclipse.wst.jsdt.core">ITypeRoot</A> <B>findTypeRoot</B>(java.lang.String fullyQualifiedName) |
| throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IJavaScriptProject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptModelStatusConstants.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IJavaScriptProject.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavaScriptProject.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
