|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Implementors of this interface represent the result of a search. How the
results of a search are structured is up to the implementor of this
interface. The abstract base implementation provided with
AbstractTextSearchResult
uses a flat list of matches to represent the result of a search. Subclasses
of SearchResultEvent
can be used in order to notify listeners
of search result changes.
To present search results to the user implementors of this interface must
also provide an extension for the extension point
org.eclipse.search.searchResultViewPage
.
Clients may implement this interface.
ISearchResultPage
Method Summary | |
---|---|
void |
addListener(ISearchResultListener l)
Adds a ISearchResultListener . |
ImageDescriptor |
getImageDescriptor()
Returns an image descriptor for the given ISearchResult. |
String |
getLabel()
Returns a user readable label for this search result. |
ISearchQuery |
getQuery()
Returns the query that produced this search result. |
String |
getTooltip()
Returns a tooltip to be used when this search result is shown in the UI. |
void |
removeListener(ISearchResultListener l)
Removes a ISearchResultChangedListener . |
Method Detail |
public void addListener(ISearchResultListener l)
ISearchResultListener
. Has no effect when the
listener has already been added.
l
- the listener to be addedpublic void removeListener(ISearchResultListener l)
ISearchResultChangedListener
. Has no effect
when the listener hasn't previously been added.
l
- the listener to be removedpublic String getLabel()
public String getTooltip()
public ImageDescriptor getImageDescriptor()
null
public ISearchQuery getQuery()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.