org.cef.handler

Interface CefJSDialogHandler

All Known Implementing Classes:

CefClient, CefJSDialogHandlerAdapter

public interface CefJSDialogHandler

Implement this interface to handle events related to JavaScript dialogs. The methods of this class will be called on the UI thread.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CefJSDialogHandler.JSDialogType Supported JavaScript dialog types.

Method Summary

Modifier and Type	Method and Description
boolean	onBeforeUnloadDialog(CefBrowser browser, java.lang.String message_text, boolean is_reload, CefJSDialogCallback callback) Called to run a dialog asking the user if they want to leave a page.
void	onDialogClosed(CefBrowser browser) Called when the default implementation dialog is closed.
boolean	onJSDialog(CefBrowser browser, java.lang.String origin_url, CefJSDialogHandler.JSDialogType dialog_type, java.lang.String message_text, java.lang.String default_prompt_text, CefJSDialogCallback callback, BoolRef suppress_message) Called to run a JavaScript dialog.
void	onResetDialogState(CefBrowser browser) Called to cancel any pending dialogs and reset any saved dialog state.

Method Detail

onBeforeUnloadDialog

boolean onBeforeUnloadDialog(CefBrowser browser,
                             java.lang.String message_text,
                             boolean is_reload,
                             CefJSDialogCallback callback)

Called to run a dialog asking the user if they want to leave a page. Return false to use the default dialog implementation. Return true if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute callback once the custom dialog is dismissed.

Parameters:

browser - The corresponding browser.

message_text - The text to be displayed.

is_reload - true if the page is reloaded.

callback - execute callback once the custom dialog is dismissed.

Returns:

false to use the default dialog implementation. Return true if the application will use a custom dialog.

onDialogClosed

void onDialogClosed(CefBrowser browser)

Called when the default implementation dialog is closed.

onJSDialog

boolean onJSDialog(CefBrowser browser,
                   java.lang.String origin_url,
                   CefJSDialogHandler.JSDialogType dialog_type,
                   java.lang.String message_text,
                   java.lang.String default_prompt_text,
                   CefJSDialogCallback callback,
                   BoolRef suppress_message)

Called to run a JavaScript dialog. Set suppress_message to true and return false to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set suppress_message to false and return false to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed). Return true if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute callback once the custom dialog is dismissed.

Parameters:

browser - The corresponding browser.

origin_url - The originating url.

dialog_type - the dialog type.

message_text - the text to be displayed.

default_prompt_text - value will be specified for prompt dialogs only.

callback - execute callback once the custom dialog is dismissed.

suppress_message - set to true to suppress displaying the message.

Returns:

false to use the default dialog implementation. Return true if the application will use a custom dialog.

onResetDialogState

void onResetDialogState(CefBrowser browser)

Called to cancel any pending dialogs and reset any saved dialog state. Will be called due to events like page navigation irregardless of whether any dialogs are currently pending.