Eclipse Platform
Release 3.1

org.eclipse.ui.browser
Class AbstractWorkbenchBrowserSupport

java.lang.Object
  extended byorg.eclipse.ui.browser.AbstractWorkbenchBrowserSupport
All Implemented Interfaces:
IWorkbenchBrowserSupport

public abstract class AbstractWorkbenchBrowserSupport
extends Object
implements IWorkbenchBrowserSupport

Implements IWorkbenchBrowserSupport while leaving some methods to the implementors. Classes that extend this abstract class are meant to be contributed via 'org.eclipse.ui.browserSupport' extension point.

Since:
3.1

Field Summary
 
Fields inherited from interface org.eclipse.ui.browser.IWorkbenchBrowserSupport
AS_EDITOR, AS_EXTERNAL, AS_VIEW, LOCATION_BAR, NAVIGATION_BAR, PERSISTENT, STATUS
 
Constructor Summary
AbstractWorkbenchBrowserSupport()
          The default constructor.
 
Method Summary
 IWebBrowser getExternalBrowser()
          Returns a shared instance of the external web browser.
 boolean isInternalWebBrowserAvailable()
          Tests whether web browser as an SWT widget can be created in this workbench instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.browser.IWorkbenchBrowserSupport
createBrowser, createBrowser
 

Constructor Detail

AbstractWorkbenchBrowserSupport

public AbstractWorkbenchBrowserSupport()
The default constructor.

Method Detail

getExternalBrowser

public IWebBrowser getExternalBrowser()
                               throws PartInitException
Description copied from interface: IWorkbenchBrowserSupport
Returns a shared instance of the external web browser. Clients can use it to share one external browser. The external browser that will be used is subject to browser support implementation. A suggested implementation is to use the operating system's default browser. Implementations that offer users a choice of the web browser should honour the users choice of external browser, with the initial selection being the system default browser.

Specified by:
getExternalBrowser in interface IWorkbenchBrowserSupport
Returns:
the shared instance of the external browser
Throws:
PartInitException - if the operation failed for some reason

isInternalWebBrowserAvailable

public boolean isInternalWebBrowserAvailable()
Description copied from interface: IWorkbenchBrowserSupport
Tests whether web browser as an SWT widget can be created in this workbench instance. If this method returns false, createBrowser would ignore browser styles AS_EDITOR and AS_VIEW and always create an external browser.

Specified by:
isInternalWebBrowserAvailable in interface IWorkbenchBrowserSupport
Returns:
true if internal web browser can be created on this platform, false otherwise.

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.