org.xwalk.core

Class XWalkUIClient

java.lang.Object

org.xwalk.core.XWalkUIClient

public class XWalkUIClient
extends java.lang.Object

This class notifies the embedder UI events/callbacks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XWalkUIClient.ConsoleMessageType Initiator
static class	XWalkUIClient.InitiateBy Initiator
static class	XWalkUIClient.JavascriptMessageType The type of JavaScript modal dialog.
static class	XWalkUIClient.LoadStatus The status when a page stopped loading

Constructor Summary

Constructors

Constructor and Description
XWalkUIClient(XWalkView view) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	getBridge()
boolean	onConsoleMessage(XWalkView view, java.lang.String message, int lineNumber, java.lang.String sourceId, XWalkUIClient.ConsoleMessageType messageType) Notify the host application of console message.
boolean	onCreateWindowRequested(XWalkView view, XWalkUIClient.InitiateBy initiator, android.webkit.ValueCallback<XWalkView> callback) Request the host application to create a new window
void	onFullscreenToggled(XWalkView view, boolean enterFullscreen) Tell the client to toggle fullscreen mode.
void	onIconAvailable(XWalkView view, java.lang.String url, android.os.Message startDownload) Notify the host application that an icon is available, send the message to start the downloading
void	onJavascriptCloseWindow(XWalkView view) Notify the client to close the given XWalkView.
boolean	onJavascriptModalDialog(XWalkView view, XWalkUIClient.JavascriptMessageType type, java.lang.String url, java.lang.String message, java.lang.String defaultValue, XWalkJavascriptResult result) Tell the client to display a prompt dialog to the user.
boolean	onJsAlert(XWalkView view, java.lang.String url, java.lang.String message, XWalkJavascriptResult result) Tell the client to display an alert dialog to the user.
boolean	onJsConfirm(XWalkView view, java.lang.String url, java.lang.String message, XWalkJavascriptResult result) Tell the client to display a confirm dialog to the user.
boolean	onJsPrompt(XWalkView view, java.lang.String url, java.lang.String message, java.lang.String defaultValue, XWalkJavascriptResult result) Tell the client to display a prompt dialog to the user.
void	onPageLoadStarted(XWalkView view, java.lang.String url) Notify the host application that a page has started loading.
void	onPageLoadStopped(XWalkView view, java.lang.String url, XWalkUIClient.LoadStatus status) Notify the host application that a page has stopped loading.
void	onReceivedIcon(XWalkView view, java.lang.String url, android.graphics.Bitmap icon) Notify the host application of a new icon has been downloaded
void	onReceivedTitle(XWalkView view, java.lang.String title) Notify the host application of a change in the document title.
void	onRequestFocus(XWalkView view) Request display and focus for this XWalkView.
void	onScaleChanged(XWalkView view, float oldScale, float newScale) Notify the client that the scale applied to the XWalkView has changed.
void	onUnhandledKeyEvent(XWalkView view, android.view.KeyEvent event) Notify the host application that a key was not handled by the XWalkView.
void	openFileChooser(XWalkView view, android.webkit.ValueCallback<android.net.Uri> uploadFile, java.lang.String acceptType, java.lang.String capture) Tell the client to open a file chooser.
boolean	shouldOverrideKeyEvent(XWalkView view, android.view.KeyEvent event) Give the host application a chance to handle the key event synchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

XWalkUIClient

public XWalkUIClient(XWalkView view)

Constructor.

Parameters:

view - the owner XWalkView instance.

Since:

1.0

Method Detail

getBridge

protected java.lang.Object getBridge()

onCreateWindowRequested

public boolean onCreateWindowRequested(XWalkView view,
                                       XWalkUIClient.InitiateBy initiator,
                                       android.webkit.ValueCallback<XWalkView> callback)

Request the host application to create a new window

Parameters:

view - The XWalkView which initiate the request for a new window

initiator - How the request was initiated

callback - Callback when once a new XWalkView has been created

Returns:

Return true if the host application will create a new window

Since:

4.0

onIconAvailable

public void onIconAvailable(XWalkView view,
                            java.lang.String url,
                            android.os.Message startDownload)

Notify the host application that an icon is available, send the message to start the downloading

Parameters:

view - The XWalkView that icon belongs to

url - The icon url

startDownload - Message to initiate icon download

Since:

4.0

onReceivedIcon

public void onReceivedIcon(XWalkView view,
                           java.lang.String url,
                           android.graphics.Bitmap icon)

Notify the host application of a new icon has been downloaded

Parameters:

view - The XWalkView that icon belongs to

url - The icon url

icon - The icon image

Since:

4.0

onRequestFocus

public void onRequestFocus(XWalkView view)

Request display and focus for this XWalkView.

Parameters:

view - the owner XWalkView instance.

Since:

1.0

onJavascriptCloseWindow

public void onJavascriptCloseWindow(XWalkView view)

Notify the client to close the given XWalkView.

Parameters:

view - the owner XWalkView instance.

Since:

1.0

onJavascriptModalDialog

public boolean onJavascriptModalDialog(XWalkView view,
                                       XWalkUIClient.JavascriptMessageType type,
                                       java.lang.String url,
                                       java.lang.String message,
                                       java.lang.String defaultValue,
                                       XWalkJavascriptResult result)

Tell the client to display a prompt dialog to the user.

Parameters:

view - the owner XWalkView instance.

type - the type of JavaScript modal dialog.

url - the url of the web page which wants to show this dialog.

message - the message to be shown.

defaultValue - the default value string. Only valid for Prompt dialog.

result - the callback to handle the result from caller.

Since:

1.0

onFullscreenToggled

