| <!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:46 CDT 2008 --> |
| <TITLE> |
| CompletionRequestor |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.CompletionRequestor class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="CompletionRequestor"; |
| } |
| </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/CompletionRequestor.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/CompletionProposal.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CorrectionEngine.html" title="class 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/CompletionRequestor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CompletionRequestor.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.core</FONT> |
| <BR> |
| Class CompletionRequestor</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.CompletionRequestor</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/ui/text/java/CompletionProposalCollector.html" title="class in org.eclipse.wst.jsdt.ui.text.java">CompletionProposalCollector</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>CompletionRequestor</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Abstract base class for a completion requestor which is passed completion |
| proposals as they are generated in response to a code assist request. |
| <p> |
| This class is intended to be subclassed by clients. |
| </p> |
| <p> |
| The code assist engine normally invokes methods on completion |
| requestor in the following sequence: |
| <pre> |
| requestor.beginReporting(); |
| requestor.acceptContext(context); |
| requestor.accept(proposal_1); |
| requestor.accept(proposal_2); |
| ... |
| requestor.endReporting(); |
| </pre> |
| If, however, the engine is unable to offer completion proposals |
| for whatever reason, <code>completionFailure</code> is called |
| with a problem object describing why completions were unavailable. |
| In this case, the sequence of calls is: |
| <pre> |
| requestor.beginReporting(); |
| requestor.acceptContext(context); |
| requestor.completionFailure(problem); |
| requestor.endReporting(); |
| </pre> |
| In either case, the bracketing <code>beginReporting</code> |
| <code>endReporting</code> calls are always made as well as |
| <code>acceptContext</code> call. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICodeAssist.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>Provisional API: This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves.</CODE></A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== 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/core/CompletionRequestor.html#CompletionRequestor()">CompletionRequestor</A></B>()</CODE> |
| |
| <BR> |
| Creates a new completion requestor.</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>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.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.</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/CompletionRequestor.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.</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/CompletionRequestor.html#beginReporting()">beginReporting</A></B>()</CODE> |
| |
| <BR> |
| Pro forma notification sent before reporting a batch of |
| completion 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/core/CompletionRequestor.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.</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/CompletionRequestor.html#endReporting()">endReporting</A></B>()</CODE> |
| |
| <BR> |
| Pro forma notification sent after reporting a batch of |
| completion proposals.</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/CompletionRequestor.html#getFavoriteReferences()">getFavoriteReferences</A></B>()</CODE> |
| |
| <BR> |
| Returns the favorite references which are used to compute some completion proposals.</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/CompletionRequestor.html#isAllowingRequiredProposals(int, int)">isAllowingRequiredProposals</A></B>(int proposalKind, |
| int requiredProposalKind)</CODE> |
| |
| <BR> |
| Returns whether a proposal of a given kind with a required proposal |
| of the given kind is allowed.</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/CompletionRequestor.html#isIgnored(int)">isIgnored</A></B>(int completionProposalKind)</CODE> |
| |
| <BR> |
| Returns whether the given kind of completion proposal is ignored.</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/CompletionRequestor.html#setAllowsRequiredProposals(int, int, boolean)">setAllowsRequiredProposals</A></B>(int proposalKind, |
| int requiredProposalKind, |
| boolean allow)</CODE> |
| |
| <BR> |
| Sets whether a proposal of a given kind with a required proposal |
| of the given kind is allowed.</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/CompletionRequestor.html#setFavoriteReferences(java.lang.String[])">setFavoriteReferences</A></B>(java.lang.String[] favoriteImports)</CODE> |
| |
| <BR> |
| Set the favorite references which will be used to compute some completion 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/core/CompletionRequestor.html#setIgnored(int, boolean)">setIgnored</A></B>(int completionProposalKind, |
| boolean ignore)</CODE> |
| |
| <BR> |
| Sets whether the given kind of completion proposal is ignored.</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="CompletionRequestor()"><!-- --></A><H3> |
| CompletionRequestor</H3> |
| <PRE> |
| public <B>CompletionRequestor</B>()</PRE> |
| <DL> |
| <DD>Creates a new completion requestor. |
| The requestor is interested in all kinds of completion |
| proposals; none will be ignored. |
| <P> |
| </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="isIgnored(int)"><!-- --></A><H3> |
| isIgnored</H3> |
| <PRE> |
| public boolean <B>isIgnored</B>(int completionProposalKind)</PRE> |
| <DL> |
| <DD>Returns whether the given kind of completion proposal is ignored. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>completionProposalKind</CODE> - one of the kind constants declared |
| on <code>CompletionProposal</code> |
| <DT><B>Returns:</B><DD><code>true</code> if the given kind of completion proposal |
| is ignored by this requestor, and <code>false</code> if it is of |
| interest<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#setIgnored(int, boolean)"><CODE>setIgnored(int, boolean)</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getKind()"><CODE>CompletionProposal.getKind()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIgnored(int, boolean)"><!-- --></A><H3> |
| setIgnored</H3> |
| <PRE> |
| public void <B>setIgnored</B>(int completionProposalKind, |
| boolean ignore)</PRE> |
| <DL> |
| <DD>Sets whether the given kind of completion proposal is ignored. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>completionProposalKind</CODE> - one of the kind constants declared |
| on <code>CompletionProposal</code><DD><CODE>ignore</CODE> - <code>true</code> if the given kind of completion proposal |
| is ignored by this requestor, and <code>false</code> if it is of |
| interest<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#isIgnored(int)"><CODE>isIgnored(int)</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getKind()"><CODE>CompletionProposal.getKind()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isAllowingRequiredProposals(int, int)"><!-- --></A><H3> |
| isAllowingRequiredProposals</H3> |
| <PRE> |
| public boolean <B>isAllowingRequiredProposals</B>(int proposalKind, |
| int requiredProposalKind)</PRE> |
| <DL> |
| <DD>Returns whether a proposal of a given kind with a required proposal |
| of the given kind is allowed. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>proposalKind</CODE> - one of the kind constants declared<DD><CODE>requiredProposalKind</CODE> - one of the kind constants declared |
| on <code>CompletionProposal</code> |
| <DT><B>Returns:</B><DD><code>true</code> if a proposal of a given kind with a required proposal |
| of the given kind is allowed by this requestor, and <code>false</code> |
| if it isn't of interest. |
| <p> |
| By default, all kinds of required proposals aren't allowed. |
| </p><DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#setAllowsRequiredProposals(int, int, boolean)"><CODE>setAllowsRequiredProposals(int, int, boolean)</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getKind()"><CODE>CompletionProposal.getKind()</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getRequiredProposals()"><CODE>CompletionProposal.getRequiredProposals()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAllowsRequiredProposals(int, int, boolean)"><!-- --></A><H3> |
| setAllowsRequiredProposals</H3> |
| <PRE> |
| public void <B>setAllowsRequiredProposals</B>(int proposalKind, |
| int requiredProposalKind, |
| boolean allow)</PRE> |
| <DL> |
| <DD>Sets whether a proposal of a given kind with a required proposal |
| of the given kind is allowed. |
| |
| Currently only a subset of kinds support required proposals. To see what combinations |
| are supported you must look at <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getRequiredProposals()"><CODE>CompletionProposal.getRequiredProposals()</CODE></A> |
| documentation. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>proposalKind</CODE> - one of the kind constants declared<DD><CODE>requiredProposalKind</CODE> - one of the kind constants declared |
| on <code>CompletionProposal</code><DD><CODE>allow</CODE> - <code>true</code> if a proposal of a given kind with a required proposal |
| of the given kind is allowed by this requestor, and <code>false</code> |
| if it isn't of interest<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#isAllowingRequiredProposals(int, int)"><CODE>isAllowingRequiredProposals(int, int)</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getKind()"><CODE>CompletionProposal.getKind()</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionProposal.html#getRequiredProposals()"><CODE>CompletionProposal.getRequiredProposals()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFavoriteReferences()"><!-- --></A><H3> |
| getFavoriteReferences</H3> |
| <PRE> |
| public java.lang.String[] <B>getFavoriteReferences</B>()</PRE> |
| <DL> |
| <DD>Returns the favorite references which are used to compute some completion proposals. |
| <p> |
| Currently only on demand type references (<code>"java.util.Arrays.*"</code>), |
| references to a static method or a static field are used to compute completion proposals. |
| Other kind of reference could be used in the future. |
| </p> |
| <p><b>Note: This Method only applies to ECMAScript 4 which is not yet supported</b></p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>favorite imports</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFavoriteReferences(java.lang.String[])"><!-- --></A><H3> |
| setFavoriteReferences</H3> |
| <PRE> |
| public void <B>setFavoriteReferences</B>(java.lang.String[] favoriteImports)</PRE> |
| <DL> |
| <DD>Set the favorite references which will be used to compute some completion proposals. |
| A favorite reference is a qualified reference as it can be seen in an import statement.<br> |
| |
| <p><b>Note: This Method only applies to ECMAScript 4 which is not yet supported</b></p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>favoriteImports</CODE> - <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionRequestor.html#getFavoriteReferences()"><CODE>getFavoriteReferences()</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> |
| <P> |
| <DD><DL> |
| </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> |
| <P> |
| <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> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>problem</CODE> - the problem object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="accept(org.eclipse.wst.jsdt.core.CompletionProposal)"><!-- --></A><H3> |
| accept</H3> |
| <PRE> |
| public abstract 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>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> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>proposal</CODE> - the completion proposal |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the proposal is null</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>accept(CompletionProposal)</CODE></A>. |
| The default implementation of this method does nothing. |
| Clients may override. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the completion context</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/CompletionRequestor.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/CompletionProposal.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CorrectionEngine.html" title="class 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/CompletionRequestor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CompletionRequestor.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> |
