| <!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> |
| IJavaCompletionProposalComputer |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.ui.text.java.IJavaCompletionProposalComputer interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IJavaCompletionProposalComputer"; |
| } |
| </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/IJavaCompletionProposalComputer.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/IJavaCompletionProposal.html" title="interface in org.eclipse.wst.jsdt.ui.text.java"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavadocCompletionProcessor.html" title="interface 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/IJavaCompletionProposalComputer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavaCompletionProposalComputer.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.ui.text.java</FONT> |
| <BR> |
| Interface IJavaCompletionProposalComputer</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IJavaCompletionProposalComputer</B></DL> |
| </PRE> |
| |
| <P> |
| Computes completions and context information displayed by the JavaScript editor content assistant. |
| Contributions to the <tt>org.eclipse.wst.jsdt.ui.javaCompletionProposalComputer</tt> extension point |
| must implement this interface. |
| |
| |
| 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> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#computeCompletionProposals(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)">computeCompletionProposals</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/ContentAssistInvocationContext.html" title="class in org.eclipse.wst.jsdt.ui.text.java">ContentAssistInvocationContext</A> context, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Returns a list of completion proposals valid at the given invocation context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#computeContextInformation(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)">computeContextInformation</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/ContentAssistInvocationContext.html" title="class in org.eclipse.wst.jsdt.ui.text.java">ContentAssistInvocationContext</A> context, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Returns context information objects valid at the given invocation context.</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/IJavaCompletionProposalComputer.html#getErrorMessage()">getErrorMessage</A></B>()</CODE> |
| |
| <BR> |
| Returns the reason why this computer was unable to produce any completion proposals or |
| context information.</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/IJavaCompletionProposalComputer.html#sessionEnded()">sessionEnded</A></B>()</CODE> |
| |
| <BR> |
| Informs the computer that a content assist session has ended.</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/IJavaCompletionProposalComputer.html#sessionStarted()">sessionStarted</A></B>()</CODE> |
| |
| <BR> |
| Informs the computer that a content assist session has started.</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="sessionStarted()"><!-- --></A><H3> |
| sessionStarted</H3> |
| <PRE> |
| void <B>sessionStarted</B>()</PRE> |
| <DL> |
| <DD>Informs the computer that a content assist session has started. This call will always be |
| followed by a <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#sessionEnded()"><CODE>sessionEnded()</CODE></A> call, but not necessarily by calls to |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#computeCompletionProposals(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)">computeCompletionProposals</A> |
| or |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#computeContextInformation(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)">computeContextInformation</A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="computeCompletionProposals(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)"><!-- --></A><H3> |
| computeCompletionProposals</H3> |
| <PRE> |
| java.util.List <B>computeCompletionProposals</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/ContentAssistInvocationContext.html" title="class in org.eclipse.wst.jsdt.ui.text.java">ContentAssistInvocationContext</A> context, |
| IProgressMonitor monitor)</PRE> |
| <DL> |
| <DD>Returns a list of completion proposals valid at the given invocation context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the context of the content assist invocation<DD><CODE>monitor</CODE> - a progress monitor to report progress. The monitor is private to this |
| invocation, i.e. there is no need for the receiver to spawn a sub monitor. |
| <DT><B>Returns:</B><DD>a list of completion proposals (element type: <CODE>org.eclipse.jface.text.contentassist.ICompletionProposal</CODE>)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="computeContextInformation(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)"><!-- --></A><H3> |
| computeContextInformation</H3> |
| <PRE> |
| java.util.List <B>computeContextInformation</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/ContentAssistInvocationContext.html" title="class in org.eclipse.wst.jsdt.ui.text.java">ContentAssistInvocationContext</A> context, |
| IProgressMonitor monitor)</PRE> |
| <DL> |
| <DD>Returns context information objects valid at the given invocation context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the context of the content assist invocation<DD><CODE>monitor</CODE> - a progress monitor to report progress. The monitor is private to this |
| invocation, i.e. there is no need for the receiver to spawn a sub monitor. |
| <DT><B>Returns:</B><DD>a list of context information objects (element type: <CODE>org.eclipse.jface.text.contentassist.IContextInformation</CODE>)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorMessage()"><!-- --></A><H3> |
| getErrorMessage</H3> |
| <PRE> |
| java.lang.String <B>getErrorMessage</B>()</PRE> |
| <DL> |
| <DD>Returns the reason why this computer was unable to produce any completion proposals or |
| context information. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an error message or <code>null</code> if no error occurred</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="sessionEnded()"><!-- --></A><H3> |
| sessionEnded</H3> |
| <PRE> |
| void <B>sessionEnded</B>()</PRE> |
| <DL> |
| <DD>Informs the computer that a content assist session has ended. This call will always be after |
| any calls to |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#computeCompletionProposals(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)">computeCompletionProposals</A> |
| and |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposalComputer.html#computeContextInformation(org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext, IProgressMonitor)">computeContextInformation</A>. |
| <P> |
| <DD><DL> |
| </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/IJavaCompletionProposalComputer.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/IJavaCompletionProposal.html" title="interface in org.eclipse.wst.jsdt.ui.text.java"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavadocCompletionProcessor.html" title="interface 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/IJavaCompletionProposalComputer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavaCompletionProposalComputer.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> |
