diff options
Diffstat (limited to 'docs/org.eclipse.wst.jsdt.doc/html/api_reference/org/eclipse/wst/jsdt/core/ICodeAssist.html')
| -rw-r--r-- | docs/org.eclipse.wst.jsdt.doc/html/api_reference/org/eclipse/wst/jsdt/core/ICodeAssist.html | 367 |
1 files changed, 0 insertions, 367 deletions
diff --git a/docs/org.eclipse.wst.jsdt.doc/html/api_reference/org/eclipse/wst/jsdt/core/ICodeAssist.html b/docs/org.eclipse.wst.jsdt.doc/html/api_reference/org/eclipse/wst/jsdt/core/ICodeAssist.html deleted file mode 100644 index b38c9eda..00000000 --- a/docs/org.eclipse.wst.jsdt.doc/html/api_reference/org/eclipse/wst/jsdt/core/ICodeAssist.html +++ /dev/null @@ -1,367 +0,0 @@ -<!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:47 CDT 2008 --> -<TITLE> -ICodeAssist -</TITLE> - -<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.ICodeAssist interface"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="ICodeAssist"; -} -</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/ICodeAssist.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/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> - <A HREF="../../../../../org/eclipse/wst/jsdt/core/ICompletionRequestor.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/ICodeAssist.html" target="_top"><B>FRAMES</B></A> - <A HREF="ICodeAssist.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 ICodeAssist</H2> -<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>, <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>ICodeAssist</B></DL> -</PRE> - -<P> -Common protocol for JavaScript elements that support source code assist and code - resolve. - <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> - -<!-- ========== 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> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html#codeComplete(int, org.eclipse.wst.jsdt.core.CompletionRequestor)">codeComplete</A></B>(int offset, - <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A> requestor)</CODE> - -<BR> - Performs code completion at the given offset position in this javaScript unit, - reporting results to the given completion requestor.</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/ICodeAssist.html#codeComplete(int, org.eclipse.wst.jsdt.core.CompletionRequestor, org.eclipse.wst.jsdt.core.WorkingCopyOwner)">codeComplete</A></B>(int offset, - <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A> requestor, - <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner)</CODE> - -<BR> - Performs code completion at the given offset position in this javaScript unit, - reporting results to the given completion requestor.</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/ICodeAssist.html#codeSelect(int, int)">codeSelect</A></B>(int offset, - int length)</CODE> - -<BR> - Returns the JavaScript elements corresponding to the given selected text in this javaScript unit.</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/ICodeAssist.html#codeSelect(int, int, org.eclipse.wst.jsdt.core.WorkingCopyOwner)">codeSelect</A></B>(int offset, - int length, - <A HREF="../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner)</CODE> - -<BR> - Returns the JavaScript elements corresponding to the given selected text in this javaScript unit.</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="codeComplete(int, org.eclipse.wst.jsdt.core.CompletionRequestor)"><!-- --></A><H3> -codeComplete</H3> -<PRE> -void <B>codeComplete</B>(int offset, - <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A> requestor) - throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> -<DL> -<DD>Performs code completion at the given offset position in this javaScript unit, - reporting results to the given completion requestor. The <code>offset</code> - is the 0-based index of the character, after which code assist is desired. - An <code>offset</code> of -1 indicates to code assist at the beginning of this - javaScript unit. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>offset</CODE> - the given offset position<DD><CODE>requestor</CODE> - the given completion requestor -<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 code assist could not be performed. Reasons include:<ul> - <li>This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> - <li> The position specified is < -1 or is greater than this javaScript unit's - source length (INDEX_OUT_OF_BOUNDS) - </ul> -<DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>requestor</code> is <code>null</code></DL> -</DD> -</DL> -<HR> - -<A NAME="codeComplete(int, org.eclipse.wst.jsdt.core.CompletionRequestor, org.eclipse.wst.jsdt.core.WorkingCopyOwner)"><!-- --></A><H3> -codeComplete</H3> -<PRE> -void <B>codeComplete</B>(int offset, - <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A> requestor, - <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>Performs code completion at the given offset position in this javaScript unit, - reporting results to the given completion requestor. The <code>offset</code> - is the 0-based index of the character, after which code assist is desired. - An <code>offset</code> of -1 indicates to code assist at the beginning of this - javaScript unit. - It considers types in the working copies with the given owner first. 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> -<DT><B>Parameters:</B><DD><CODE>offset</CODE> - the given offset position<DD><CODE>requestor</CODE> - the given completion requestor<DD><CODE>owner</CODE> - the owner of working copies that take precedence over their original javaScript units -<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 code assist could not be performed. Reasons include:<ul> - <li>This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> - <li> The position specified is < -1 or is greater than this javaScript unit's - source length (INDEX_OUT_OF_BOUNDS) - </ul> -<DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>requestor</code> is <code>null</code></DL> -</DD> -</DL> -<HR> - -<A NAME="codeSelect(int, int)"><!-- --></A><H3> -codeSelect</H3> -<PRE> -<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] <B>codeSelect</B>(int offset, - int length) - 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 JavaScript elements corresponding to the given selected text in this javaScript unit. - The <code>offset</code> is the 0-based index of the first selected character. - The <code>length</code> is the number of selected characters. - <p> - Note that if the <code>length</code> is 0 and the <code>offset</code> is inside an identifier - or the index just after an identifier then this identifier is considered as the selection. - </p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>offset</CODE> - the given offset position<DD><CODE>length</CODE> - the number of selected characters -<DT><B>Returns:</B><DD>the JavaScript elements corresponding to the given selected text -<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 code resolve could not be performed. Reasons include: - <ul> - <li>This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> - <li> The range specified is not within this element's - source range (INDEX_OUT_OF_BOUNDS) - </ul></DL> -</DD> -</DL> -<HR> - -<A NAME="codeSelect(int, int, org.eclipse.wst.jsdt.core.WorkingCopyOwner)"><!-- --></A><H3> -codeSelect</H3> -<PRE> -<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] <B>codeSelect</B>(int offset, - int length, - <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 JavaScript elements corresponding to the given selected text in this javaScript unit. - The <code>offset</code> is the 0-based index of the first selected character. - The <code>length</code> is the number of selected characters. - It considers types in the working copies with the given owner first. In other words, - the owner's working copies will take precedence over their original javaScript units - in the workspace. - <p> - Note that if the <code>length</code> is 0 and the <code>offset</code> is inside an identifier - or the index just after an identifier then this identifier is considered as the selection. - </p> - <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> -<DT><B>Parameters:</B><DD><CODE>offset</CODE> - the given offset position<DD><CODE>length</CODE> - the number of selected characters<DD><CODE>owner</CODE> - the owner of working copies that take precedence over their original javaScript units -<DT><B>Returns:</B><DD>the JavaScript elements corresponding to the given selected text -<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 code resolve could not be performed. Reasons include: - <ul> - <li>This JavaScript element does not exist (ELEMENT_DOES_NOT_EXIST)</li> - <li> The range specified is not within this element's - source range (INDEX_OUT_OF_BOUNDS) - </ul></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/ICodeAssist.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/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> - <A HREF="../../../../../org/eclipse/wst/jsdt/core/ICompletionRequestor.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/ICodeAssist.html" target="_top"><B>FRAMES</B></A> - <A HREF="ICodeAssist.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> |