org.netbeans.html.presenters.browser

Class Browser

java.lang.Object

org.netbeans.html.presenters.browser.Browser

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, java.util.concurrent.Executor, Fn.KeepAlive, Fn.Presenter

public final class Browser
extends java.lang.Object
implements Fn.Presenter, Fn.KeepAlive, java.io.Flushable, java.util.concurrent.Executor, java.io.Closeable

Browser based Fn.Presenter. It starts local server and launches browser that connects to it. Use Browser.Config to configure the actual browser to be started.

To use this presenter specify following dependency:

 <dependency>
   <groupId>org.netbeans.html.browser</groupId>
   <artifactId>browser</artifactId>
   <version>1.x</version>
 </dependency>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Browser.Config Parameters to configure Browser.

Constructor Summary

Constructors

Constructor and Description
Browser() Default constructor.
Browser(Browser.Config config) Browser configured by provided config.

Method Summary

Modifier and Type	Method and Description
void	close()
Fn	defineFn(java.lang.String string, java.lang.String... strings) Creates new function with given parameter names and provided body.
Fn	defineFn(java.lang.String string, java.lang.String[] strings, boolean[] blns) Creates new function with given parameter names and provided body.
void	displayPage(java.net.URL page, java.lang.Runnable onPageLoad) Opens the browser, loads provided page and when the page is ready, it calls back to the provider runnable.
void	execute(java.lang.Runnable r)
void	flush()
void	loadScript(java.io.Reader reader) Loads a script into the browser JavaScript interpreter and executes it.

Methods inherited from class java.lang.Object

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

Constructor Detail

Browser

public Browser()

Default constructor. Reads configuration from properties. The actual browser to be launched can be influenced by value of com.dukescript.presenters.browser property. It can have following values:

• GTK - use Gtk WebKit implementation. Requires presence of appropriate native libraries
• AWT - use Desktop.browse(java.net.URI) to launch a browser
• NONE - just launches the server, useful together with com.dukescript.presenters.browserPort property that can specify a fixed port to open the server at
• any other value is interpreted as a command which is then launched on a command line with one parameter - the URL to connect to

If the property is not specified the system tries GTK mode first, followed by AWT and then tries to execute xdg-open (default LINUX command to launch a browser from a shell script).

Browser

public Browser(Browser.Config config)

Browser configured by provided config.

Parameters:

config - the configuration

Method Detail

execute

public final void execute(java.lang.Runnable r)

Specified by:

execute in interface java.util.concurrent.Executor

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

defineFn

public Fn defineFn(java.lang.String string,
                   java.lang.String... strings)

Description copied from interface: Fn.Presenter

Creates new function with given parameter names and provided body.

Specified by:

defineFn in interface Fn.Presenter

Parameters:

string - the body of the function. Can refer to variables named as names

strings - names of parameters of the function - these will be available when the code body executes

Returns:

function that can be later invoked

loadScript

public void loadScript(java.io.Reader reader)
                throws java.lang.Exception

Description copied from interface: Fn.Presenter

Loads a script into the browser JavaScript interpreter and executes it.

Specified by:

loadScript in interface Fn.Presenter

Parameters:

reader - the script to execute

Throws:

java.lang.Exception - if something goes wrong, throw an exception

defineFn

public Fn defineFn(java.lang.String string,
                   java.lang.String[] strings,
                   boolean[] blns)

Description copied from interface: Fn.KeepAlive

Creates new function with given parameter names and provided body.

Specified by:

defineFn in interface Fn.KeepAlive

Parameters:

string - the body of the function. Can refer to variables named as names

strings - names of parameters of the function - these will be available when the code body executes

blns - array of booleans describing for each parameter whether it should be kept alive or not. Length of the array must be the same as length of names array. The array may be null to signal that all parameters should be kept alive.

Returns:

function that can be later invoked

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

displayPage

public final void displayPage(java.net.URL page,
                              java.lang.Runnable onPageLoad)

Description copied from interface: Fn.Presenter

Opens the browser, loads provided page and when the page is ready, it calls back to the provider runnable.

Specified by:

displayPage in interface Fn.Presenter

Parameters:

page - the URL for the page to display

onPageLoad - callback when the page is ready