ceffx

Interface Cef

All Known Implementing Classes:

JNICef, ProcessCef

public interface Cef

Method Summary

Modifier and Type	Method and Description
Browser	createBrowser(RenderHandler renderHandler, java.net.URL initialURL) Create a new browser.
void	doMessageLoopWork() Perform a single iteration of CEF message loop processing.
void	initialize() Initialize CEF.
boolean	isInitialized()
void	shutdown() Shutdown CEF processes, should be called before the application exits.
java.util.concurrent.CompletableFuture<java.lang.Void>	start() Start CEF and run the automatic message loop.

Method Detail

initialize

void initialize()

Initialize CEF. Only use this method directly when running the message loop manually, i.e. via doMessageLoopWork(). Must be called from the main application thread (see CEF documentation on CefInitialize).

start

java.util.concurrent.CompletableFuture<java.lang.Void> start()

Start CEF and run the automatic message loop. A new thread will be started which initializes CEF and then runs the CEF message loop (see CefRunMessageLoop). When using this method, initialize() must not be invoked manually as it will be handled by the implementation to ensure it happens on the correct thread.

Returns:

a CompletableFuture which completes when CEF has been initialized. Can be used to determine the status as alternative to polling isInitialized().

doMessageLoopWork

void doMessageLoopWork()

Perform a single iteration of CEF message loop processing. Can be used to integrate the CEF message loop into an existing message loop. CEF must be initialized manually via initialize() beforehand. Must be called from the main application thread (see CEF documentation on CefDoMessageLoopWork). Note that care needs to be taken to neither call this too infrequently (to avoid starving the CEF message loop) but also not too often (to avoid impacting CPU usage) - see CEF documentation for details when using this approach.

shutdown

void shutdown()
       throws java.lang.InterruptedException

Shutdown CEF processes, should be called before the application exits. When operating using a manual message loop via doMessageLoopWork(), this must be called from the main application thread (see CEF documentation on CefShutdown). When using the integrated/automatic message loop it may be invoked from any thread as the implementation ensures the shutdown is run on the correct thread.

Throws:

java.lang.InterruptedException - if the current thread is interrupted whilst waiting on the shutdown of the integrated message loop

isInitialized

boolean isInitialized()

createBrowser

Browser createBrowser(RenderHandler renderHandler,
                      java.net.URL initialURL)

Create a new browser.

Parameters:

renderHandler - handler which provides viewport information and renders images

initialURL - the initial URL to load in the created browser

Returns:

a new browser instance

Throws:

java.lang.IllegalStateException - if CEF has not been initialized yet