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 Plug-in Developer Guide
Previous Page Home Next Page

Browser

Identifier:
org.eclipse.help.base.browser

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.

Note: since 3.1, help system uses workbench browser support (see org.eclipse.ui.browserSupport). The extension point described in this document remains to be used for standalone help only. Any custom browser adapters that need to work in the workbench mode need to be moved to the workbench extension point.

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

>

  • id - the unique ID of the browser.
  • factoryclass - the implementation class for the browser factory. This class must implement the org.eclipse.help.browser.IBrowserFactory interface. This attribute may be omitted, and the nested factoryclass element may be provided instead.
  • name - the name of the browser (translatable).

<!ELEMENT factoryclass ( parameter*)>

<!ATTLIST factoryclass

class CDATA #REQUIRED

>

  • class - the implementation class for the browser factory. This class must implement the org.eclipse.help.browser.IBrowserFactory interface.

<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED

>

  • name - name of a parameter passed to the implementation class
  • value - value of a parameter passed to the implementation class

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


 <extension point=
"org.eclipse.help.base.browser"
>
  <browser 
   id=
"org.eclipse.myPlugin.myBrowserID"

   factoryclass=
"org.eclipse.myPlugin.myPackage.MyFactoryClass"

   name=
"My Browser"
>
  </browser>
 </extension>

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 https://www.eclipse.org/legal/epl-v10.html


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