Browsers

Identifier:
org.eclipse.ui.browser.browsers

Since:
3.0 (originally added in release 2.0 as org.eclipse.help.ui.browser)

Description:
For providing web browsers capable of displaying html documents at a given URL.

Configuration Markup:

<!ELEMENT extension (browser)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT browser (location)*>

<!ATTLIST browser

id           CDATA #REQUIRED

factoryclass CDATA #IMPLIED

name         CDATA #REQUIRED

os           CDATA #IMPLIED

executable   CDATA #IMPLIED>

An external web browser which will be displayed on the preference page General/Web Browsers providing the os attribute matches and a file is found in at least one of the specified locations.



<!ELEMENT location (#PCDATA)>

Default install locations. These locations should not contain the initial path, as it will be substituted with all known drives. E.g. on Windows, a location of "test.exe" would look for "c:\test.exe", "d:\test.exe", etc. for all known drives.

On Windows, the path can also start with an environment variable, e.g. "%%ProgramFiles%\folder\test.exe". Note the double % at the beginning to prevent localization.



Examples:
The following is a sample usage of the browsers extension point:


 <extension point="org.eclipse.ui.browser.browsers">
  <browser
     id="org.eclipse.ui.browser.firefox"
     name="Firefox"
     os="Win32"
     executable="firefox.exe"
     factoryclass="org.eclipse.ui.internal.browser.browsers.MozillaFactory">
       <location>%%ProgramFiles%\Mozilla Firefox\firefox.exe</location>
       <location>%%ProgramFiles(x86)%\Mozilla Firefox\firefox.exe</location>
  </browser>
 </extension>

API Information:
The supplied factory class must implement the org.eclipse.help.browser.IBrowserFactory interface. Methods in that interface determine whether the factory is available on the given system, i.e. is capable of supplying browser instances, and create browser instances that implement IBrowser interface.

Supplied Implementation:
The org.eclipse.help.base and org.eclipse.help.ui plug-ins contain implementation of browsers on common platforms. Other plug-ins can provide different implementations. In the preferences, the user can select the default browser from among available browsers.


Copyright (c) 2000, 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html