Browser

Identifier: org.eclipse.help.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 (factoryclass)>

   <!ATTLIST browser
     id           CDATA #REQUIRED
     factoryclass CDATA #IMPLIED
     name         CDATA #REQUIRED
   >

   <!ELEMENT factoryclass (parameter*)>

   <!ATTLIST factoryclass
     class CDATA #REQUIRED
   >

   <!ELEMENT parameter EMPTY>

   <!ATTLIST parameter
     name  CDATA #REQUIRED
     value CDATA #REQUIRED
   >

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

 <extension point="org.eclipse.help.browser">
  <browser 
   id="org.eclipse.myPlugin.myBrowserID"
   factoryClass="org.eclipse.myPlugin.myPackage.MyFactoryClass"
   name="My Browser">
  </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 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, 2003 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html