Package org.eclipse.help.ui.browser

Provides interfaces that need to be implemented by web browser adapters. Also contains an implementation of IWorkbenchWindowActionDelegate for opening a URL in a browser.

See:
Description

Interface Summary

IBrowser	Represents a web browser that can be used by clients to display documents for the given URLs.
IBrowserFactory	Implementators of org.eclipse.help.ui.browsers extension points must provide implementation of this interface.

Class Summary

LaunchURL

Action that launches a URL in a browser.

Package org.eclipse.help.ui.browser Description

Provides interfaces that need to be implemented by web browser adapters. Also contains an implementation of IWorkbenchWindowActionDelegate for opening a URL in a browser.

Package Specification

Help System UI, requires web browser to display help document. Since availability of web browsers differ from system to system, it is possible to configure browser adapters in addition to ones provided by Help System UI plugin. The browser (or browser adapter) can be configured by providing extension org.eclipse.help.ui.browser extension point. If more than one browser is available on a user system, the default browser can be designated in Web Help preference page.

In general terms, implementing a web browser involves:

• Implementing standalone UI element having the IBrowser API, and capable of displaying HTML documents given a URL.
• Providing a factory for managing of browsers on a particular system, by implementing IBrowserFactory interface.
• Declaring an extension of the org.eclipse.help.ui.browser extension point that mentions the name of that factory class.

Note that browser factory will be created on every system. If the factory is not capable of creating a browser on some system configurations, due to missing prerequisites e.t.c., its isAvailable() method should be returning false on these systems.

LaunchURL class implementing IWorkbenchWindowActionDelegate is an action that can be specified in the action element in plugin.xml for extensions of org.eclipse.ui.actionSets extension point. The contributors of menu actions that need to perform launching of URL in a browser, can specify this class as an IWorkbenchWindowActionDelegate in their extension of org.eclipse.ui.actionSets point.