net.java.html.boot.fx

Class FXBrowsers

java.lang.Object

net.java.html.boot.fx.FXBrowsers

public final class FXBrowsers
extends Object

Utility methods to use WebView and JavaScriptBody code in existing JavaFX applications. This class is for those who want to instantiate their own WebView, configure it manually, embed it into own JavaFX application and based on other events in the application re-execute code inside of such WebViews.

In case such detailed control is not necessary, consider using BrowserBuilder. Btw. when using the BrowserBuilder one can execute presenter in headless mode. Just specify: System.setProperty("fxpresenter.headless", "true");

Since:

0.6

Author:

Jaroslav Tulach

Method Summary

Modifier and Type	Method and Description
static void	load(javafx.scene.web.WebView webView, URL url, Class<?> onPageLoad, String methodName, String... args) Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.)
static void	load(javafx.scene.web.WebView webView, URL url, Runnable onPageLoad) Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.)
static void	load(javafx.scene.web.WebView webView, URL url, Runnable onPageLoad, ClassLoader loader) Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.)
static void	load(javafx.scene.web.WebView webView, URL url, Runnable onPageLoad, ClassLoader loader, Object... context) Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.)
static void	runInBrowser(javafx.scene.web.WebView webView, Runnable code) Executes a code inside of provided WebView.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static void load(javafx.scene.web.WebView webView,
                        URL url,
                        Class<?> onPageLoad,
                        String methodName,
                        String... args)

Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.) in the provided webView. This method returns immediately. Once the support is active, it calls back specified method in onPageLoad class - the class can possibly be loaded by a different classloader (to enable replacement of methods with JavaScriptBody annotations with executable versions). The method methodName needs to be public (in a public class), static and take either no parameters or an array of Strings.

This method sets Node.getUserData() and FXBrowsers.runInBrowser(javafx.scene.web.WebView, java.lang.Runnable) relies on the value. Please don't alter it.

Since introduction of technology identifiers the provided args strings are also passed to the context when it is being created and can influence the selection of available technologies (like Technology, Transfer or WSTransfer).

Parameters:

webView - the instance of Web View to tweak

url - the URL of the HTML page to load into the view

onPageLoad - callback class with method methodName

methodName - the method to call when the page is loaded

args - arguments to pass to the methodName method

load

public static void load(javafx.scene.web.WebView webView,
                        URL url,
                        Runnable onPageLoad)

Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.) in the provided webView. This method returns immediately. Once the support is active, it calls back specified method in onPageLoad's run method. This is more convenient way to initialize the webview, but it requires one to make sure all JavaScriptBody methods has been post-processed during compilation and there will be no need to instantiate new classloader.

This method sets Node.getUserData() and FXBrowsers.runInBrowser(javafx.scene.web.WebView, java.lang.Runnable) relies on the value. Please don't alter it.

Parameters:

webView - the instance of Web View to tweak

url - the URL of the HTML page to load into the view

onPageLoad - callback to call when the page is ready

Since:

0.8.1

load

public static void load(javafx.scene.web.WebView webView,
                        URL url,
                        Runnable onPageLoad,
                        ClassLoader loader)

Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.) in the provided webView. This method returns immediately. Once the support is active, it calls back run method in onPageLoad. This is more convenient way to initialize the webview, but it requires one to make sure all JavaScriptBody methods has been post-processed during compilation and there will be no need to instantiate new classloader.

This method sets Node.getUserData() and FXBrowsers.runInBrowser(javafx.scene.web.WebView, java.lang.Runnable) relies on the value. Please don't alter it.

Parameters:

webView - the instance of Web View to tweak

url - the URL of the HTML page to load into the view

onPageLoad - callback to call when the page is ready

loader - the loader to use when constructing initial BrwsrCtx or null

Since:

0.9

load

public static void load(javafx.scene.web.WebView webView,
                        URL url,
                        Runnable onPageLoad,
                        ClassLoader loader,
                        Object... context)

Enables the Java/JavaScript bridge (that supports JavaScriptBody and co.) in the provided webView. This method returns immediately. Once the support is active, it calls back run method in onPageLoad. This is more convenient way to initialize the webview, but it requires one to make sure all JavaScriptBody methods has been post-processed during compilation and there will be no need to instantiate new classloader.

This method sets Node.getUserData() and FXBrowsers.runInBrowser(javafx.scene.web.WebView, java.lang.Runnable) relies on the value. Please don't alter it.

Parameters:

webView - the instance of Web View to tweak

url - the URL of the HTML page to load into the view

onPageLoad - callback to call when the page is ready

loader - the loader to use when constructing initial BrwsrCtx or null

context - additonal configuration to pass to BrowserBuilder.newBrowser(java.lang.Object...) and Contexts.newBuilder(java.lang.Object...) factory methods

Since:

1.1

runInBrowser

public static void runInBrowser(javafx.scene.web.WebView webView,
                                Runnable code)

Executes a code inside of provided WebView. This method associates the execution context with provided browser, so the JavaScriptBody annotations know where to execute their JavaScript bodies. The code is going to be executed synchronously in case Platform.isFxApplicationThread() returns true. Otherwise this method returns immediately and the code is executed later via Platform.runLater(java.lang.Runnable).

This method relies on Node.getUserData() being properly provided by the load methods in this class.

Parameters:

webView - the web view previously prepared by one of the load methods in this class

code - the code to execute

Throws:

IllegalArgumentException - if the web view was not properly initialized

Since:

0.8.1

See Also:

BrwsrCtx.execute(java.lang.Runnable)