oracle.ide.webbrowser

Class BrowserRunner

java.lang.Object

oracle.ide.webbrowser.BrowserRunner

public abstract class BrowserRunner
extends java.lang.Object

The BrowserRunner launches and describes an external web browser.

Constructor Summary

Constructors

Constructor and Description
BrowserRunner()

Method Summary

Modifier and Type	Method and Description
static BrowserRunner	getBrowserRunner() Returns the active BrowserRunner instance.
abstract void	runBrowserOnURL(java.net.URL url, java.io.File htmlFile, java.io.PrintWriter printWriter) Invokes the web browser on url.
void	runBrowserOnURLV2(java.net.URL url, java.io.File htmlFile, java.io.PrintWriter printWriter) Invokes the web browser on url.
static void	setBrowserRunner(BrowserRunner browserRunner) Sets the BrowserRunner instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrowserRunner

public BrowserRunner()

Method Detail

getBrowserRunner

public static BrowserRunner getBrowserRunner()

Returns the active BrowserRunner instance. This instance is usually created and initialized during startup.

setBrowserRunner

public static void setBrowserRunner(BrowserRunner browserRunner)

Sets the BrowserRunner instance. This method is usually called only during startup.

runBrowserOnURL

public abstract void runBrowserOnURL(java.net.URL url,
                                     java.io.File htmlFile,
                                     java.io.PrintWriter printWriter)

Invokes the web browser on url. If the htmlFile is not null, then on Win32 based operating systems, the htmlfile will be launched instead of the URL, as Windows fares better with a redirect from a local .htm[l] file.

Parameters:

url - The URL to launch in the web browser.

htmlFile - The temporary file to use on Windows. This parameter can be null if no temp file is to be used, note however that this could cause the web browser not to launch.

printWriter - The PrintWriter to log any errors returned during the process of launching the web browser. This parameter can be null

runBrowserOnURLV2

public void runBrowserOnURLV2(java.net.URL url,
                              java.io.File htmlFile,
                              java.io.PrintWriter printWriter)
                       throws java.lang.Exception

Invokes the web browser on url. If the htmlFile is not null, then on Win32 based operating systems, the htmlfile will be launched instead of the URL, as Windows fares better with a redirect from a local .htm[l] file. This is version 2 of the runBrowserOnURL, that adds Exception reporting. For compatibility reasons, the default implementation calls the old version.

Parameters:

url - The URL to launch in the web browser.

htmlFile - The temporary file to use on Windows. This parameter can be null if no temp file is to be used, note however that this could cause the web browser not to launch.

printWriter - The PrintWriter to log any errors returned during the process of launching the web browser. This parameter can be null

Throws:

java.lang.Exception