Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.search.ui
Interface ISearchResult

All Known Implementing Classes:
AbstractTextSearchResult

public interface ISearchResult

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.

Since:
3.0
See Also:
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

addListener

void addListener(
ISearchResultListener l)
Adds a ISearchResultListener. Has no effect when the listener has already been added.

Parameters:
l - the listener to be added

removeListener

void removeListener(
ISearchResultListener l)
Removes a ISearchResultChangedListener. Has no effect when the listener hasn't previously been added.

Parameters:
l - the listener to be removed

getLabel

String getLabel()
Returns a user readable label for this search result. The label is typically used in the result view and should contain the search query string and number of matches.

Returns:
the label for this search result

getTooltip

String getTooltip()
Returns a tooltip to be used when this search result is shown in the UI.

Returns:
a user readable String

getImageDescriptor

ImageDescriptor getImageDescriptor()
Returns an image descriptor for the given ISearchResult.

Returns:
an image representing this search result or null

getQuery

ISearchQuery getQuery()
Returns the query that produced this search result.

Returns:
the query producing this result

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire