org.cef.handler

Interface CefAppHandler

All Known Implementing Classes:

CefApp, CefAppHandlerAdapter

public interface CefAppHandler

Implement this interface to provide handler implementations. Methods will be called by the process and/or thread indicated.

Method Summary

Modifier and Type	Method and Description
boolean	onAlreadyRunningAppRelaunch(CefCommandLine command_line, java.lang.String current_directory) Implement this method to provide app-specific behavior when an already running app is relaunched with the same CefSettings.root_cache_path value.
void	onBeforeCommandLineProcessing(java.lang.String process_type, CefCommandLine command_line) Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium.
boolean	onBeforeTerminate() Provides an opportunity to hook into the native shutdown process.
void	onContextInitialized() Called on the browser process UI thread immediately after the CEF context has been initialized.
void	onRegisterCustomSchemes(CefSchemeRegistrar registrar) Provides an opportunity to register custom schemes.
void	onScheduleMessagePumpWork(long delay_ms) Called from any thread when work has been scheduled for the browser process main (UI) thread.
void	stateHasChanged(CefApp.CefAppState state) Implement this method to get state changes of the CefApp.

Method Detail

onAlreadyRunningAppRelaunch

boolean onAlreadyRunningAppRelaunch(CefCommandLine command_line,
                                    java.lang.String current_directory)

Implement this method to provide app-specific behavior when an already running app is relaunched with the same CefSettings.root_cache_path value. For example, activate an existing app window or create a new app window. |command_line| will be read-only. Do not keep a reference to |command_line| outside of this method. Return true if the relaunch is handled or false for default relaunch behavior. Default behavior will create a new default styled Chrome window. To avoid cache corruption only a single app instance is allowed to run for a given CefSettings.root_cache_path value. On relaunch the app checks a process singleton lock and then forwards the new launch arguments to the already running app process before exiting early. Client apps should therefore check the CefInitialize() return value for early exit before proceeding.

onBeforeCommandLineProcessing

void onBeforeCommandLineProcessing(java.lang.String process_type,
                                   CefCommandLine command_line)

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |process_type| value will be empty for the browser process. Be cautious when using this method to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

Parameters:

process_type - type of process (empty for browser process).

command_line - values of the command line.

onBeforeTerminate

boolean onBeforeTerminate()

Provides an opportunity to hook into the native shutdown process. This method is invoked if the user tries to terminate the app by sending the corresponding key code (e.g. on Mac: CMD+Q) or something similar. If you want to proceed with the default behavior of the native system, return false. If you want to abort the terminate or if you want to implement your own shutdown sequence return true and do the cleanup on your own.

Returns:

false to proceed with the default behavior, true to abort terminate.

onContextInitialized

void onContextInitialized()

Called on the browser process UI thread immediately after the CEF context has been initialized.

onRegisterCustomSchemes

void onRegisterCustomSchemes(CefSchemeRegistrar registrar)

Provides an opportunity to register custom schemes. Do not keep a reference to the |registrar| object. This method is called on the main thread for each process and the registered schemes should be the same across all processes.

onScheduleMessagePumpWork

void onScheduleMessagePumpWork(long delay_ms)

Called from any thread when work has been scheduled for the browser process main (UI) thread. This callback should schedule a CefApp.DoMessageLoopWork() call to happen on the main (UI) thread. |delay_ms| is the requested delay in milliseconds. If |delay_ms| is <= 0 then the call should happen reasonably soon. If |delay_ms| is > 0 then the call should be scheduled to happen after the specified delay and any currently pending scheduled call should be cancelled.

stateHasChanged

void stateHasChanged(CefApp.CefAppState state)

Implement this method to get state changes of the CefApp. See CefApp.CefAppState for a complete list of possible states. For example, this method can be used e.g. to get informed if CefApp has completed its initialization or its shutdown process.

Parameters:

state - The current state of CefApp.