| <!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> |
| IJavaScriptElement |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IJavaScriptElement interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IJavaScriptElement"; |
| } |
| </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/IJavaScriptElement.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/IJarEntryResource.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElementDelta.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/IJavaScriptElement.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavaScriptElement.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | 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 IJavaScriptElement</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core">ILookupScope</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core">IClassFile</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IField.html" title="interface in org.eclipse.wst.jsdt.core">IField</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunction.html" title="interface in org.eclipse.wst.jsdt.core">IFunction</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IImportContainer.html" title="interface in org.eclipse.wst.jsdt.core">IImportContainer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IImportDeclaration.html" title="interface in org.eclipse.wst.jsdt.core">IImportDeclaration</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IInitializer.html" title="interface in org.eclipse.wst.jsdt.core">IInitializer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptModel.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptModel</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILocalVariable.html" title="interface in org.eclipse.wst.jsdt.core">ILocalVariable</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html" title="interface in org.eclipse.wst.jsdt.core">IMember</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageDeclaration.html" title="interface in org.eclipse.wst.jsdt.core">IPackageDeclaration</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragment</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core">IPackageFragmentRoot</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeParameter.html" title="interface in org.eclipse.wst.jsdt.core">ITypeParameter</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html" title="interface in org.eclipse.wst.jsdt.core">ITypeRoot</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IJavaScriptElement</B><DT>extends <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core">ILookupScope</A></DL> |
| </PRE> |
| |
| <P> |
| Common protocol for all elements provided by the JavaScript model. |
| JavaScript model elements are exposed to clients as handles to the actual underlying element. |
| The JavaScript model may hand out any number of handles for each element. Handles |
| that refer to the same element are guaranteed to be equal, but not necessarily identical. |
| <p> |
| Methods annotated as "handle-only" do not require underlying elements to exist. |
| Methods that require underlying elements to exist throw |
| a <code>JavaScriptModelException</code> when an underlying element is missing. |
| <code>JavaScriptModelException.isDoesNotExist</code> can be used to recognize |
| this common special case. |
| </p> |
| <p> |
| This interface is not intended to be implemented by clients. |
| </p> |
| |
| Provisional API: This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves. |
| <P> |
| |
| <P> |
| <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> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#CLASS_FILE">CLASS_FILE</A></B></CODE> |
| |
| <BR> |
| Constant representing a non-editable javaScript file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#FIELD">FIELD</A></B></CODE> |
| |
| <BR> |
| Constant representing a field or a var with file scope.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#IMPORT_CONTAINER">IMPORT_CONTAINER</A></B></CODE> |
| |
| <BR> |
| Constant representing all import declarations within a compilation unit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#IMPORT_DECLARATION">IMPORT_DECLARATION</A></B></CODE> |
| |
| <BR> |
| Constant representing an import declaration within a compilation unit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#INITIALIZER">INITIALIZER</A></B></CODE> |
| |
| <BR> |
| Constant representing a stand-alone instance or class initializer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_MODEL">JAVASCRIPT_MODEL</A></B></CODE> |
| |
| <BR> |
| Constant representing a JavaScript model (workspace level object).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_PROJECT">JAVASCRIPT_PROJECT</A></B></CODE> |
| |
| <BR> |
| Constant representing a JavaScript project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_UNIT">JAVASCRIPT_UNIT</A></B></CODE> |
| |
| <BR> |
| Constant representing a JavaScript file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#LOCAL_VARIABLE">LOCAL_VARIABLE</A></B></CODE> |
| |
| <BR> |
| Constant representing a local variable declaration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#METHOD">METHOD</A></B></CODE> |
| |
| <BR> |
| Constant representing a function, method or constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_DECLARATION">PACKAGE_DECLARATION</A></B></CODE> |
| |
| <BR> |
| Constant representing a package declaration within a compilation unit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_FRAGMENT">PACKAGE_FRAGMENT</A></B></CODE> |
| |
| <BR> |
| Constant representing a source folder (package fragment).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_FRAGMENT_ROOT">PACKAGE_FRAGMENT_ROOT</A></B></CODE> |
| |
| <BR> |
| Constant representing a root source folder (package fragment root).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#TYPE">TYPE</A></B></CODE> |
| |
| <BR> |
| Constant representing a type (a class or interface).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#TYPE_PARAMETER">TYPE_PARAMETER</A></B></CODE> |
| |
| <BR> |
| Constant representing a type parameter declaration.</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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#exists()">exists</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this JavaScript element exists in the model.</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/IJavaScriptElement.html#getAncestor(int)">getAncestor</A></B>(int ancestorType)</CODE> |
| |
| <BR> |
| Returns the first ancestor of this JavaScript element that has the given type.</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/IJavaScriptElement.html#getAttachedJavadoc(IProgressMonitor)">getAttachedJavadoc</A></B>(IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Returns the Jsdoc as an html source if this element has an attached jsdoc, |
| null otherwise.</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/LibrarySuperType.html" title="class in org.eclipse.wst.jsdt.core">LibrarySuperType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getCommonSuperType()">getCommonSuperType</A></B>()</CODE> |
| |
| <BR> |
| Returns the Super type this file is considered to be a member of.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IResource</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getCorrespondingResource()">getCorrespondingResource</A></B>()</CODE> |
| |
| <BR> |
| Returns the resource that corresponds directly to this element, |
| or <code>null</code> if there is no resource that corresponds to |
| this element.</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/IJavaScriptElement.html#getDisplayName()">getDisplayName</A></B>()</CODE> |
| |
| <BR> |
| Returns a readable (non mangled) name.</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/IJavaScriptElement.html#getElementName()">getElementName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of this element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getElementType()">getElementType</A></B>()</CODE> |
| |
| <BR> |
| Returns this element's kind encoded as an integer.</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/IJavaScriptElement.html#getHandleIdentifier()">getHandleIdentifier</A></B>()</CODE> |
| |
| <BR> |
| Returns a string representation of this element handle.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.net.URI</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getHostPath()">getHostPath</A></B>()</CODE> |
| |
| <BR> |
| If a resource is virtual, then return a real host path for the element.</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/IJavaScriptModel.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptModel</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getJavaScriptModel()">getJavaScriptModel</A></B>()</CODE> |
| |
| <BR> |
| Returns the JavaScript model.</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/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getJavaScriptProject()">getJavaScriptProject</A></B>()</CODE> |
| |
| <BR> |
| Returns the JavaScript project this element is contained in, |
| or <code>null</code> if this element is not contained in any JavaScript project |
| (for instance, the <code>IJavaScriptModel</code> is not contained in any JavaScript |
| 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/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core">IOpenable</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getOpenable()">getOpenable</A></B>()</CODE> |
| |
| <BR> |
| Returns the first openable parent.</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/IJavaScriptElement.html#getParent()">getParent</A></B>()</CODE> |
| |
| <BR> |
| Returns the element directly containing this element, |
| or <code>null</code> if this element has no parent.</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/IJavaScriptElement.html#getPath()">getPath</A></B>()</CODE> |
| |
| <BR> |
| Returns the path to the innermost resource enclosing this element.</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/IJavaScriptElement.html#getPrimaryElement()">getPrimaryElement</A></B>()</CODE> |
| |
| <BR> |
| Returns the primary element (whose compilation unit is the primary compilation unit) |
| this working copy element was created from, or this element if it is a descendant of a |
| primary javaScript unit or if it is not a descendant of a working copy (e.g. it is a |
| binary member).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IResource</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getResource()">getResource</A></B>()</CODE> |
| |
| <BR> |
| Returns the innermost resource enclosing this element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> ISchedulingRule</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getSchedulingRule()">getSchedulingRule</A></B>()</CODE> |
| |
| <BR> |
| Returns the scheduling rule associated with this JavaScript element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IResource</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getUnderlyingResource()">getUnderlyingResource</A></B>()</CODE> |
| |
| <BR> |
| Returns the smallest underlying resource that contains |
| this element, or <code>null</code> if this element is not contained |
| in a resource.</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/IJavaScriptElement.html#isReadOnly()">isReadOnly</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this JavaScript element is read-only.</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/IJavaScriptElement.html#isStructureKnown()">isStructureKnown</A></B>()</CODE> |
| |
| <BR> |
| Returns whether the structure of this element is known.</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/IJavaScriptElement.html#isVirtual()">isVirtual</A></B>()</CODE> |
| |
| <BR> |
| Returns if this is a virtual element (ie actually exists in the model or filesystem).</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> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="JAVASCRIPT_MODEL"><!-- --></A><H3> |
| JAVASCRIPT_MODEL</H3> |
| <PRE> |
| static final int <B>JAVASCRIPT_MODEL</B></PRE> |
| <DL> |
| <DD>Constant representing a JavaScript model (workspace level object). |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptModel.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJavaScriptModel</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.JAVASCRIPT_MODEL">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="JAVASCRIPT_PROJECT"><!-- --></A><H3> |
| JAVASCRIPT_PROJECT</H3> |
| <PRE> |
| static final int <B>JAVASCRIPT_PROJECT</B></PRE> |
| <DL> |
| <DD>Constant representing a JavaScript project. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJavaScriptProject</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.JAVASCRIPT_PROJECT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PACKAGE_FRAGMENT_ROOT"><!-- --></A><H3> |
| PACKAGE_FRAGMENT_ROOT</H3> |
| <PRE> |
| static final int <B>PACKAGE_FRAGMENT_ROOT</B></PRE> |
| <DL> |
| <DD>Constant representing a root source folder (package fragment root). |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragmentRoot.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IPackageFragmentRoot</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.PACKAGE_FRAGMENT_ROOT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PACKAGE_FRAGMENT"><!-- --></A><H3> |
| PACKAGE_FRAGMENT</H3> |
| <PRE> |
| static final int <B>PACKAGE_FRAGMENT</B></PRE> |
| <DL> |
| <DD>Constant representing a source folder (package fragment). |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IPackageFragment</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.PACKAGE_FRAGMENT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="JAVASCRIPT_UNIT"><!-- --></A><H3> |
| JAVASCRIPT_UNIT</H3> |
| <PRE> |
| static final int <B>JAVASCRIPT_UNIT</B></PRE> |
| <DL> |
| <DD>Constant representing a JavaScript file. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJavaScriptUnit</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.JAVASCRIPT_UNIT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CLASS_FILE"><!-- --></A><H3> |
| CLASS_FILE</H3> |
| <PRE> |
| static final int <B>CLASS_FILE</B></PRE> |
| <DL> |
| <DD>Constant representing a non-editable javaScript file. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IClassFile</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.CLASS_FILE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TYPE"><!-- --></A><H3> |
| TYPE</H3> |
| <PRE> |
| static final int <B>TYPE</B></PRE> |
| <DL> |
| <DD>Constant representing a type (a class or interface). |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IType</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.TYPE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="FIELD"><!-- --></A><H3> |
| FIELD</H3> |
| <PRE> |
| static final int <B>FIELD</B></PRE> |
| <DL> |
| <DD>Constant representing a field or a var with file scope. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IField.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IField</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.FIELD">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="METHOD"><!-- --></A><H3> |
| METHOD</H3> |
| <PRE> |
| static final int <B>METHOD</B></PRE> |
| <DL> |
| <DD>Constant representing a function, method or constructor. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunction.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IFunction</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.METHOD">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="INITIALIZER"><!-- --></A><H3> |
| INITIALIZER</H3> |
| <PRE> |
| static final int <B>INITIALIZER</B></PRE> |
| <DL> |
| <DD>Constant representing a stand-alone instance or class initializer. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IInitializer.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IInitializer</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.INITIALIZER">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PACKAGE_DECLARATION"><!-- --></A><H3> |
| PACKAGE_DECLARATION</H3> |
| <PRE> |
| static final int <B>PACKAGE_DECLARATION</B></PRE> |
| <DL> |
| <DD>Constant representing a package declaration within a compilation unit. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageDeclaration.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IPackageDeclaration</CODE></A>. |
| |
| <b>This type only applies to ECMAScript 4 which is not yet supported</b> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.PACKAGE_DECLARATION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="IMPORT_CONTAINER"><!-- --></A><H3> |
| IMPORT_CONTAINER</H3> |
| <PRE> |
| static final int <B>IMPORT_CONTAINER</B></PRE> |
| <DL> |
| <DD>Constant representing all import declarations within a compilation unit. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IImportContainer.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IImportContainer</CODE></A>. |
| |
| <b>This type only applies to ECMAScript 4 which is not yet supported</b> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.IMPORT_CONTAINER">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="IMPORT_DECLARATION"><!-- --></A><H3> |
| IMPORT_DECLARATION</H3> |
| <PRE> |
| static final int <B>IMPORT_DECLARATION</B></PRE> |
| <DL> |
| <DD>Constant representing an import declaration within a compilation unit. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IImportDeclaration.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IImportDeclaration</CODE></A>. |
| |
| <b>This type only applies to ECMAScript 4 which is not yet supported</b> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.IMPORT_DECLARATION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LOCAL_VARIABLE"><!-- --></A><H3> |
| LOCAL_VARIABLE</H3> |
| <PRE> |
| static final int <B>LOCAL_VARIABLE</B></PRE> |
| <DL> |
| <DD>Constant representing a local variable declaration. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILocalVariable.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>ILocalVariable</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.LOCAL_VARIABLE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TYPE_PARAMETER"><!-- --></A><H3> |
| TYPE_PARAMETER</H3> |
| <PRE> |
| static final int <B>TYPE_PARAMETER</B></PRE> |
| <DL> |
| <DD>Constant representing a type parameter declaration. |
| A JavaScript element with this type can be safely cast to <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeParameter.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>ITypeParameter</CODE></A>. |
| |
| <b>This type only applies to ECMAScript 4 which is not yet supported</b> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IJavaScriptElement.TYPE_PARAMETER">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ============ 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="exists()"><!-- --></A><H3> |
| exists</H3> |
| <PRE> |
| boolean <B>exists</B>()</PRE> |
| <DL> |
| <DD>Returns whether this JavaScript element exists in the model. |
| <p> |
| JavaScript elements are handle objects that may or may not be backed by an |
| actual element. JavaScript elements that are backed by an actual element are |
| said to "exist", and this method returns <code>true</code>. For JavaScript |
| elements that are not working copies, it is always the case that if the |
| element exists, then its parent also exists (provided it has one) and |
| includes the element as one of its children. It is therefore possible |
| to navigated to any existing JavaScript element from the root of the JavaScript model |
| along a chain of existing JavaScript elements. On the other hand, working |
| copies are said to exist until they are destroyed (with |
| <code>IWorkingCopy.destroy</code>). Unlike regular JavaScript elements, a |
| working copy never shows up among the children of its parent element |
| (which may or may not exist). |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this element exists in the JavaScript model, and |
| <code>false</code> if this element does not exist</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAncestor(int)"><!-- --></A><H3> |
| getAncestor</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>getAncestor</B>(int ancestorType)</PRE> |
| <DL> |
| <DD>Returns the first ancestor of this JavaScript element that has the given type. |
| Returns <code>null</code> if no such an ancestor can be found. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ancestorType</CODE> - the given type |
| <DT><B>Returns:</B><DD>the first ancestor of this JavaScript element that has the given type, null if no such an ancestor can be found</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttachedJavadoc(IProgressMonitor)"><!-- --></A><H3> |
| getAttachedJavadoc</H3> |
| <PRE> |
| java.lang.String <B>getAttachedJavadoc</B>(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><p>Returns the Jsdoc as an html source if this element has an attached jsdoc, |
| null otherwise.</p> |
| <p>This should be used only for binary elements. Source elements will always return null.</p> |
| <p>The encoding used to read the jsdoc is the one defined by the content type of the |
| file. If none is defined, then the project's encoding of this java element is used. If the project's |
| encoding cannot be retrieved, then the platform encoding is used.</p> |
| <p>In case of the jsdoc doesn't exist for this element, null is returned.</p> |
| |
| <p>The html is extracted from the attached jsdoc and provided as is. No |
| transformation or validation is done.</p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>monitor</CODE> - the given progress monitor |
| <DT><B>Returns:</B><DD>the extracted jsdoc from the attached jsdoc, null if none |
| <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:<ul> |
| <li>this element does not exist</li> |
| <li>retrieving the attached jsdoc fails (timed-out, invalid URL, ...)</li> |
| <li>the format of the jsdoc doesn't match expected standards (different anchors,...)</li> |
| </ul><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathAttribute.html#JSDOC_LOCATION_ATTRIBUTE_NAME"><CODE>IIncludePathAttribute.JSDOC_LOCATION_ATTRIBUTE_NAME</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCorrespondingResource()"><!-- --></A><H3> |
| getCorrespondingResource</H3> |
| <PRE> |
| IResource <B>getCorrespondingResource</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 resource that corresponds directly to this element, |
| or <code>null</code> if there is no resource that corresponds to |
| this element. |
| <p> |
| For example, the corresponding resource for an <code>IJavaScriptUnit</code> |
| is its underlying <code>IFile</code>. The corresponding resource for |
| an <code>IPackageFragment</code> that is not contained in an archive |
| is its underlying <code>IFolder</code>. An <code>IPackageFragment</code> |
| contained in an archive has no corresponding resource. Similarly, there |
| are no corresponding resources for <code>IMethods</code>, |
| <code>IFields</code>, etc. |
| <p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the corresponding resource, or <code>null</code> if none |
| <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="getElementName()"><!-- --></A><H3> |
| getElementName</H3> |
| <PRE> |
| java.lang.String <B>getElementName</B>()</PRE> |
| <DL> |
| <DD>Returns the name of this element. This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the element name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getElementType()"><!-- --></A><H3> |
| getElementType</H3> |
| <PRE> |
| int <B>getElementType</B>()</PRE> |
| <DL> |
| <DD>Returns this element's kind encoded as an integer. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the kind of element; one of the constants declared in |
| <code>IJavaScriptElement</code><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJavaScriptElement</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHandleIdentifier()"><!-- --></A><H3> |
| getHandleIdentifier</H3> |
| <PRE> |
| java.lang.String <B>getHandleIdentifier</B>()</PRE> |
| <DL> |
| <DD>Returns a string representation of this element handle. The format of |
| the string is not specified; however, the identifier is stable across |
| workspace sessions, and can be used to recreate this handle via the |
| <code>JavaScriptCore.create(String)</code> method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the string handle identifier<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#create(java.lang.String)"><CODE>JavaScriptCore.create(java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getJavaScriptModel()"><!-- --></A><H3> |
| getJavaScriptModel</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptModel.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptModel</A> <B>getJavaScriptModel</B>()</PRE> |
| <DL> |
| <DD>Returns the JavaScript model. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the JavaScript model</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getJavaScriptProject()"><!-- --></A><H3> |
| getJavaScriptProject</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> <B>getJavaScriptProject</B>()</PRE> |
| <DL> |
| <DD>Returns the JavaScript project this element is contained in, |
| or <code>null</code> if this element is not contained in any JavaScript project |
| (for instance, the <code>IJavaScriptModel</code> is not contained in any JavaScript |
| project). |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the containing JavaScript project, or <code>null</code> if this element is |
| not contained in a JavaScript project</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOpenable()"><!-- --></A><H3> |
| getOpenable</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core">IOpenable</A> <B>getOpenable</B>()</PRE> |
| <DL> |
| <DD>Returns the first openable parent. If this element is openable, the element |
| itself is returned. Returns <code>null</code> if this element doesn't have |
| an openable parent. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the first openable parent or <code>null</code> if this element doesn't have |
| an openable parent.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParent()"><!-- --></A><H3> |
| getParent</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>getParent</B>()</PRE> |
| <DL> |
| <DD>Returns the element directly containing this element, |
| or <code>null</code> if this element has no parent. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the parent element, or <code>null</code> if this element has no parent</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPath()"><!-- --></A><H3> |
| getPath</H3> |
| <PRE> |
| IPath <B>getPath</B>()</PRE> |
| <DL> |
| <DD>Returns the path to the innermost resource enclosing this element. |
| If this element is not included in an external archive, |
| the path returned is the full, absolute path to the underlying resource, |
| relative to the workbench. |
| If this element is included in an external archive, |
| the path returned is the absolute path to the archive in the file system. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the path to the innermost resource enclosing this element</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryElement()"><!-- --></A><H3> |
| getPrimaryElement</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>getPrimaryElement</B>()</PRE> |
| <DL> |
| <DD>Returns the primary element (whose compilation unit is the primary compilation unit) |
| this working copy element was created from, or this element if it is a descendant of a |
| primary javaScript unit or if it is not a descendant of a working copy (e.g. it is a |
| binary member). |
| The returned element may or may not exist. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the primary element this working copy element was created from, or this |
| element.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResource()"><!-- --></A><H3> |
| getResource</H3> |
| <PRE> |
| IResource <B>getResource</B>()</PRE> |
| <DL> |
| <DD>Returns the innermost resource enclosing this element. |
| If this element is included in an archive and this archive is not external, |
| this is the underlying resource corresponding to the archive. |
| If this element is included in an external archive, <code>null</code> |
| is returned. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the innermost resource enclosing this element, <code>null</code> if this |
| element is included in an external archive</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSchedulingRule()"><!-- --></A><H3> |
| getSchedulingRule</H3> |
| <PRE> |
| ISchedulingRule <B>getSchedulingRule</B>()</PRE> |
| <DL> |
| <DD>Returns the scheduling rule associated with this JavaScript element. |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the scheduling rule associated with this JavaScript element</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUnderlyingResource()"><!-- --></A><H3> |
| getUnderlyingResource</H3> |
| <PRE> |
| IResource <B>getUnderlyingResource</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 smallest underlying resource that contains |
| this element, or <code>null</code> if this element is not contained |
| in a resource. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the underlying resource, or <code>null</code> if none |
| <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 underlying resource</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isReadOnly()"><!-- --></A><H3> |
| isReadOnly</H3> |
| <PRE> |
| boolean <B>isReadOnly</B>()</PRE> |
| <DL> |
| <DD>Returns whether this JavaScript element is read-only. An element is read-only |
| if its structure cannot be modified by the java model. |
| <p> |
| Note this is different from IResource.isReadOnly(). For example, .jar |
| files are read-only as the javaScript model doesn't know how to add/remove |
| elements in this file, but the underlying IFile can be writable. |
| <p> |
| This is a handle-only method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this element is read-only</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isStructureKnown()"><!-- --></A><H3> |
| isStructureKnown</H3> |
| <PRE> |
| boolean <B>isStructureKnown</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 whether the structure of this element is known. For example, for a |
| javaScript file that could not be parsed, <code>false</code> is returned. |
| If the structure of an element is unknown, navigations will return reasonable |
| defaults. For example, <code>getChildren</code> will return an empty collection. |
| <p> |
| Note: This does not imply anything about consistency with the |
| underlying resource/buffer contents. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if the structure of this element is known |
| <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="getDisplayName()"><!-- --></A><H3> |
| getDisplayName</H3> |
| <PRE> |
| java.lang.String <B>getDisplayName</B>()</PRE> |
| <DL> |
| <DD>Returns a readable (non mangled) name. In virtual elements this is derived from a JsGlobalScopeContainerInitializer |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a human friendly element name.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isVirtual()"><!-- --></A><H3> |
| isVirtual</H3> |
| <PRE> |
| boolean <B>isVirtual</B>()</PRE> |
| <DL> |
| <DD>Returns if this is a virtual element (ie actually exists in the model or filesystem). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>if this is a virtual element.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHostPath()"><!-- --></A><H3> |
| getHostPath</H3> |
| <PRE> |
| java.net.URI <B>getHostPath</B>()</PRE> |
| <DL> |
| <DD>If a resource is virtual, then return a real host path for the element. (Query the container initializer). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>if this is a virtual element.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCommonSuperType()"><!-- --></A><H3> |
| getCommonSuperType</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/LibrarySuperType.html" title="class in org.eclipse.wst.jsdt.core">LibrarySuperType</A> <B>getCommonSuperType</B>()</PRE> |
| <DL> |
| <DD>Returns the Super type this file is considered to be a member of. For Browser base javaScript, this would be "Window". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the supertype for the javascript file.</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/IJavaScriptElement.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/IJarEntryResource.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElementDelta.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/IJavaScriptElement.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavaScriptElement.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
