| <!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> |
| IJavadocCompletionProcessor |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.ui.text.java.IJavadocCompletionProcessor interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IJavadocCompletionProcessor"; |
| } |
| </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/IJavadocCompletionProcessor.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/IJavaCompletionProposalComputer.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/IProblemLocation.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/IJavadocCompletionProcessor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavadocCompletionProcessor.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | 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 IJavadocCompletionProcessor</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IJavadocCompletionProcessor</B></DL> |
| </PRE> |
| |
| <P> |
| A Javadoc processor proposes completions and computes |
| context information for a particular content type. |
| <p> |
| This interface must be implemented by clients who extend the |
| <code>org.eclipse.wst.jsdt.ui.javadocCompletionProcessor</code> extension-point</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> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavadocCompletionProcessor.html#RESTRICT_TO_MATCHING_CASE">RESTRICT_TO_MATCHING_CASE</A></B></CODE> |
| |
| <BR> |
| Flag used by <code>computeCompletionProposals</code>.</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> <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/IJavadocCompletionProcessor.html#computeCompletionProposals(org.eclipse.wst.jsdt.core.IJavaScriptUnit, int, int, int)">computeCompletionProposals</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> cu, |
| int offset, |
| int length, |
| int flags)</CODE> |
| |
| <BR> |
| Returns the completion proposals based on the specified location |
| within the compilation unit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IContextInformation[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavadocCompletionProcessor.html#computeContextInformation(org.eclipse.wst.jsdt.core.IJavaScriptUnit, int)">computeContextInformation</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> cu, |
| int offset)</CODE> |
| |
| <BR> |
| Returns information about possible contexts based on the |
| specified location within the compilation unit.</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/IJavadocCompletionProcessor.html#getErrorMessage()">getErrorMessage</A></B>()</CODE> |
| |
| <BR> |
| Returns the reason why this completion processor was unable |
| to produce a completion proposals or context information.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="RESTRICT_TO_MATCHING_CASE"><!-- --></A><H3> |
| RESTRICT_TO_MATCHING_CASE</H3> |
| <PRE> |
| static final int <B>RESTRICT_TO_MATCHING_CASE</B></PRE> |
| <DL> |
| <DD>Flag used by <code>computeCompletionProposals</code>. |
| Specifies that only proposals should be returned that match |
| the case of the prefix in the code (value: <code>1</code>). |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.eclipse.wst.jsdt.ui.text.java.IJavadocCompletionProcessor.RESTRICT_TO_MATCHING_CASE">Constant Field Values</A></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="computeContextInformation(org.eclipse.wst.jsdt.core.IJavaScriptUnit, int)"><!-- --></A><H3> |
| computeContextInformation</H3> |
| <PRE> |
| IContextInformation[] <B>computeContextInformation</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> cu, |
| int offset)</PRE> |
| <DL> |
| <DD>Returns information about possible contexts based on the |
| specified location within the compilation unit. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>cu</CODE> - the working copy of the compilation unit which |
| is used to compute the possible contexts<DD><CODE>offset</CODE> - an offset within the compilation unit for |
| which context information should be computed |
| <DT><B>Returns:</B><DD>an array of context information objects or <code>null</code> |
| if no context could be found</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="computeCompletionProposals(org.eclipse.wst.jsdt.core.IJavaScriptUnit, int, int, int)"><!-- --></A><H3> |
| computeCompletionProposals</H3> |
| <PRE> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/ui/text/java/IJavaCompletionProposal.html" title="interface in org.eclipse.wst.jsdt.ui.text.java">IJavaCompletionProposal</A>[] <B>computeCompletionProposals</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> cu, |
| int offset, |
| int length, |
| int flags)</PRE> |
| <DL> |
| <DD>Returns the completion proposals based on the specified location |
| within the compilation unit. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>cu</CODE> - the working copy of the compilation unit in which the |
| completion request has been called.<DD><CODE>offset</CODE> - an offset within the compilation unit for which |
| completion proposals should be computed<DD><CODE>length</CODE> - the length of the current selection.<DD><CODE>flags</CODE> - settings for the code assist. Flags as defined in this interface, |
| e.g. <code>RESTRICT_TO_MATCHING_CASE</code>. |
| <DT><B>Returns:</B><DD>an array of completion proposals or <code>null</code> if |
| no proposals could be found</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 completion processor was unable |
| to produce a 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> |
| <!-- ========= 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/IJavadocCompletionProcessor.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/IJavaCompletionProposalComputer.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/IProblemLocation.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/IJavadocCompletionProcessor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJavadocCompletionProcessor.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
