Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "webkit: Update documentation for onJsConfirm, onJsPrompt callbacks" into rvc-dev

Browse Source
This commit is contained in:
TreeHugger Robot
2020-05-20 05:44:33 +00:00
committed by Android (Google) Code Review
parent a759c596fa dd4f03d419
commit a0b41154fe
1 changed files with 44 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
core/java/android/webkit/WebChromeClient.java
View File

@@ -219,17 +219,34 @@ public class WebChromeClient {
} }
/** /**
* Tell the client to display a confirm dialog to the user. If the client * Notify the host application that the web page wants to display a
* returns {@code true}, WebView will assume that the client will handle the * JavaScript {@code confirm()} dialog.
* confirm dialog and call the appropriate JsResult method. If the * <p>The default behavior if this method returns {@code false} or is not
* client returns false, a default value of {@code false} will be returned to * overridden is to show a dialog containing the message and suspend
* javascript. The default behavior is to return {@code false}. * JavaScript execution until the dialog is dismissed. The default dialog
* will return {@code true} to the JavaScript {@code confirm()} code when
* the user presses the 'confirm' button, and will return {@code false} to
* the JavaScript code when the user presses the 'cancel' button or
* dismisses the dialog.
* <p>To show a custom dialog, the app should return {@code true} from this
* method, in which case the default dialog will not be shown and JavaScript
* execution will be suspended. The app should call
* {@code JsResult.confirm()} or {@code JsResult.cancel()} when the custom
* dialog is dismissed.
* <p>To suppress the dialog and allow JavaScript execution to continue,
* call {@code JsResult.confirm()} or {@code JsResult.cancel()} immediately
* and then return {@code true}.
* <p>Note that if the {@link WebChromeClient} is {@code null}, the default
* dialog will be suppressed and the default value of {@code false} will be
* returned to the JavaScript code immediately.
*
* @param view The WebView that initiated the callback. * @param view The WebView that initiated the callback.
* @param url The url of the page requesting the dialog. * @param url The url of the page requesting the dialog.
* @param message Message to be displayed in the window. * @param message Message to be displayed in the window.
* @param result A JsResult used to send the user's response to * @param result A JsResult used to send the user's response to
* javascript. * javascript.
* @return boolean Whether the client will handle the confirm dialog. * @return boolean {@code true} if the request is handled or ignored.
* {@code false} if WebView needs to show the default dialog.
*/ */
public boolean onJsConfirm(WebView view, String url, String message, public boolean onJsConfirm(WebView view, String url, String message,
JsResult result) { JsResult result) {
@@ -237,18 +254,33 @@ public class WebChromeClient {
} }
/** /**
* Tell the client to display a prompt dialog to the user. If the client * Notify the host application that the web page wants to display a
* returns {@code true}, WebView will assume that the client will handle the * JavaScript {@code prompt()} dialog.
* prompt dialog and call the appropriate JsPromptResult method. If the * <p>The default behavior if this method returns {@code false} or is not
* client returns false, a default value of {@code false} will be returned to to * overridden is to show a dialog containing the message and suspend
* javascript. The default behavior is to return {@code false}. * JavaScript execution until the dialog is dismissed. Once the dialog is
* dismissed, JavaScript {@code prompt()} will return the string that the
* user typed in, or null if the user presses the 'cancel' button.
* <p>To show a custom dialog, the app should return {@code true} from this
* method, in which case the default dialog will not be shown and JavaScript
* execution will be suspended. The app should call
* {@code JsPromptResult.confirm(result)} when the custom dialog is
* dismissed.
* <p>To suppress the dialog and allow JavaScript execution to continue,
* call {@code JsPromptResult.confirm(result)} immediately and then
* return {@code true}.
* <p>Note that if the {@link WebChromeClient} is {@code null}, the default
* dialog will be suppressed and {@code null} will be returned to the
* JavaScript code immediately.
*
* @param view The WebView that initiated the callback. * @param view The WebView that initiated the callback.
* @param url The url of the page requesting the dialog. * @param url The url of the page requesting the dialog.
* @param message Message to be displayed in the window. * @param message Message to be displayed in the window.
* @param defaultValue The default value displayed in the prompt dialog. * @param defaultValue The default value displayed in the prompt dialog.
* @param result A JsPromptResult used to send the user's reponse to * @param result A JsPromptResult used to send the user's reponse to
* javascript. * javascript.
* @return boolean Whether the client will handle the prompt dialog. * @return boolean {@code true} if the request is handled or ignored.
* {@code false} if WebView needs to show the default dialog.
*/ */
public boolean onJsPrompt(WebView view, String url, String message, public boolean onJsPrompt(WebView view, String url, String message,
String defaultValue, JsPromptResult result) { String defaultValue, JsPromptResult result) {