|
Eclipse JDT Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IQueryParticipant
This is the interface expected of extensions to the extension point
org.eclipse.jdt.ui.queryParticipants.
A IQueryParticipant is called during the execution of a
Java 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.
| Method Summary | |
|---|---|
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 Java search UI. |
void |
search(ISearchRequestor requestor,
QuerySpecification querySpecification,
IProgressMonitor monitor)
Executes the search described by the given querySpecification. |
| Method Detail |
|---|
void search(ISearchRequestor requestor,
QuerySpecification querySpecification,
IProgressMonitor monitor)
throws CoreException
querySpecification. Matches are reported
to the given requester.
The interpretation of what a given Java 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()
IJavaElement and IResource.
A participant may return null if matches are only reported against elements of type IResource and IJavaElement.
null.
|
Eclipse JDT Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2010 IBM Corporation and others. All rights reserved.