public void onFullscreenToggled(XWalkView view,
                                boolean enterFullscreen)

Tell the client to toggle fullscreen mode.

Parameters:

view - the owner XWalkView instance.

enterFullscreen - true if it has entered fullscreen mode.

Since:

1.0

openFileChooser

public void openFileChooser(XWalkView view,
                            android.webkit.ValueCallback<android.net.Uri> uploadFile,
                            java.lang.String acceptType,
                            java.lang.String capture)

Tell the client to open a file chooser.

Parameters:

view - the owner XWalkView instance.

uploadFile - the callback class to handle the result from caller. It MUST be invoked in all cases. Leave it not invoked will block all following requests to open file chooser.

acceptType - value of the 'accept' attribute of the input tag associated with this file picker.

capture - value of the 'capture' attribute of the input tag associated with this file picker

Since:

1.0

onScaleChanged

public void onScaleChanged(XWalkView view,
                           float oldScale,
                           float newScale)

Notify the client that the scale applied to the XWalkView has changed.

Parameters:

view - the owner XWalkView instance.

oldScale - the old scale before scaling.

newScale - the current scale factor after scaling.

Since:

1.0

shouldOverrideKeyEvent

public boolean shouldOverrideKeyEvent(XWalkView view,
                                      android.view.KeyEvent event)

Give the host application a chance to handle the key event synchronously. e.g. menu shortcut key events need to be filtered this way. If return true, XWalkView will not handle the key event. If return false, XWalkView will always handle the key event, so none of the super in the view chain will see the key event. The default behavior returns false.

Parameters:

view - The XWalkView that is initiating the callback.

event - The key event.

Returns:

True if the host application wants to handle the key event itself, otherwise return false

Since:

2.1

onUnhandledKeyEvent

public void onUnhandledKeyEvent(XWalkView view,
                                android.view.KeyEvent event)

Notify the host application that a key was not handled by the XWalkView. Except system keys, XWalkView always consumes the keys in the normal flow or if shouldOverrideKeyEvent returns true. This is called asynchronously from where the key is dispatched. It gives the host application a chance to handle the unhandled key events.

Parameters:

view - The XWalkView that is initiating the callback.

event - The key event.

Since:

2.1

onConsoleMessage

public boolean onConsoleMessage(XWalkView view,
                                java.lang.String message,
                                int lineNumber,
                                java.lang.String sourceId,
                                XWalkUIClient.ConsoleMessageType messageType)

Notify the host application of console message.

Parameters:

view - The XWalkView that initiated the callback.

message - A String containing the console message.

lineNumber - The line number of JavaScript.

sourceId - The link which print log.

messageType - The type of console message.

Returns:

Not applicable here. For future use.

Since:

5.0

onReceivedTitle

public void onReceivedTitle(XWalkView view,
                            java.lang.String title)

Notify the host application of a change in the document title.

Parameters:

view - The XWalkView that initiated the callback.

title - A String containing the new title of the document.

Since:

2.1

onPageLoadStarted

public void onPageLoadStarted(XWalkView view,
                              java.lang.String url)

Notify the host application that a page has started loading. This method is called once for each main frame load so a page with iframes or framesets will call onPageLoadStarted one time for the main frame. This also means that onPageLoadStarted will not be called when the contents of an embedded frame changes, i.e. clicking a link whose target is an iframe.

Parameters:

view - The XWalkView that is initiating the callback.

url - The url to be loaded.

Since:

2.1

onPageLoadStopped

public void onPageLoadStopped(XWalkView view,
                              java.lang.String url,
                              XWalkUIClient.LoadStatus status)

Notify the host application that a page has stopped loading. This method is called only for main frame. When onPageLoadStopped() is called, the rendering picture may not be updated yet.

Parameters:

view - The XWalkView that is initiating the callback.

url - The url of the page.

status - The status when the page stopped loading.

Since:

2.1

onJsAlert

public boolean onJsAlert(XWalkView view,
                         java.lang.String url,
                         java.lang.String message,
                         XWalkJavascriptResult result)

Tell the client to display an alert dialog to the user. WARN: Please DO NOT override this API and onJavascriptModalDialog API in the same subclass to avoid unexpected behavior.

Parameters:

view - the owner XWalkView instance.

url - the url of the web page which wants to show this dialog.

message - the message to be shown.

result - the callback to handle the result from caller.

Returns:

Whether the client will handle the alert dialog.

Since:

6.0

onJsConfirm

public boolean onJsConfirm(XWalkView view,
                           java.lang.String url,
                           java.lang.String message,
                           XWalkJavascriptResult result)

Tell the client to display a confirm dialog to the user. WARN: Please DO NOT override this API and onJavascriptModalDialog API in the same subclass to avoid unexpected behavior.

Parameters:

view - the owner XWalkView instance.

url - the url of the web page which wants to show this dialog.

message - the message to be shown.

result - the callback to handle the result from caller.

Returns:

Whether the client will handle the confirm dialog.

Since:

6.0

onJsPrompt

public boolean onJsPrompt(XWalkView view,
                          java.lang.String url,
                          java.lang.String message,
                          java.lang.String defaultValue,
                          XWalkJavascriptResult result)

Tell the client to display a prompt dialog to the user. WARN: Please DO NOT override this API and onJavascriptModalDialog API in the same subclass to avoid unexpected behavior.

Parameters:

view - the owner XWalkView instance.

url - the url of the web page which wants to show this dialog.

message - the message to be shown.

defaultValue - the default value string. Only valid for Prompt dialog.

result - the callback to handle the result from caller.

Returns:

Whether the client will handle the prompt dialog.

Since:

6.0