Google Git
Sign in
eclipse / gerrit / jsdt / webtools.jsdt.core / 927db86fe692fa2a12cecc04846b9f13e691ecfe / . / docs / org.eclipse.wst.jsdt.doc / html / api_reference / org / eclipse / wst / jsdt / core / ITypeRoot.html
blob: ab49bf2bc2bd2b8484e65b4d61ab214b1e36574f [file] [log] [blame]
<!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:49 CDT 2008 -->
<TITLE>
ITypeRoot
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.ITypeRoot interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ITypeRoot";
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ITypeRoot.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeParameter.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IWorkingCopy.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/ITypeRoot.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ITypeRoot.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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 ITypeRoot</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html" title="interface in org.eclipse.wst.jsdt.core">ICodeAssist</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html" title="interface in org.eclipse.wst.jsdt.core">IFunctionContainer</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/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>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</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/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ITypeRoot</B><DT>extends <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/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</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/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html" title="interface in org.eclipse.wst.jsdt.core">ICodeAssist</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html" title="interface in org.eclipse.wst.jsdt.core">IFunctionContainer</A></DL>
</PRE>
<P>
Represents an entire JavaScript type root (either an <code>IJavaScriptUnit</code>
or an <code>IClassFile</code>).
<p>
This interface is not intended to be implemented by clients.
</p>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>Note that methods {@link #findPrimaryType()} and {@link #getElementAt(int)}
were already implemented in this interface respectively since version 3.0 and version 1.0.</CODE></A>,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>Note that method {@link #getWorkingCopy(WorkingCopyOwner, IProgressMonitor)}
was already implemented in this interface since version 3.0.
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>
&nbsp;<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>
&nbsp;
<!-- ========== 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>&nbsp;<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/ITypeRoot.html#findPrimaryType()">findPrimaryType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Finds the primary type of this JavaScript type root (that is, the type with the same name as the
javascript file), or <code>null</code> if no such a type exists.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/ITypeRoot.html#getElementAt(int)">getElementAt</A></B>(int&nbsp;position)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the smallest element within this JavaScript type root that
includes the given source position (that is, a method, field, etc.), or
<code>null</code> if there is no element other than the JavaScript type root
itself at the given position, or if the given position is not
within the source range of the source of this JavaScript type root.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html#getWorkingCopy(org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)">getWorkingCopy</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A>&nbsp;owner,
IProgressMonitor&nbsp;monitor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a shared working copy on this javaScirpt file using the given working copy owner to create
the buffer.</TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;<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>
&nbsp;<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>
&nbsp;<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>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.ISourceReference"><!-- --></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/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html#exists()">exists</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html#getSource()">getSource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html#getSourceRange()">getSourceRange</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.ICodeAssist"><!-- --></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/ICodeAssist.html" title="interface in org.eclipse.wst.jsdt.core">ICodeAssist</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html#codeComplete(int, org.eclipse.wst.jsdt.core.CompletionRequestor)">codeComplete</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html#codeComplete(int, org.eclipse.wst.jsdt.core.CompletionRequestor, org.eclipse.wst.jsdt.core.WorkingCopyOwner)">codeComplete</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html#codeSelect(int, int)">codeSelect</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html#codeSelect(int, int, org.eclipse.wst.jsdt.core.WorkingCopyOwner)">codeSelect</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.IFunctionContainer"><!-- --></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/IFunctionContainer.html" title="interface in org.eclipse.wst.jsdt.core">IFunctionContainer</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html#getField(java.lang.String)">getField</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html#getFields()">getFields</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html#getFunction(java.lang.String, java.lang.String[])">getFunction</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html#getFunctions()">getFunctions</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html#getMethods()">getMethods</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunctionContainer.html#getType(java.lang.String)">getType</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="findPrimaryType()"><!-- --></A><H3>
findPrimaryType</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>findPrimaryType</B>()</PRE>
<DL>
<DD>Finds the primary type of this JavaScript type root (that is, the type with the same name as the
javascript file), or <code>null</code> if no such a type exists.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the found primary type of this JavaScript type root, or <code>null</code> if no such a type exists</DL>
</DD>
</DL>
<HR>
<A NAME="getElementAt(int)"><!-- --></A><H3>
getElementAt</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>getElementAt</B>(int&nbsp;position)
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 element within this JavaScript type root that
includes the given source position (that is, a method, field, etc.), or
<code>null</code> if there is no element other than the JavaScript type root
itself at the given position, or if the given position is not
within the source range of the source of this JavaScript type root.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>position</CODE> - a source position inside the JavaScript type root
<DT><B>Returns:</B><DD>the innermost JavaScript element enclosing a given source position or <code>null</code>
if none (excluding the JavaScript type root).
<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 JavaScript type root does not exist or if an
exception occurs while accessing its corresponding resource</DL>
</DD>
</DL>
<HR>
<A NAME="getWorkingCopy(org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)"><!-- --></A><H3>
getWorkingCopy</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> <B>getWorkingCopy</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A>&nbsp;owner,
IProgressMonitor&nbsp;monitor)
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Returns a shared working copy on this javaScirpt file using the given working copy owner to create
the buffer. If this is already a working copy of the given owner, the element itself is returned.
This API can only answer an already existing working copy if it is based on the same
original JavaScript type root AND was using the same working copy owner (that is, as defined by <CODE>Object.equals(java.lang.Object)</CODE>).
<p>
The life time of a shared working copy is as follows:
<ul>
<li>The first call to <A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html#getWorkingCopy(org.eclipse.wst.jsdt.core.WorkingCopyOwner, IProgressMonitor)"><CODE>getWorkingCopy(WorkingCopyOwner, IProgressMonitor)</CODE></A>
creates a new working copy for this element</li>
<li>Subsequent calls increment an internal counter.</li>
<li>A call to <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html#discardWorkingCopy()"><CODE>IJavaScriptUnit.discardWorkingCopy()</CODE></A> decrements the internal counter.</li>
<li>When this counter is 0, the working copy is discarded.
</ul>
So users of this method must discard exactly once the working copy.
<p>
Note that the working copy owner will be used for the life time of the shared working copy, that is if the
working copy is closed then reopened, this owner will be used.
The buffer will be automatically initialized with the original's JavaScript type root content upon creation.
<p>
When the shared working copy instance is created, an ADDED IJavaScriptElementDelta is reported on this
working copy.
</p><p>
A working copy can be created on a not-yet existing compilation unit.
In particular, such a working copy can then be committed in order to create
the corresponding compilation unit.
</p><p>
Note that possible problems of this working copy are reported using this method. only
if the given working copy owner returns a problem requestor for this working copy
(see <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html#getProblemRequestor(org.eclipse.wst.jsdt.core.IJavaScriptUnit)"><CODE>WorkingCopyOwner.getProblemRequestor(IJavaScriptUnit)</CODE></A>).
</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>owner</CODE> - the working copy owner that creates a buffer that is used to get the content
of the working copy<DD><CODE>monitor</CODE> - a progress monitor used to report progress while opening this compilation unit
or <code>null</code> if no progress should be reported
<DT><B>Returns:</B><DD>a new working copy of this JavaScript type root using the given owner to create
the buffer, or this JavaScript type root if it is already a working copy
<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 contents of this element can
not be determined.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ITypeRoot.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeParameter.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IWorkingCopy.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/ITypeRoot.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ITypeRoot.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>