| <!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:06 CDT 2008 --> |
| <TITLE> |
| JsSearchSupport |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.web.core.javascript.search.JsSearchSupport class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="JsSearchSupport"; |
| } |
| </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/JsSearchSupport.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/web/core/javascript/search/JsSearchScope.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../../index.html?org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JsSearchSupport.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.web.core.javascript.search</FONT> |
| <BR> |
| Class JsSearchSupport</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.web.core.javascript.search.JsSearchSupport</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>JsSearchSupport</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <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. |
| (copied from JSP) |
| Central access to java indexing and search. All contact between JDT indexing |
| and Searching should be done through here. |
| |
| Clients should access the methods of this class via the single instance via |
| <code>getInstance()</code>. |
| <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> <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#addJspFile(IFile)">addJspFile</A></B>(IFile file)</CODE> |
| |
| <BR> |
| schedules a search document representing this JSP file for indexing (by |
| the java indexer)</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IPath</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#computeIndexLocation(IPath)">computeIndexLocation</A></B>(IPath containerPath)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search">JsSearchSupport</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#getInstance()">getInstance</A></B>()</CODE> |
| |
| <BR> |
| Clients should access the methods of this class via the single instance |
| via getInstance()</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IPath</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#getModelJspPluginWorkingLocation()">getModelJspPluginWorkingLocation</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IPath</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#getModelJspPluginWorkingLocation(IProject)">getModelJspPluginWorkingLocation</A></B>(IProject project)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IProgressMonitor</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#getProgressMonitor()">getProgressMonitor</A></B>()</CODE> |
| |
| <BR> |
| JSP Indexing and Search jobs check this</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#getSearchDocument(java.lang.String)">getSearchDocument</A></B>(java.lang.String searchDocPath)</CODE> |
| |
| <BR> |
| Centralized place to access JSPSearchDocuments (used by |
| JSPSearchParticipant and JSPSearchRequestor)</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/web/core/javascript/search/JsSearchSupport.html#isCanceled()">isCanceled</A></B>()</CODE> |
| |
| <BR> |
| JSP Indexing and Search jobs check this</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html#isJsp(IFile)">isJsp</A></B>(IFile file)</CODE> |
| |
| <BR> |
| Utility method to check if a file is a jsp file (since this is done |
| frequently)</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/web/core/javascript/search/JsSearchSupport.html#search(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.SearchRequestor)">search</A></B>(<A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> element, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor)</CODE> |
| |
| <BR> |
| Search for an IJavaScriptElement, constrained by the given parameters.</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/web/core/javascript/search/JsSearchSupport.html#search(java.lang.String, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, int, int, int, boolean, org.eclipse.wst.jsdt.core.search.SearchRequestor)">search</A></B>(java.lang.String searchText, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| int searchFor, |
| int limitTo, |
| int matchMode, |
| boolean isCaseSensitive, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor)</CODE> |
| |
| <BR> |
| Perform a java search w/ the given parameters.</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/web/core/javascript/search/JsSearchSupport.html#searchRunnable(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.SearchRequestor)">searchRunnable</A></B>(<A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> element, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor)</CODE> |
| |
| <BR> |
| Search for an IJavaScriptElement, constrained by the given parameters.</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/web/core/javascript/search/JsSearchSupport.html#setCanceled(boolean)">setCanceled</A></B>(boolean cancel)</CODE> |
| |
| <BR> |
| JSP Indexing and Search jobs check this</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> |
| |
| <!-- ============ 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="getInstance()"><!-- --></A><H3> |
| getInstance</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search">JsSearchSupport</A> <B>getInstance</B>()</PRE> |
| <DL> |
| <DD>Clients should access the methods of this class via the single instance |
| via getInstance() |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isJsp(IFile)"><!-- --></A><H3> |
| isJsp</H3> |
| <PRE> |
| public static boolean <B>isJsp</B>(IFile file)</PRE> |
| <DL> |
| <DD>Utility method to check if a file is a jsp file (since this is done |
| frequently) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addJspFile(IFile)"><!-- --></A><H3> |
| addJspFile</H3> |
| <PRE> |
| public <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A> <B>addJspFile</B>(IFile file)</PRE> |
| <DL> |
| <DD>schedules a search document representing this JSP file for indexing (by |
| the java indexer) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - the JSP file |
| <DT><B>Returns:</B><DD>true if indexing was successful, false otherwise |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="search(java.lang.String, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, int, int, int, boolean, org.eclipse.wst.jsdt.core.search.SearchRequestor)"><!-- --></A><H3> |
| search</H3> |
| <PRE> |
| public void <B>search</B>(java.lang.String searchText, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| int searchFor, |
| int limitTo, |
| int matchMode, |
| boolean isCaseSensitive, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor)</PRE> |
| <DL> |
| <DD>Perform a java search w/ the given parameters. Runs in a background Job |
| (results may still come in after this method call) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>searchText</CODE> - the string of text to search on<DD><CODE>searchFor</CODE> - IJavaScriptSearchConstants.TYPE, METHOD, FIELD, PACKAGE, etc...<DD><CODE>limitTo</CODE> - IJavaScriptSearchConstants.DECLARATIONS, |
| IJavaScriptSearchConstants.REFERENCES, |
| IJavaScriptSearchConstants.IMPLEMENTORS, or |
| IJavaScriptSearchConstants.ALL_OCCURRENCES<DD><CODE>matchMode</CODE> - allow * wildcards or not<DD><CODE>isCaseSensitive</CODE> - <DD><CODE>requestor</CODE> - passed in to accept search matches (and do "something" with |
| them)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="search(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.SearchRequestor)"><!-- --></A><H3> |
| search</H3> |
| <PRE> |
| public void <B>search</B>(<A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> element, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor)</PRE> |
| <DL> |
| <DD>Search for an IJavaScriptElement, constrained by the given parameters. Runs in |
| a background Job (results may still come in after this method call) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>element</CODE> - <DD><CODE>scope</CODE> - <DD><CODE>requestor</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchRunnable(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.SearchRequestor)"><!-- --></A><H3> |
| searchRunnable</H3> |
| <PRE> |
| public void <B>searchRunnable</B>(<A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> element, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor)</PRE> |
| <DL> |
| <DD>Search for an IJavaScriptElement, constrained by the given parameters. Runs in |
| an IWorkspace runnable (results will be reported by the end of this |
| method) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>element</CODE> - <DD><CODE>scope</CODE> - <DD><CODE>requestor</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSearchDocument(java.lang.String)"><!-- --></A><H3> |
| getSearchDocument</H3> |
| <PRE> |
| public <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A> <B>getSearchDocument</B>(java.lang.String searchDocPath)</PRE> |
| <DL> |
| <DD>Centralized place to access JSPSearchDocuments (used by |
| JSPSearchParticipant and JSPSearchRequestor) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>searchDocPath</CODE> - <DD><CODE>doc</CODE> - |
| <DT><B>Returns:</B><DD>the JSPSearchDocument or null if one is not found</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="computeIndexLocation(IPath)"><!-- --></A><H3> |
| computeIndexLocation</H3> |
| <PRE> |
| public final IPath <B>computeIndexLocation</B>(IPath containerPath)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getModelJspPluginWorkingLocation(IProject)"><!-- --></A><H3> |
| getModelJspPluginWorkingLocation</H3> |
| <PRE> |
| public IPath <B>getModelJspPluginWorkingLocation</B>(IProject project)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getModelJspPluginWorkingLocation()"><!-- --></A><H3> |
| getModelJspPluginWorkingLocation</H3> |
| <PRE> |
| public IPath <B>getModelJspPluginWorkingLocation</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCanceled(boolean)"><!-- --></A><H3> |
| setCanceled</H3> |
| <PRE> |
| public final void <B>setCanceled</B>(boolean cancel)</PRE> |
| <DL> |
| <DD>JSP Indexing and Search jobs check this |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isCanceled()"><!-- --></A><H3> |
| isCanceled</H3> |
| <PRE> |
| public final boolean <B>isCanceled</B>()</PRE> |
| <DL> |
| <DD>JSP Indexing and Search jobs check this |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProgressMonitor()"><!-- --></A><H3> |
| getProgressMonitor</H3> |
| <PRE> |
| public final IProgressMonitor <B>getProgressMonitor</B>()</PRE> |
| <DL> |
| <DD>JSP Indexing and Search jobs check this |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD></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/JsSearchSupport.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/web/core/javascript/search/JsSearchScope.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../../index.html?org/eclipse/wst/jsdt/web/core/javascript/search/JsSearchSupport.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JsSearchSupport.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> |