| <!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> |
| IQueryParticipant |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.ui.search.IQueryParticipant interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IQueryParticipant"; |
| } |
| </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/IQueryParticipant.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/search/IMatchPresentation.html" title="interface in org.eclipse.wst.jsdt.ui.search"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/ISearchRequestor.html" title="interface in org.eclipse.wst.jsdt.ui.search"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/ui/search/IQueryParticipant.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IQueryParticipant.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.search</FONT> |
| <BR> |
| Interface IQueryParticipant</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IQueryParticipant</B></DL> |
| </PRE> |
| |
| <P> |
| This is the interface expected of extensions to the extension point |
| <code>org.eclipse.wst.jsdt.ui.queryParticipants</code>. |
| <p> |
| A <code>IQueryParticipant</code> is called during the execution of a |
| JavaScript search query. It can report matches via an <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/ISearchRequestor.html" title="interface in org.eclipse.wst.jsdt.ui.search"><CODE>ISearchRequestor</CODE></A> and |
| may contribute a <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/IMatchPresentation.html" title="interface in org.eclipse.wst.jsdt.ui.search"><CODE>IMatchPresentation</CODE></A> to help render the elements it contributes. |
| </p> |
| <p> |
| Clients may implement this interface. |
| </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> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/IQueryParticipant.html#estimateTicks(org.eclipse.wst.jsdt.ui.search.QuerySpecification)">estimateTicks</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/QuerySpecification.html" title="class in org.eclipse.wst.jsdt.ui.search">QuerySpecification</A> specification)</CODE> |
| |
| <BR> |
| Returns the number of units of work estimated.</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/search/IMatchPresentation.html" title="interface in org.eclipse.wst.jsdt.ui.search">IMatchPresentation</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/IQueryParticipant.html#getUIParticipant()">getUIParticipant</A></B>()</CODE> |
| |
| <BR> |
| Gets the UI participant responsible for handling the display of elements not known to the JavaScript search UI.</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/search/IQueryParticipant.html#search(org.eclipse.wst.jsdt.ui.search.ISearchRequestor, org.eclipse.wst.jsdt.ui.search.QuerySpecification, IProgressMonitor)">search</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/ISearchRequestor.html" title="interface in org.eclipse.wst.jsdt.ui.search">ISearchRequestor</A> requestor, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/QuerySpecification.html" title="class in org.eclipse.wst.jsdt.ui.search">QuerySpecification</A> querySpecification, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Executes the search described by the given <code>querySpecification</code>.</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="search(org.eclipse.wst.jsdt.ui.search.ISearchRequestor, org.eclipse.wst.jsdt.ui.search.QuerySpecification, IProgressMonitor)"><!-- --></A><H3> |
| search</H3> |
| <PRE> |
| void <B>search</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/ISearchRequestor.html" title="interface in org.eclipse.wst.jsdt.ui.search">ISearchRequestor</A> requestor, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/QuerySpecification.html" title="class in org.eclipse.wst.jsdt.ui.search">QuerySpecification</A> querySpecification, |
| IProgressMonitor monitor) |
| throws CoreException</PRE> |
| <DL> |
| <DD>Executes the search described by the given <code>querySpecification</code>. Matches are reported |
| to the given <code>requester</code>. |
| The interpretation of what a given JavaScript search (e.g. "References to class Foo") means is up to the |
| participant. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>requestor</CODE> - The requester to report matches to.<DD><CODE>querySpecification</CODE> - The specification of the query to run.<DD><CODE>monitor</CODE> - A monitor to report progress on. |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE> - Thrown when the search can not be executed</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="estimateTicks(org.eclipse.wst.jsdt.ui.search.QuerySpecification)"><!-- --></A><H3> |
| estimateTicks</H3> |
| <PRE> |
| int <B>estimateTicks</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/QuerySpecification.html" title="class in org.eclipse.wst.jsdt.ui.search">QuerySpecification</A> specification)</PRE> |
| <DL> |
| <DD>Returns the number of units of work estimated. The returned number should be normalized such |
| that the number of ticks for the original JavaScript search job is 1000. For example if the participant |
| uses the same amount of time as the JavaScript search, it should return 1000, if it uses half the time, |
| it should return 500, etc. |
| This method is supposed to give a quick estimate of the work to be done and is assumed |
| to be much faster than the actual query. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>specification</CODE> - the specification to estimate. |
| <DT><B>Returns:</B><DD>The number of ticks estimated.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUIParticipant()"><!-- --></A><H3> |
| getUIParticipant</H3> |
| <PRE> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/IMatchPresentation.html" title="interface in org.eclipse.wst.jsdt.ui.search">IMatchPresentation</A> <B>getUIParticipant</B>()</PRE> |
| <DL> |
| <DD>Gets the UI participant responsible for handling the display of elements not known to the JavaScript search UI. The JavaScript search UI knows |
| elements are of type <code>IJavaScriptElement</code> and <code>IResource</code>. |
| A participant may return <code>null</code> if matches are only reported against elements of type <code>IResource</code> and <code>IJavaScriptElement</code>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The UI participant for this query participant or <code>null</code>.</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/IQueryParticipant.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/search/IMatchPresentation.html" title="interface in org.eclipse.wst.jsdt.ui.search"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/search/ISearchRequestor.html" title="interface in org.eclipse.wst.jsdt.ui.search"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/ui/search/IQueryParticipant.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IQueryParticipant.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> |
