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.help.search
Interface ISearchEngineResult2

All Superinterfaces:
ISearchEngineResult

public interface ISearchEngineResult2
extends ISearchEngineResult

An extension of the search result interface that allows engines to define engine result icon for each search result.

Since:
3.2

Method Summary
 boolean canOpen ()
          Tests whether this result's open action should be delegated to search engine.
  URL getIconURL ()
          Returns an optional URL of the 16x16 icon to be used to render this search result.
  String getId ()
          Returns a unique identifier that can be associated with this search result.
 
Methods inherited from interface org.eclipse.help.search. ISearchEngineResult
getCategory, getDescription, getForceExternalWindow, getHref, getLabel, getScore, toAbsoluteHref
 

Method Detail

getId

String getId()
Returns a unique identifier that can be associated with this search result. Search engines can optionally use this method to pass information on documents that are accessible via hashtables using a unique identifier. This method is typically used when the search result can open by itself.

Returns:
unique identifier associated with this search result or null if not available or not needed.
See Also:
canOpen(), ISearchEngine2.open(String)

getIconURL

URL getIconURL()
Returns an optional URL of the 16x16 icon to be used to render this search result. If not provided, the icon for the engine will be used.

Returns:
the URL of the icon to be used to render this search result or null to use the engine icon.

canOpen

boolean canOpen()
Tests whether this result's open action should be delegated to search engine.

Returns:
true for engines that must open their results using non-standards means, or false for opening the result by the help system using the provided href.

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