public interface IQueryParticipant
org.eclipse.wst.jsdt.ui.queryParticipants
.
A IQueryParticipant
is called during the execution of a
JavaScript search query. It can report matches via an ISearchRequestor
and
may contribute a IMatchPresentation
to help render the elements it contributes.
Clients may 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.Modifier and Type | Method and Description |
---|---|
int |
estimateTicks(QuerySpecification specification)
Returns the number of units of work estimated.
|
IMatchPresentation |
getUIParticipant()
Gets the UI participant responsible for handling the display of elements not known to the JavaScript search UI.
|
void |
search(ISearchRequestor requestor,
QuerySpecification querySpecification,
IProgressMonitor monitor)
Executes the search described by the given
querySpecification . |
void search(ISearchRequestor requestor, QuerySpecification querySpecification, IProgressMonitor monitor) throws CoreException
querySpecification
. Matches are reported
to the given requester
.
The interpretation of what a given JavaScript search (e.g. "References to class Foo") means is up to the
participant.requestor
- The requester to report matches to.querySpecification
- The specification of the query to run.monitor
- A monitor to report progress on.CoreException
- Thrown when the search can not be executedint estimateTicks(QuerySpecification specification)
specification
- the specification to estimate.IMatchPresentation getUIParticipant()
IJavaScriptElement
and IResource
.
A participant may return null
if matches are only reported against elements of type IResource
and IJavaScriptElement
.null
.Copyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.