android.webkit
Class WebChromeClient

java.lang.Object
  android.webkit.WebChromeClient

public class WebChromeClient
extends Object

Constructor Summary

WebChromeClient()

Method Summary

void	onCloseWindow(WebView window) Notify the host application to close the given WebView and remove it from the view system if necessary.
boolean	onCreateWindow(WebView view, boolean dialog, boolean userGesture, Message resultMsg) Request the host application to create a new Webview.
boolean	onJsAlert(WebView view, String url, String message, JsResult result) Tell the client to display a javascript alert dialog.
boolean	onJsBeforeUnload(WebView view, String url, String message, JsResult result) Tell the client to display a dialog to confirm navigation away from the current page.
boolean	onJsConfirm(WebView view, String url, String message, JsResult result) Tell the client to display a confirm dialog to the user.
boolean	onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) Tell the client to display a prompt dialog to the user.
void	onProgressChanged(WebView view, int newProgress) Tell the host application the current progress of loading a page.
void	onReceivedIcon(WebView view, Bitmap icon) Notify the host application of a new favicon for the current page.
void	onReceivedTitle(WebView view, String title) Notify the host application of a change in the document title.
void	onRequestFocus(WebView view) Request display and focus for this WebView.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebChromeClient

public WebChromeClient()

Method Detail

onProgressChanged

public void onProgressChanged(WebView view,
                              int newProgress)

Tell the host application the current progress of loading a page.

Parameters:

view - The WebView that initiated the callback.

newProgress - Current page loading progress, represented by an integer between 0 and 100.

onReceivedTitle

public void onReceivedTitle(WebView view,
                            String title)

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

Parameters:

view - The WebView that initiated the callback.

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

onReceivedIcon

public void onReceivedIcon(WebView view,
                           Bitmap icon)

Notify the host application of a new favicon for the current page.

Parameters:

view - The WebView that initiated the callback.

icon - A Bitmap containing the favicon for the current page.

onCreateWindow

public boolean onCreateWindow(WebView view,
                              boolean dialog,
                              boolean userGesture,
                              Message resultMsg)

Request the host application to create a new Webview. The host application should handle placement of the new WebView in the view system. The default behavior returns null.

Parameters:

view - The WebView that initiated the callback.

dialog - True if the new window is meant to be a small dialog window.

userGesture - True if the request was initiated by a user gesture such as clicking a link.

resultMsg - The message to send when done creating a new WebView. Set the new WebView through resultMsg.obj which is WebView.WebViewTransport() and then call resultMsg.sendToTarget();

Returns:

Similar to javscript dialogs, this method should return true if the client is going to handle creating a new WebView. Note that the WebView will halt processing if this method returns true so make sure to call resultMsg.sendToTarget(). It is undefined behavior to call resultMsg.sendToTarget() after returning false from this method.

onRequestFocus

public void onRequestFocus(WebView view)

Request display and focus for this WebView. This may happen due to another WebView opening a link in this WebView and requesting that this WebView be displayed.

Parameters:

view - The WebView that needs to be focused.

onCloseWindow

public void onCloseWindow(WebView window)

Notify the host application to close the given WebView and remove it from the view system if necessary. At this point, WebCore has stopped any loading in this window and has removed any cross-scripting ability in javascript.

Parameters:

window - The WebView that needs to be closed.

onJsAlert

public boolean onJsAlert(WebView view,
                         String url,
                         String message,
                         JsResult result)

Tell the client to display a javascript alert dialog. If the client returns true, WebView will assume that the client will handle the dialog. If the client returns false, it will continue execution.

Parameters:

view - The WebView that initiated the callback.

url - The url of the page requesting the dialog.

message - Message to be displayed in the window.

result - A JsResult to confirm that the user hit enter.

Returns:

boolean Whether the client will handle the alert dialog.

onJsConfirm

public boolean onJsConfirm(WebView view,
                           String url,
                           String message,
                           JsResult result)

Tell the client to display a confirm dialog to the user. If the client returns true, WebView will assume that the client will handle the confirm dialog and call the appropriate JsResult method. If the client returns false, a default value of false will be returned to javascript. The default behavior is to return false.

Parameters:

view - The WebView that initiated the callback.

url - The url of the page requesting the dialog.

message - Message to be displayed in the window.

result - A JsResult used to send the user's response to javascript.

Returns:

boolean Whether the client will handle the confirm dialog.

onJsPrompt

public boolean onJsPrompt(WebView view,
                          String url,
                          String message,
                          String defaultValue,
                          JsPromptResult result)

Tell the client to display a prompt dialog to the user. If the client returns true, WebView will assume that the client will handle the prompt dialog and call the appropriate JsPromptResult method. If the client returns false, a default value of false will be returned to to javascript. The default behavior is to return false.

Parameters:

view - The WebView that initiated the callback.

url - The url of the page requesting the dialog.

message - Message to be displayed in the window.

defaultValue - The default value displayed in the prompt dialog.

result - A JsPromptResult used to send the user's reponse to javascript.

Returns:

boolean Whether the client will handle the prompt dialog.

onJsBeforeUnload

public boolean onJsBeforeUnload(WebView view,
                                String url,
                                String message,
                                JsResult result)

Tell the client to display a dialog to confirm navigation away from the current page. This is the result of the onbeforeunload javascript event. If the client returns true, WebView will assume that the client will handle the confirm dialog and call the appropriate JsResult method. If the client returns false, a default value of true will be returned to javascript to accept navigation away from the current page. The default behavior is to return false. Setting the JsResult to true will navigate away from the current page, false will cancel the navigation.

Parameters:

view - The WebView that initiated the callback.

url - The url of the page requesting the dialog.

message - Message to be displayed in the window.

result - A JsResult used to send the user's response to javascript.

Returns:

boolean Whether the client will handle the confirm dialog.