| <!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:16:04 CDT 2008 --> |
| <TITLE> |
| CompletionProposalCollector |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.ui.text.java.CompletionProposalCollector class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="CompletionProposalCollector"; |
| } |
| </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/CompletionProposalCollector.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/ui/text/java/AbstractProposalSorter.html" title="class in org.eclipse.wst.jsdt.ui.text.java"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalComparator.html" title="class in org.eclipse.wst.jsdt.ui.text.java"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CompletionProposalCollector.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.ui.text.java</FONT> |
| <BR> |
| Class CompletionProposalCollector</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">org.eclipse.wst.jsdt.core.CompletionRequestor</A> |
| <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.ui.text.java.CompletionProposalCollector</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>CompletionProposalCollector</B><DT>extends <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></DL> |
| </PRE> |
| |
| <P> |
| JavaScript UI implementation of <code>CompletionRequestor</code>. Produces |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposal.html" title="interface in org.eclipse.wst.jsdt.ui.text.java"><CODE>IJavaCompletionProposal</CODE></A>s from the proposal descriptors received via |
| the <code>CompletionRequestor</code> interface. |
| <p> |
| The lifecycle of a <code>CompletionProposalCollector</code> instance is very |
| simple: |
| <pre> |
| IJavaScriptUnit unit= ... |
| int offset= ... |
| |
| CompletionProposalCollector collector= new CompletionProposalCollector(unit); |
| unit.codeComplete(offset, collector); |
| IJavaCompletionProposal[] proposals= collector.getJavaCompletionProposals(); |
| String errorMessage= collector.getErrorMessage(); |
| |
| // display / process proposals |
| </pre> |
| Note that after a code completion operation, the collector will store any |
| received proposals, which may require a considerable amount of memory, so the |
| collector should not be kept as a reference after a completion operation. |
| </p> |
| <p> |
| Clients may instantiate or subclass. |
| </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> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#CompletionProposalCollector(org.eclipse.wst.jsdt.core.IJavaScriptProject)">CompletionProposalCollector</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| Creates a new instance ready to collect proposals.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#CompletionProposalCollector(org.eclipse.wst.jsdt.core.IJavaScriptUnit)">CompletionProposalCollector</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> cu)</CODE> |
| |
| <BR> |
| Creates a new instance ready to collect proposals.</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#accept(org.eclipse.wst.jsdt.core.CompletionProposal)">accept</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html" title="class in org.eclipse.wst.jsdt.core">CompletionProposal</A> proposal)</CODE> |
| |
| <BR> |
| Proposes a completion. |
| |
| Subclasses may replace, but usually should not need to.</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/ui/text/java/CompletionProposalCollector.html#acceptContext(org.eclipse.wst.jsdt.core.CompletionContext)">acceptContext</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionContext.html" title="class in org.eclipse.wst.jsdt.core">CompletionContext</A> context)</CODE> |
| |
| <BR> |
| Propose the context in which the completion occurs. |
| |
| Subclasses may extend, but usually should not need to.</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/ui/text/java/CompletionProposalCollector.html#beginReporting()">beginReporting</A></B>()</CODE> |
| |
| <BR> |
| Pro forma notification sent before reporting a batch of |
| completion proposals. |
| |
| Subclasses may extend, but must call the super implementation.</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/ui/text/java/CompletionProposalCollector.html#completionFailure(org.eclipse.wst.jsdt.core.compiler.IProblem)">completionFailure</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/compiler/IProblem.html" title="interface in org.eclipse.wst.jsdt.core.compiler">IProblem</A> problem)</CODE> |
| |
| <BR> |
| Notification of failure to produce any completions. |
| |
| Subclasses may extend, but must call the super implementation.</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/ui/text/java/CompletionProposalCollector.html#endReporting()">endReporting</A></B>()</CODE> |
| |
| <BR> |
| Pro forma notification sent after reporting a batch of |
| completion proposals. |
| |
| Subclasses may extend, but must call the super implementation.</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/ui/text/java/CompletionProposalCollector.html#getErrorMessage()">getErrorMessage</A></B>()</CODE> |
| |
| <BR> |
| Returns an error message about any error that may have occurred during |
| code completion, or the empty string if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposal.html" title="interface in org.eclipse.wst.jsdt.ui.text.java">IJavaCompletionProposal</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#getJavaCompletionProposals()">getJavaCompletionProposals</A></B>()</CODE> |
| |
| <BR> |
| Returns the unsorted list of received proposals.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.eclipse.wst.jsdt.internal.ui.text.java.JavaCompletionProposal[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#getKeywordCompletionProposals()">getKeywordCompletionProposals</A></B>()</CODE> |
| |
| <BR> |
| Returns the unsorted list of received keyword proposals.</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/ui/text/java/CompletionProposalCollector.html#setInvocationContext(org.eclipse.wst.jsdt.ui.text.java.JavaContentAssistInvocationContext)">setInvocationContext</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/JavaContentAssistInvocationContext.html" title="class in org.eclipse.wst.jsdt.ui.text.java">JavaContentAssistInvocationContext</A> context)</CODE> |
| |
| <BR> |
| Sets the invocation context.</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/ui/text/java/CompletionProposalCollector.html#setReplacementLength(int)">setReplacementLength</A></B>(int length)</CODE> |
| |
| <BR> |
| If the replacement length is set, it overrides the length returned from |
| the content assist infrastructure.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.CompletionRequestor"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.eclipse.wst.jsdt.core.<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#getFavoriteReferences()">getFavoriteReferences</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#isAllowingRequiredProposals(int, int)">isAllowingRequiredProposals</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#isIgnored(int)">isIgnored</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#setAllowsRequiredProposals(int, int, boolean)">setAllowsRequiredProposals</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#setFavoriteReferences(java.lang.String[])">setFavoriteReferences</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#setIgnored(int, boolean)">setIgnored</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="CompletionProposalCollector(org.eclipse.wst.jsdt.core.IJavaScriptUnit)"><!-- --></A><H3> |
| CompletionProposalCollector</H3> |
| <PRE> |
| public <B>CompletionProposalCollector</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> cu)</PRE> |
| <DL> |
| <DD>Creates a new instance ready to collect proposals. If the passed |
| <code>IJavaScriptUnit</code> is not contained in an |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJavaScriptProject</CODE></A>, no javadoc will be available as |
| <CODE>additional info</CODE> |
| on the created proposals. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>cu</CODE> - the compilation unit that the result collector will operate on</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CompletionProposalCollector(org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| CompletionProposalCollector</H3> |
| <PRE> |
| public <B>CompletionProposalCollector</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD>Creates a new instance ready to collect proposals. Note that proposals |
| for anonymous types and method declarations are not created when using |
| this constructor, as those need to know the compilation unit that they |
| are created on. Use |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#CompletionProposalCollector(org.eclipse.wst.jsdt.core.IJavaScriptUnit)"><CODE>CompletionProposalCollector(IJavaScriptUnit)</CODE></A> |
| instead to get all proposals. |
| <p> |
| If the passed JavaScript project is <code>null</code>, no javadoc will be |
| available as |
| <CODE>additional info</CODE> |
| on the created (e.g. method and type) proposals. |
| </p> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>project</CODE> - the project that the result collector will operate on, or |
| <code>null</code></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="setInvocationContext(org.eclipse.wst.jsdt.ui.text.java.JavaContentAssistInvocationContext)"><!-- --></A><H3> |
| setInvocationContext</H3> |
| <PRE> |
| public void <B>setInvocationContext</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/JavaContentAssistInvocationContext.html" title="class in org.eclipse.wst.jsdt.ui.text.java">JavaContentAssistInvocationContext</A> context)</PRE> |
| <DL> |
| <DD>Sets the invocation context. |
| <p> |
| Subclasses may extend. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the invocation context<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#getInvocationContext()"><CODE>getInvocationContext()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="accept(org.eclipse.wst.jsdt.core.CompletionProposal)"><!-- --></A><H3> |
| accept</H3> |
| <PRE> |
| public void <B>accept</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html" title="class in org.eclipse.wst.jsdt.core">CompletionProposal</A> proposal)</PRE> |
| <DL> |
| <DD>Proposes a completion. Has no effect if the kind of proposal |
| is being ignored by this requestor. Callers should consider |
| checking <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#isIgnored(int)"><CODE>CompletionRequestor.isIgnored(int)</CODE></A> before avoid creating proposal |
| objects that would only be ignored. |
| <p> |
| Similarly, implementers should check |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#isIgnored(int)"><CODE>isIgnored(proposal.getKind())</CODE></A> |
| and ignore proposals that have been declared as uninteresting. |
| The proposal object passed is only valid for the duration of |
| completion operation. |
| <p> |
| Subclasses may replace, but usually should not need to. Consider |
| replacing |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#createJavaCompletionProposal(org.eclipse.wst.jsdt.core.CompletionProposal)">createJavaCompletionProposal</A> |
| instead. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#accept(org.eclipse.wst.jsdt.core.CompletionProposal)">accept</A></CODE> in class <CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>proposal</CODE> - the completion proposal</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="acceptContext(org.eclipse.wst.jsdt.core.CompletionContext)"><!-- --></A><H3> |
| acceptContext</H3> |
| <PRE> |
| public void <B>acceptContext</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionContext.html" title="class in org.eclipse.wst.jsdt.core">CompletionContext</A> context)</PRE> |
| <DL> |
| <DD>Propose the context in which the completion occurs. |
| <p> |
| This method is called one and only one time before any call to |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#accept(org.eclipse.wst.jsdt.core.CompletionProposal)"><CODE>CompletionRequestor.accept(CompletionProposal)</CODE></A>. |
| The default implementation of this method does nothing. |
| Clients may override. |
| </p> |
| <p> |
| Subclasses may extend, but usually should not need to. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#acceptContext(org.eclipse.wst.jsdt.core.CompletionContext)">acceptContext</A></CODE> in class <CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the completion context<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html#getContext()"><CODE>getContext()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="beginReporting()"><!-- --></A><H3> |
| beginReporting</H3> |
| <PRE> |
| public void <B>beginReporting</B>()</PRE> |
| <DL> |
| <DD>Pro forma notification sent before reporting a batch of |
| completion proposals. |
| <p> |
| The default implementation of this method does nothing. |
| Clients may override. |
| </p> |
| |
| Subclasses may extend, but must call the super implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#beginReporting()">beginReporting</A></CODE> in class <CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="completionFailure(org.eclipse.wst.jsdt.core.compiler.IProblem)"><!-- --></A><H3> |
| completionFailure</H3> |
| <PRE> |
| public void <B>completionFailure</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/compiler/IProblem.html" title="interface in org.eclipse.wst.jsdt.core.compiler">IProblem</A> problem)</PRE> |
| <DL> |
| <DD>Notification of failure to produce any completions. |
| The problem object explains what prevented completing. |
| <p> |
| The default implementation of this method does nothing. |
| Clients may override to receive this kind of notice. |
| </p> |
| |
| Subclasses may extend, but must call the super implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#completionFailure(org.eclipse.wst.jsdt.core.compiler.IProblem)">completionFailure</A></CODE> in class <CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>problem</CODE> - the problem object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="endReporting()"><!-- --></A><H3> |
| endReporting</H3> |
| <PRE> |
| public void <B>endReporting</B>()</PRE> |
| <DL> |
| <DD>Pro forma notification sent after reporting a batch of |
| completion proposals. |
| <p> |
| The default implementation of this method does nothing. |
| Clients may override. |
| </p> |
| |
| Subclasses may extend, but must call the super implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#endReporting()">endReporting</A></CODE> in class <CODE><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core">CompletionRequestor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorMessage()"><!-- --></A><H3> |
| getErrorMessage</H3> |
| <PRE> |
| public java.lang.String <B>getErrorMessage</B>()</PRE> |
| <DL> |
| <DD>Returns an error message about any error that may have occurred during |
| code completion, or the empty string if none. |
| <p> |
| Subclasses may replace or extend. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an error message or the empty string</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getJavaCompletionProposals()"><!-- --></A><H3> |
| getJavaCompletionProposals</H3> |
| <PRE> |
| public final <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposal.html" title="interface in org.eclipse.wst.jsdt.ui.text.java">IJavaCompletionProposal</A>[] <B>getJavaCompletionProposals</B>()</PRE> |
| <DL> |
| <DD>Returns the unsorted list of received proposals. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the unsorted list of received proposals</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeywordCompletionProposals()"><!-- --></A><H3> |
| getKeywordCompletionProposals</H3> |
| <PRE> |
| public final org.eclipse.wst.jsdt.internal.ui.text.java.JavaCompletionProposal[] <B>getKeywordCompletionProposals</B>()</PRE> |
| <DL> |
| <DD>Returns the unsorted list of received keyword proposals. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the unsorted list of received keyword proposals</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setReplacementLength(int)"><!-- --></A><H3> |
| setReplacementLength</H3> |
| <PRE> |
| public final void <B>setReplacementLength</B>(int length)</PRE> |
| <DL> |
| <DD>If the replacement length is set, it overrides the length returned from |
| the content assist infrastructure. Use this setting if code assist is |
| called with a none empty selection. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>length</CODE> - the new replacement length, relative to the code assist |
| offset. Must be equal to or greater than zero.</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/CompletionProposalCollector.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/ui/text/java/AbstractProposalSorter.html" title="class in org.eclipse.wst.jsdt.ui.text.java"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalComparator.html" title="class in org.eclipse.wst.jsdt.ui.text.java"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CompletionProposalCollector.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
