com.dukescript.presenters.jxbrowser

Class JXBrowserPresenter

java.lang.Object

com.dukescript.presenters.jxbrowser.JXBrowserPresenter

All Implemented Interfaces:

Executor, Fn.FromJavaScript, Fn.KeepAlive, Fn.Presenter, Fn.ToJavaScript

public final class JXBrowserPresenter
extends Object
implements Executor

Implementation of a Fn.Presenter. Use via BrowserBuilder to launch whole application or use JXBrowserPresenter.create(java.lang.Class<?>) to instantiate presenter and its component directly. Then access the browser event thread with JXBrowserPresenter.execute(java.lang.Runnable) method.

Constructor Summary

Constructors

Constructor and Description
JXBrowserPresenter() Default constructor.

Method Summary

Modifier and Type	Method and Description
static JXBrowserPresenter	create(Class<?> type) Creates new presenter for given UI component system.
static <T> JXBrowserPresenter	create(Class<T> type, T instance) Creates new presenter for given component.
Fn	defineFn(String code, String... args) Use JavaScriptBody instead of using this method directly.
Fn	defineFn(String code, String[] args, boolean[] keepAlive) Use JavaScriptBody instead of using this method directly.
void	displayPage(URL url, Runnable r) Use BrowserBuilder instead of using this method directly.
void	execute(Runnable command) Entry point to the browser event loop.
<T> T	getComponent(Class<T> type) Obtains the associated component.
void	loadScript(Reader reader) Use JavaScriptResource instead of using this method directly.
Object	toJava(Object js) Internal callback from Fn.FromJavaScript.
Object	toJavaScript(Object value) Internal callback from Fn.ToJavaScript.

Methods inherited from class java.lang.Object

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

Constructor Detail

JXBrowserPresenter

public JXBrowserPresenter()

Default constructor. Used by ServiceLoader. Use JXBrowserPresenter.create(java.lang.Class) for embedding browser into your Swing or JavaFX application.

Method Detail

create

public static JXBrowserPresenter create(Class<?> type)

Creates new presenter for given UI component system. Instantiate the presenter and then call JXBrowserPresenter.getComponent(java.lang.Class) to obtain the element embeddable into UI of the overall application.

Use JXBrowserPresenter.execute(java.lang.Runnable) to execute client code inside of the browser associated with this presenter. Here is an example of embedding the browser into Swing application:

JXBrowserPresenter presenter = JXBrowserPresenter.create(JComponent.class);

final JComponent browser = presenter.getComponent(JComponent.class);
assert browser.getParent() == null : "Component isn't in AWT hierarchy";

JFrame f = new JFrame();
f.getContentPane().add(browser, BorderLayout.CENTER);
f.setVisible(true);

// initial load of the page
final URL pageUrl = getClass().getResource("yourPage.html");
assert pageUrl != null : "Page found";
presenter.displayPage(pageUrl, () -> {
    assert EventQueue.isDispatchThread();
    onPageLoadCode.runInThePresenter();
});

// access the page any time later
presenter.execute(() -> {
    assert EventQueue.isDispatchThread();
    myCode.runInThePresenter();
});

The code to initialize the JavaFX Application is almost the same:

JXBrowserPresenter presenter = JXBrowserPresenter.create(Node.class);

final Node browser = presenter.getComponent(Node.class);
assert browser.getParent() == null : "Node isn't in FX hierarchy";

BorderPane borderPane = new BorderPane();
borderPane.setTop(new Label("JavaFX Label"));
borderPane.setCenter(browser);
Scene scene = new Scene(borderPane);
stage.setTitle("JavaFX and FXBrowserView");
stage.setScene(scene);
stage.show();

// initial load of the page
final URL pageUrl = getClass().getResource("yourPage.html");
assert pageUrl != null : "Page found";
presenter.displayPage(pageUrl, () -> {
    assert Platform.isFxApplicationThread();
    onPageLoadCode.runInThePresenter();
});

// access the page any time later
presenter.execute(() -> {
    assert Platform.isFxApplicationThread();
    myCode.runInThePresenter();
});

Parameters:

type - the type of component to create - either JComponent or Node class

Returns:

new presenter with its JXBrowserPresenter.getComponent(java.lang.Class<T>) method returning instance of associated component

create

public static <T> JXBrowserPresenter create(Class<T> type,
                                            T instance)

Creates new presenter for given component. Create your browser component manually (requires appropriate license) and initialize JXBrowserPresenter for it then.

Use JXBrowserPresenter.execute(java.lang.Runnable) to execute client code inside of the browser associated with this presenter. Here is an example of embedding the BrowserView component into Swing application:

com.teamdev.jxbrowser.chromium.swing.BrowserView bw;
bw = new com.teamdev.jxbrowser.chromium.swing.BrowserView();
JXBrowserPresenter presenter = JXBrowserPresenter.create(JComponent.class, bw);

The code to initialize the JavaFX BrowserView component is almost the same:

com.teamdev.jxbrowser.chromium.javafx.BrowserView bw;
bw = new com.teamdev.jxbrowser.chromium.javafx.BrowserView();
JXBrowserPresenter presenter = JXBrowserPresenter.create(Node.class, bw);

Type Parameters:

T - the type of the component

Parameters:

type - the type of component to create - either JComponent or Node class

instance - either null or instance of BrowserView or BrowserView

Returns:

new presenter with its JXBrowserPresenter.getComponent(java.lang.Class<T>) method returning instance of provided Swing or JavaFX component

getComponent

public <T> T getComponent(Class<T> type)

Obtains the associated component. Can be used to obtain component embeddable into the Swing or JavaFX UI when created with proper factory method arguments.

Type Parameters:

T - the type of requested component

Parameters:

type - the type of requested component - either JComponent or Node

Returns:

either instance of the component or null if the requested type doesn't match

execute

public void execute(Runnable command)

Entry point to the browser event loop. The browser is associated with a single execute thread which client code uses to talk to the browser and the browser to deliver events back to the client. Use this method to schedule any command to run on the browser thread.

This method may be called from any thread - in such case the method returns immedialtely and the command is executed later on the appropriate thread. If the caller is already on the right browser thread, the command is executed immediately before this method returns.

Specified by:

execute in interface Executor

Parameters:

command - the code to execute in the loop

defineFn

public Fn defineFn(String code,
                   String... args)

Use JavaScriptBody instead of using this method directly. Read more in the documentation for net.java.html.js package.

Specified by:

defineFn in interface Fn.Presenter

defineFn

public Fn defineFn(String code,
                   String[] args,
                   boolean[] keepAlive)

Use JavaScriptBody instead of using this method directly. Read more in the documentation for net.java.html.js package.

Specified by:

defineFn in interface Fn.KeepAlive

displayPage

public void displayPage(URL url,
                        Runnable r)

Use BrowserBuilder instead of using this method directly.

Specified by:

displayPage in interface Fn.Presenter

loadScript

public void loadScript(Reader reader)
                throws Exception

Use JavaScriptResource instead of using this method directly. Read more in the documentation for net.java.html.js package.

Specified by:

loadScript in interface Fn.Presenter

Throws:

Exception

toJavaScript

public Object toJavaScript(Object value)

Internal callback from Fn.ToJavaScript.

Specified by:

toJavaScript in interface Fn.ToJavaScript

toJava

public Object toJava(Object js)

Internal callback from Fn.FromJavaScript.

Specified by:

toJava in interface Fn.FromJavaScript