Class eclipse.Searcher
Provides API for searching the workspace.
Defined in: </shared/eclipse/e4/orion/I201106080905/plugins/org.eclipse.orion.client.core/web/orion/searchClient.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
eclipse.Searcher(options)
|
| Method Attributes | Method Name and Description |
|---|---|
|
formatHighlight(str)
|
|
|
handleError(response, resultsNode)
|
|
|
saveSearch(favoriteName, query)
|
|
|
search(resultsNode, query, excludeFile, generateHeading, onResultReady, hideSummaries)
Runs a search and displays the results under the given DOM node.
|
|
| <inner> |
Searcher(options)
|
|
showSearchResult(resultsNode, query, excludeFile, generateHeading, onResultReady, hideSummaries, jsonData)
|
Class Detail
eclipse.Searcher(options)
- Parameters:
- options
- The options object containing the service registry
Method Detail
{DomNode}
formatHighlight(str)
- Parameters:
- {String} str
- The highlight string we got from the server
- Returns:
- {DomNode}
handleError(response, resultsNode)
- Parameters:
- response
- resultsNode
saveSearch(favoriteName, query)
- Parameters:
- favoriteName
- query
search(resultsNode, query, excludeFile, generateHeading, onResultReady, hideSummaries)
Runs a search and displays the results under the given DOM node.
- Parameters:
- {DOMNode} resultsNode
- Node under which results will be added.
- {String} query
- URI of the query to run.
- {String} excludeFile Optional
- URI of a file to exclude from the result listing.
- {Boolean} generateHeading Optional
- generate a heading for the results
- {Function(DOMNode)} onResultReady Optional
- If any results were found, this is called on the resultsNode.
- {Boolean} hideSummaries Optional
- Don't show the summary of what matched beside each result.
<inner>
Searcher(options)
- Parameters:
- options
showSearchResult(resultsNode, query, excludeFile, generateHeading, onResultReady, hideSummaries, jsonData)
- Parameters:
- resultsNode
- query
- excludeFile
- generateHeading
- onResultReady
- hideSummaries
- jsonData