The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2006 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.webkit; |
| 18 | |
Tobias Sargeant | d10e4af | 2017-01-19 14:03:09 +0000 | [diff] [blame] | 19 | import android.annotation.IntDef; |
Siva Velusamy | 94a6d15 | 2015-05-05 15:07:00 -0700 | [diff] [blame] | 20 | import android.annotation.NonNull; |
Tima Vaisburd | cf49a23 | 2017-03-28 11:35:58 -0700 | [diff] [blame] | 21 | import android.annotation.Nullable; |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 22 | import android.annotation.SystemApi; |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 23 | import android.annotation.UnsupportedAppUsage; |
Raphael | 30df237 | 2010-03-06 10:09:54 -0800 | [diff] [blame] | 24 | import android.annotation.Widget; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 25 | import android.content.Context; |
Hui Shu | f119c52 | 2015-10-08 10:07:13 -0700 | [diff] [blame] | 26 | import android.content.Intent; |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 27 | import android.content.pm.PackageInfo; |
Cary Clark | c5cd5e9 | 2010-11-22 15:20:02 -0500 | [diff] [blame] | 28 | import android.content.res.Configuration; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 29 | import android.graphics.Bitmap; |
| 30 | import android.graphics.Canvas; |
John Reck | a5408e6 | 2012-03-16 14:18:44 -0700 | [diff] [blame] | 31 | import android.graphics.Paint; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 32 | import android.graphics.Picture; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 33 | import android.graphics.Rect; |
Mike Reed | e8853fc | 2009-09-04 14:01:48 -0400 | [diff] [blame] | 34 | import android.graphics.drawable.Drawable; |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 35 | import android.net.Uri; |
Nate Fischer | 0e72c18 | 2017-05-30 11:25:17 -0700 | [diff] [blame] | 36 | import android.net.http.SslCertificate; |
Kristian Monsen | b5cd8c0 | 2013-04-09 17:57:37 -0700 | [diff] [blame] | 37 | import android.os.Build; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 38 | import android.os.Bundle; |
Selim Gurun | e319dad | 2016-03-17 01:40:40 +0000 | [diff] [blame] | 39 | import android.os.Handler; |
Steve Block | 08d584c | 2011-05-17 19:05:03 +0100 | [diff] [blame] | 40 | import android.os.Looper; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 41 | import android.os.Message; |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 42 | import android.os.RemoteException; |
Nate Fischer | 0e72c18 | 2017-05-30 11:25:17 -0700 | [diff] [blame] | 43 | import android.os.StrictMode; |
Selim Gurun | da7d642 | 2013-09-06 14:39:05 -0700 | [diff] [blame] | 44 | import android.print.PrintDocumentAdapter; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 45 | import android.util.AttributeSet; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 46 | import android.util.Log; |
Tao Bai | a571733 | 2017-03-30 14:58:53 -0700 | [diff] [blame] | 47 | import android.util.SparseArray; |
Hui Shu | ecdce96 | 2016-02-04 15:00:19 -0800 | [diff] [blame] | 48 | import android.view.DragEvent; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 49 | import android.view.KeyEvent; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 50 | import android.view.MotionEvent; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 51 | import android.view.View; |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 52 | import android.view.ViewDebug; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 53 | import android.view.ViewGroup; |
Siva Velusamy | 94a6d15 | 2015-05-05 15:07:00 -0700 | [diff] [blame] | 54 | import android.view.ViewHierarchyEncoder; |
Nate Fischer | 0e72c18 | 2017-05-30 11:25:17 -0700 | [diff] [blame] | 55 | import android.view.ViewStructure; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 56 | import android.view.ViewTreeObserver; |
Svetoslav Ganov | d9ee72f | 2011-10-05 22:26:05 -0700 | [diff] [blame] | 57 | import android.view.accessibility.AccessibilityEvent; |
Svetoslav Ganov | d9ee72f | 2011-10-05 22:26:05 -0700 | [diff] [blame] | 58 | import android.view.accessibility.AccessibilityNodeInfo; |
Ben Murdoch | e3f9071 | 2013-06-05 14:19:48 +0100 | [diff] [blame] | 59 | import android.view.accessibility.AccessibilityNodeProvider; |
Tao Bai | a571733 | 2017-03-30 14:58:53 -0700 | [diff] [blame] | 60 | import android.view.autofill.AutofillValue; |
Derek Sollenberger | 7cabb03 | 2010-01-21 10:37:38 -0500 | [diff] [blame] | 61 | import android.view.inputmethod.EditorInfo; |
| 62 | import android.view.inputmethod.InputConnection; |
Tima Vaisburd | cf49a23 | 2017-03-28 11:35:58 -0700 | [diff] [blame] | 63 | import android.view.textclassifier.TextClassifier; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 64 | import android.widget.AbsoluteLayout; |
Steve Block | f95d490 | 2011-06-09 11:53:26 +0100 | [diff] [blame] | 65 | |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 66 | import java.io.BufferedWriter; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 67 | import java.io.File; |
Tobias Sargeant | d10e4af | 2017-01-19 14:03:09 +0000 | [diff] [blame] | 68 | import java.lang.annotation.Retention; |
| 69 | import java.lang.annotation.RetentionPolicy; |
Nate Fischer | 520a8ba | 2017-07-12 17:37:07 -0700 | [diff] [blame] | 70 | import java.util.List; |
Andrei Popescu | 4950b2b | 2009-09-03 13:56:07 +0100 | [diff] [blame] | 71 | import java.util.Map; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 72 | |
| 73 | /** |
Laura Davis | b444e2d | 2018-07-13 15:12:35 -0700 | [diff] [blame] | 74 | * A View that displays web pages. |
Scott Main | 41ec653 | 2010-08-19 16:57:07 -0700 | [diff] [blame] | 75 | * |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 76 | * <h3>Basic usage</h3> |
| 77 | * |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 78 | * |
Laura Davis | b444e2d | 2018-07-13 15:12:35 -0700 | [diff] [blame] | 79 | * <p>In most cases, we recommend using a standard web browser, like Chrome, to deliver |
| 80 | * content to the user. To learn more about web browsers, read the guide on |
| 81 | * <a href="/guide/components/intents-common#Browser"> |
| 82 | * invoking a browser with an intent</a>. |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 83 | * |
Laura Davis | b444e2d | 2018-07-13 15:12:35 -0700 | [diff] [blame] | 84 | * <p>WebView objects allow you to display web content as part of your activity layout, but |
| 85 | * lack some of the features of fully-developed browsers. A WebView is useful when |
| 86 | * you need increased control over the UI and advanced configuration options that will allow |
| 87 | * you to embed web pages in a specially-designed environment for your app. |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 88 | * |
Laura Davis | b444e2d | 2018-07-13 15:12:35 -0700 | [diff] [blame] | 89 | * <p>To learn more about WebView and alternatives for serving web content, read the |
| 90 | * documentation on |
| 91 | * <a href="/guide/webapps/"> |
| 92 | * Web-based content</a>. |
Nate Fischer | fb92ee1 | 2018-01-18 12:01:19 -0800 | [diff] [blame] | 93 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 94 | */ |
Steve Block | 406aeb2 | 2012-04-23 18:17:19 +0100 | [diff] [blame] | 95 | // Implementation notes. |
| 96 | // The WebView is a thin API class that delegates its public API to a backend WebViewProvider |
| 97 | // class instance. WebView extends {@link AbsoluteLayout} for backward compatibility reasons. |
| 98 | // Methods are delegated to the provider implementation: all public API methods introduced in this |
| 99 | // file are fully delegated, whereas public and protected methods from the View base classes are |
| 100 | // only delegated where a specific need exists for them to do so. |
Raphael | 30df237 | 2010-03-06 10:09:54 -0800 | [diff] [blame] | 101 | @Widget |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 102 | public class WebView extends AbsoluteLayout |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 103 | implements ViewTreeObserver.OnGlobalFocusChangeListener, |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 104 | ViewGroup.OnHierarchyChangeListener, ViewDebug.HierarchyHandler { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 105 | |
Jonathan Dixon | 69f9f93 | 2013-08-28 15:54:29 -0700 | [diff] [blame] | 106 | private static final String LOGTAG = "WebView"; |
Nicolas Roard | 12c18e6 | 2010-10-13 20:14:31 -0700 | [diff] [blame] | 107 | |
Kristian Monsen | b5cd8c0 | 2013-04-09 17:57:37 -0700 | [diff] [blame] | 108 | // Throwing an exception for incorrect thread usage if the |
| 109 | // build target is JB MR2 or newer. Defaults to false, and is |
| 110 | // set in the WebView constructor. |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 111 | @UnsupportedAppUsage |
Jonathan Dixon | 0d6a145 | 2013-08-21 13:09:36 -0700 | [diff] [blame] | 112 | private static volatile boolean sEnforceThreadChecking = false; |
Kristian Monsen | b5cd8c0 | 2013-04-09 17:57:37 -0700 | [diff] [blame] | 113 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 114 | /** |
| 115 | * Transportation object for returning WebView across thread boundaries. |
| 116 | */ |
| 117 | public class WebViewTransport { |
| 118 | private WebView mWebview; |
| 119 | |
| 120 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 121 | * Sets the WebView to the transportation object. |
| 122 | * |
| 123 | * @param webview the WebView to transport |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 124 | */ |
| 125 | public synchronized void setWebView(WebView webview) { |
| 126 | mWebview = webview; |
| 127 | } |
| 128 | |
| 129 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 130 | * Gets the WebView object. |
| 131 | * |
| 132 | * @return the transported WebView object |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 133 | */ |
| 134 | public synchronized WebView getWebView() { |
| 135 | return mWebview; |
| 136 | } |
| 137 | } |
| 138 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 139 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 140 | * URI scheme for telephone number. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 141 | */ |
| 142 | public static final String SCHEME_TEL = "tel:"; |
| 143 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 144 | * URI scheme for email address. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 145 | */ |
| 146 | public static final String SCHEME_MAILTO = "mailto:"; |
| 147 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 148 | * URI scheme for map address. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 149 | */ |
| 150 | public static final String SCHEME_GEO = "geo:0,0?q="; |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 151 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 152 | /** |
Victoria Lease | d405a43 | 2012-03-22 15:53:48 -0700 | [diff] [blame] | 153 | * Interface to listen for find results. |
Victoria Lease | d405a43 | 2012-03-22 15:53:48 -0700 | [diff] [blame] | 154 | */ |
| 155 | public interface FindListener { |
| 156 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 157 | * Notifies the listener about progress made by a find operation. |
Victoria Lease | d405a43 | 2012-03-22 15:53:48 -0700 | [diff] [blame] | 158 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 159 | * @param activeMatchOrdinal the zero-based ordinal of the currently selected match |
Selim Gurun | 92b81a3 | 2012-08-21 17:32:35 -0700 | [diff] [blame] | 160 | * @param numberOfMatches how many matches have been found |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 161 | * @param isDoneCounting whether the find operation has actually completed. The listener |
| 162 | * may be notified multiple times while the |
| 163 | * operation is underway, and the numberOfMatches |
| 164 | * value should not be considered final unless |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 165 | * isDoneCounting is {@code true}. |
Victoria Lease | d405a43 | 2012-03-22 15:53:48 -0700 | [diff] [blame] | 166 | */ |
Selim Gurun | 92b81a3 | 2012-08-21 17:32:35 -0700 | [diff] [blame] | 167 | public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, |
Victoria Lease | d405a43 | 2012-03-22 15:53:48 -0700 | [diff] [blame] | 168 | boolean isDoneCounting); |
| 169 | } |
| 170 | |
| 171 | /** |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 172 | * Callback interface supplied to {@link #postVisualStateCallback} for receiving |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 173 | * notifications about the visual state. |
| 174 | */ |
| 175 | public static abstract class VisualStateCallback { |
| 176 | /** |
| 177 | * Invoked when the visual state is ready to be drawn in the next {@link #onDraw}. |
| 178 | * |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 179 | * @param requestId The identifier passed to {@link #postVisualStateCallback} when this |
| 180 | * callback was posted. |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 181 | */ |
| 182 | public abstract void onComplete(long requestId); |
| 183 | } |
| 184 | |
| 185 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 186 | * Interface to listen for new pictures as they change. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 187 | * |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 188 | * @deprecated This interface is now obsolete. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 189 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 190 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 191 | public interface PictureListener { |
| 192 | /** |
Steve Block | 72498ed | 2012-07-17 15:57:25 +0100 | [diff] [blame] | 193 | * Used to provide notification that the WebView's picture has changed. |
| 194 | * See {@link WebView#capturePicture} for details of the picture. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 195 | * |
| 196 | * @param view the WebView that owns the picture |
Ben Murdoch | 52643e0 | 2013-02-26 12:01:00 +0000 | [diff] [blame] | 197 | * @param picture the new picture. Applications targeting |
| 198 | * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} or above |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 199 | * will always receive a {@code null} Picture. |
Steve Block | 72498ed | 2012-07-17 15:57:25 +0100 | [diff] [blame] | 200 | * @deprecated Deprecated due to internal changes. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 201 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 202 | @Deprecated |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 203 | void onNewPicture(WebView view, @Nullable Picture picture); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 204 | } |
| 205 | |
Jonathan Dixon | 19644b6 | 2011-12-21 14:21:36 +0000 | [diff] [blame] | 206 | public static class HitTestResult { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 207 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 208 | * Default HitTestResult, where the target is unknown. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 209 | */ |
| 210 | public static final int UNKNOWN_TYPE = 0; |
| 211 | /** |
Steve Block | 1854ddb | 2011-04-19 12:18:19 +0100 | [diff] [blame] | 212 | * @deprecated This type is no longer used. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 213 | */ |
Steve Block | 1854ddb | 2011-04-19 12:18:19 +0100 | [diff] [blame] | 214 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 215 | public static final int ANCHOR_TYPE = 1; |
| 216 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 217 | * HitTestResult for hitting a phone number. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 218 | */ |
| 219 | public static final int PHONE_TYPE = 2; |
| 220 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 221 | * HitTestResult for hitting a map address. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 222 | */ |
| 223 | public static final int GEO_TYPE = 3; |
| 224 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 225 | * HitTestResult for hitting an email address. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 226 | */ |
| 227 | public static final int EMAIL_TYPE = 4; |
| 228 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 229 | * HitTestResult for hitting an HTML::img tag. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 230 | */ |
| 231 | public static final int IMAGE_TYPE = 5; |
| 232 | /** |
Steve Block | 1854ddb | 2011-04-19 12:18:19 +0100 | [diff] [blame] | 233 | * @deprecated This type is no longer used. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 234 | */ |
Steve Block | 1854ddb | 2011-04-19 12:18:19 +0100 | [diff] [blame] | 235 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 236 | public static final int IMAGE_ANCHOR_TYPE = 6; |
| 237 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 238 | * HitTestResult for hitting a HTML::a tag with src=http. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 239 | */ |
| 240 | public static final int SRC_ANCHOR_TYPE = 7; |
| 241 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 242 | * HitTestResult for hitting a HTML::a tag with src=http + HTML::img. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 243 | */ |
| 244 | public static final int SRC_IMAGE_ANCHOR_TYPE = 8; |
| 245 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 246 | * HitTestResult for hitting an edit text area. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 247 | */ |
| 248 | public static final int EDIT_TEXT_TYPE = 9; |
| 249 | |
| 250 | private int mType; |
| 251 | private String mExtra; |
| 252 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 253 | /** |
| 254 | * @hide Only for use by WebViewProvider implementations |
| 255 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 256 | @SystemApi |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 257 | public HitTestResult() { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 258 | mType = UNKNOWN_TYPE; |
| 259 | } |
| 260 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 261 | /** |
| 262 | * @hide Only for use by WebViewProvider implementations |
| 263 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 264 | @SystemApi |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 265 | public void setType(int type) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 266 | mType = type; |
| 267 | } |
| 268 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 269 | /** |
| 270 | * @hide Only for use by WebViewProvider implementations |
| 271 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 272 | @SystemApi |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 273 | public void setExtra(String extra) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 274 | mExtra = extra; |
| 275 | } |
| 276 | |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 277 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 278 | * Gets the type of the hit test result. See the XXX_TYPE constants |
| 279 | * defined in this class. |
| 280 | * |
| 281 | * @return the type of the hit test result |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 282 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 283 | public int getType() { |
| 284 | return mType; |
| 285 | } |
| 286 | |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 287 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 288 | * Gets additional type-dependant information about the result. See |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 289 | * {@link WebView#getHitTestResult()} for details. May either be {@code null} |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 290 | * or contain extra information about this result. |
| 291 | * |
| 292 | * @return additional type-dependant information about the result |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 293 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 294 | @Nullable |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 295 | public String getExtra() { |
| 296 | return mExtra; |
| 297 | } |
| 298 | } |
| 299 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 300 | /** |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 301 | * Constructs a new WebView with an Activity Context object. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 302 | * |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 303 | * <p class="note"><b>Note:</b> WebView should always be instantiated with an Activity Context. |
| 304 | * If instantiated with an Application Context, WebView will be unable to provide several |
| 305 | * features, such as JavaScript dialogs and autofill. |
| 306 | * |
| 307 | * @param context an Activity Context to access application assets |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 308 | */ |
| 309 | public WebView(Context context) { |
| 310 | this(context, null); |
| 311 | } |
| 312 | |
| 313 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 314 | * Constructs a new WebView with layout parameters. |
| 315 | * |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 316 | * @param context an Activity Context to access application assets |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 317 | * @param attrs an AttributeSet passed to our parent |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 318 | */ |
| 319 | public WebView(Context context, AttributeSet attrs) { |
| 320 | this(context, attrs, com.android.internal.R.attr.webViewStyle); |
| 321 | } |
| 322 | |
| 323 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 324 | * Constructs a new WebView with layout parameters and a default style. |
| 325 | * |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 326 | * @param context an Activity Context to access application assets |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 327 | * @param attrs an AttributeSet passed to our parent |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 328 | * @param defStyleAttr an attribute in the current theme that contains a |
| 329 | * reference to a style resource that supplies default values for |
| 330 | * the view. Can be 0 to not look for defaults. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 331 | */ |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 332 | public WebView(Context context, AttributeSet attrs, int defStyleAttr) { |
| 333 | this(context, attrs, defStyleAttr, 0); |
Elliott Slaughter | f21d2e3 | 2010-07-14 18:08:54 -0700 | [diff] [blame] | 334 | } |
| 335 | |
| 336 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 337 | * Constructs a new WebView with layout parameters and a default style. |
| 338 | * |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 339 | * @param context an Activity Context to access application assets |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 340 | * @param attrs an AttributeSet passed to our parent |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 341 | * @param defStyleAttr an attribute in the current theme that contains a |
| 342 | * reference to a style resource that supplies default values for |
| 343 | * the view. Can be 0 to not look for defaults. |
| 344 | * @param defStyleRes a resource identifier of a style resource that |
| 345 | * supplies default values for the view, used only if |
| 346 | * defStyleAttr is 0 or can not be found in the theme. Can be 0 |
| 347 | * to not look for defaults. |
| 348 | */ |
| 349 | public WebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) { |
| 350 | this(context, attrs, defStyleAttr, defStyleRes, null, false); |
| 351 | } |
| 352 | |
| 353 | /** |
| 354 | * Constructs a new WebView with layout parameters and a default style. |
| 355 | * |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 356 | * @param context an Activity Context to access application assets |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 357 | * @param attrs an AttributeSet passed to our parent |
| 358 | * @param defStyleAttr an attribute in the current theme that contains a |
| 359 | * reference to a style resource that supplies default values for |
| 360 | * the view. Can be 0 to not look for defaults. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 361 | * @param privateBrowsing whether this WebView will be initialized in |
| 362 | * private mode |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 363 | * |
Selim Gurun | b6aa97e | 2014-03-26 14:10:28 -0700 | [diff] [blame] | 364 | * @deprecated Private browsing is no longer supported directly via |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 365 | * WebView and will be removed in a future release. Prefer using |
| 366 | * {@link WebSettings}, {@link WebViewDatabase}, {@link CookieManager} |
| 367 | * and {@link WebStorage} for fine-grained control of privacy data. |
Elliott Slaughter | f21d2e3 | 2010-07-14 18:08:54 -0700 | [diff] [blame] | 368 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 369 | @Deprecated |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 370 | public WebView(Context context, AttributeSet attrs, int defStyleAttr, |
Elliott Slaughter | f21d2e3 | 2010-07-14 18:08:54 -0700 | [diff] [blame] | 371 | boolean privateBrowsing) { |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 372 | this(context, attrs, defStyleAttr, 0, null, privateBrowsing); |
Andrei Popescu | 4950b2b | 2009-09-03 13:56:07 +0100 | [diff] [blame] | 373 | } |
| 374 | |
| 375 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 376 | * Constructs a new WebView with layout parameters, a default style and a set |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 377 | * of custom JavaScript interfaces to be added to this WebView at initialization |
Romain Guy | 01d0fbf | 2009-12-01 14:52:19 -0800 | [diff] [blame] | 378 | * time. This guarantees that these interfaces will be available when the JS |
Andrei Popescu | 4950b2b | 2009-09-03 13:56:07 +0100 | [diff] [blame] | 379 | * context is initialized. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 380 | * |
Nate Fischer | 674561a | 2017-10-26 12:28:01 -0700 | [diff] [blame] | 381 | * @param context an Activity Context to access application assets |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 382 | * @param attrs an AttributeSet passed to our parent |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 383 | * @param defStyleAttr an attribute in the current theme that contains a |
| 384 | * reference to a style resource that supplies default values for |
| 385 | * the view. Can be 0 to not look for defaults. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 386 | * @param javaScriptInterfaces a Map of interface names, as keys, and |
| 387 | * object implementing those interfaces, as |
| 388 | * values |
| 389 | * @param privateBrowsing whether this WebView will be initialized in |
| 390 | * private mode |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 391 | * @hide This is used internally by dumprendertree, as it requires the JavaScript interfaces to |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 392 | * be added synchronously, before a subsequent loadUrl call takes effect. |
Andrei Popescu | 4950b2b | 2009-09-03 13:56:07 +0100 | [diff] [blame] | 393 | */ |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 394 | @UnsupportedAppUsage |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 395 | protected WebView(Context context, AttributeSet attrs, int defStyleAttr, |
Steve Block | 81f19ff | 2010-11-01 13:23:24 +0000 | [diff] [blame] | 396 | Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) { |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 397 | this(context, attrs, defStyleAttr, 0, javaScriptInterfaces, privateBrowsing); |
| 398 | } |
| 399 | |
| 400 | /** |
| 401 | * @hide |
| 402 | */ |
| 403 | @SuppressWarnings("deprecation") // for super() call into deprecated base class constructor. |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 404 | @UnsupportedAppUsage |
Alan Viverette | 617feb9 | 2013-09-09 18:09:13 -0700 | [diff] [blame] | 405 | protected WebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes, |
| 406 | Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) { |
| 407 | super(context, attrs, defStyleAttr, defStyleRes); |
Felipe Leme | d04a697 | 2017-03-02 12:56:18 -0800 | [diff] [blame] | 408 | |
| 409 | // WebView is important by default, unless app developer overrode attribute. |
| 410 | if (getImportantForAutofill() == IMPORTANT_FOR_AUTOFILL_AUTO) { |
| 411 | setImportantForAutofill(IMPORTANT_FOR_AUTOFILL_YES); |
| 412 | } |
| 413 | |
Kristian Monsen | 87af731 | 2011-09-09 02:12:51 +0100 | [diff] [blame] | 414 | if (context == null) { |
| 415 | throw new IllegalArgumentException("Invalid context argument"); |
| 416 | } |
Gustav Sennton | 0167369 | 2018-01-19 12:11:25 +0000 | [diff] [blame] | 417 | if (mWebViewThread == null) { |
| 418 | throw new RuntimeException( |
| 419 | "WebView cannot be initialized on a thread that has no Looper."); |
| 420 | } |
Kristian Monsen | b5cd8c0 | 2013-04-09 17:57:37 -0700 | [diff] [blame] | 421 | sEnforceThreadChecking = context.getApplicationInfo().targetSdkVersion >= |
| 422 | Build.VERSION_CODES.JELLY_BEAN_MR2; |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 423 | checkThread(); |
Kristian Monsen | 87af731 | 2011-09-09 02:12:51 +0100 | [diff] [blame] | 424 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 425 | ensureProviderCreated(); |
| 426 | mProvider.init(javaScriptInterfaces, privateBrowsing); |
Jonathan Dixon | eb9e801 | 2013-10-03 11:03:31 +0100 | [diff] [blame] | 427 | // Post condition of creating a webview is the CookieSyncManager.getInstance() is allowed. |
| 428 | CookieSyncManager.setGetInstanceIsAllowed(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 429 | } |
| 430 | |
| 431 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 432 | * Specifies whether the horizontal scrollbar has overlay style. |
| 433 | * |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 434 | * @deprecated This method has no effect. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 435 | * @param overlay {@code true} if horizontal scrollbar should have overlay style |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 436 | */ |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 437 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 438 | public void setHorizontalScrollbarOverlay(boolean overlay) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 439 | } |
| 440 | |
| 441 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 442 | * Specifies whether the vertical scrollbar has overlay style. |
| 443 | * |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 444 | * @deprecated This method has no effect. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 445 | * @param overlay {@code true} if vertical scrollbar should have overlay style |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 446 | */ |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 447 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 448 | public void setVerticalScrollbarOverlay(boolean overlay) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 449 | } |
| 450 | |
| 451 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 452 | * Gets whether horizontal scrollbar has overlay style. |
| 453 | * |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 454 | * @deprecated This method is now obsolete. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 455 | * @return {@code true} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 456 | */ |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 457 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 458 | public boolean overlayHorizontalScrollbar() { |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 459 | // The old implementation defaulted to true, so return true for consistency |
| 460 | return true; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 461 | } |
| 462 | |
| 463 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 464 | * Gets whether vertical scrollbar has overlay style. |
| 465 | * |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 466 | * @deprecated This method is now obsolete. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 467 | * @return {@code false} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 468 | */ |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 469 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 470 | public boolean overlayVerticalScrollbar() { |
Paul Miller | c8694a0 | 2015-06-05 11:23:03 -0700 | [diff] [blame] | 471 | // The old implementation defaulted to false, so return false for consistency |
| 472 | return false; |
Mike Reed | e8853fc | 2009-09-04 14:01:48 -0400 | [diff] [blame] | 473 | } |
| 474 | |
Michael Kolb | e54f665 | 2011-03-16 09:11:51 -0700 | [diff] [blame] | 475 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 476 | * Gets the visible height (in pixels) of the embedded title bar (if any). |
Michael Kolb | 73980a9 | 2010-08-05 16:32:51 -0700 | [diff] [blame] | 477 | * |
Michael Kolb | 24e53b0 | 2011-03-16 12:52:04 -0700 | [diff] [blame] | 478 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 479 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
Mike Reed | e8853fc | 2009-09-04 14:01:48 -0400 | [diff] [blame] | 480 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 481 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 482 | @UnsupportedAppUsage |
Michael Kolb | 73980a9 | 2010-08-05 16:32:51 -0700 | [diff] [blame] | 483 | public int getVisibleTitleHeight() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 484 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 485 | return mProvider.getVisibleTitleHeight(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 486 | } |
| 487 | |
| 488 | /** |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 489 | * Gets the SSL certificate for the main top-level page or {@code null} if there is |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 490 | * no certificate (the site is not secure). |
| 491 | * |
| 492 | * @return the SSL certificate for the main top-level page |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 493 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 494 | @Nullable |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 495 | public SslCertificate getCertificate() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 496 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 497 | return mProvider.getCertificate(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 498 | } |
| 499 | |
| 500 | /** |
| 501 | * Sets the SSL certificate for the main top-level page. |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 502 | * |
| 503 | * @deprecated Calling this function has no useful effect, and will be |
| 504 | * ignored in future releases. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 505 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 506 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 507 | public void setCertificate(SslCertificate certificate) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 508 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 509 | mProvider.setCertificate(certificate); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 510 | } |
| 511 | |
| 512 | //------------------------------------------------------------------------- |
| 513 | // Methods called by activity |
| 514 | //------------------------------------------------------------------------- |
| 515 | |
| 516 | /** |
Steve Block | 32fe410 | 2012-07-17 16:29:11 +0100 | [diff] [blame] | 517 | * Sets a username and password pair for the specified host. This data is |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 518 | * used by the WebView to autocomplete username and password fields in web |
Steve Block | 32fe410 | 2012-07-17 16:29:11 +0100 | [diff] [blame] | 519 | * forms. Note that this is unrelated to the credentials used for HTTP |
| 520 | * authentication. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 521 | * |
Selim Gurun | 38915fd | 2013-04-04 17:14:29 +0000 | [diff] [blame] | 522 | * @param host the host that required the credentials |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 523 | * @param username the username for the given host |
| 524 | * @param password the password for the given host |
Steve Block | 32fe410 | 2012-07-17 16:29:11 +0100 | [diff] [blame] | 525 | * @see WebViewDatabase#clearUsernamePassword |
| 526 | * @see WebViewDatabase#hasUsernamePassword |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 527 | * @deprecated Saving passwords in WebView will not be supported in future versions. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 528 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 529 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 530 | public void savePassword(String host, String username, String password) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 531 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 532 | mProvider.savePassword(host, username, password); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 533 | } |
| 534 | |
| 535 | /** |
Hui Shu | 433fb93 | 2016-08-29 11:49:46 -0700 | [diff] [blame] | 536 | * Stores HTTP authentication credentials for a given host and realm to the {@link WebViewDatabase} |
| 537 | * instance. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 538 | * |
Steve Block | 46ce1db | 2012-07-17 16:43:00 +0100 | [diff] [blame] | 539 | * @param host the host to which the credentials apply |
| 540 | * @param realm the realm to which the credentials apply |
| 541 | * @param username the username |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 542 | * @param password the password |
Nate Fischer | c7edfb0 | 2016-09-23 15:59:21 -0700 | [diff] [blame] | 543 | * @deprecated Use {@link WebViewDatabase#setHttpAuthUsernamePassword} instead |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 544 | */ |
Nate Fischer | c7edfb0 | 2016-09-23 15:59:21 -0700 | [diff] [blame] | 545 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 546 | public void setHttpAuthUsernamePassword(String host, String realm, |
| 547 | String username, String password) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 548 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 549 | mProvider.setHttpAuthUsernamePassword(host, realm, username, password); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 550 | } |
| 551 | |
| 552 | /** |
Hui Shu | 433fb93 | 2016-08-29 11:49:46 -0700 | [diff] [blame] | 553 | * Retrieves HTTP authentication credentials for a given host and realm from the {@link |
| 554 | * WebViewDatabase} instance. |
Steve Block | 46ce1db | 2012-07-17 16:43:00 +0100 | [diff] [blame] | 555 | * @param host the host to which the credentials apply |
| 556 | * @param realm the realm to which the credentials apply |
| 557 | * @return the credentials as a String array, if found. The first element |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 558 | * is the username and the second element is the password. {@code null} if |
Steve Block | 46ce1db | 2012-07-17 16:43:00 +0100 | [diff] [blame] | 559 | * no credentials are found. |
Nate Fischer | c7edfb0 | 2016-09-23 15:59:21 -0700 | [diff] [blame] | 560 | * @deprecated Use {@link WebViewDatabase#getHttpAuthUsernamePassword} instead |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 561 | */ |
Nate Fischer | c7edfb0 | 2016-09-23 15:59:21 -0700 | [diff] [blame] | 562 | @Deprecated |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 563 | @Nullable |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 564 | public String[] getHttpAuthUsernamePassword(String host, String realm) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 565 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 566 | return mProvider.getHttpAuthUsernamePassword(host, realm); |
Leon Scroggins | 05919f2 | 2010-09-14 17:22:36 -0400 | [diff] [blame] | 567 | } |
| 568 | |
| 569 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 570 | * Destroys the internal state of this WebView. This method should be called |
| 571 | * after this WebView has been removed from the view system. No other |
| 572 | * methods may be called on this WebView after destroy. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 573 | */ |
| 574 | public void destroy() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 575 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 576 | mProvider.destroy(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 577 | } |
| 578 | |
| 579 | /** |
| 580 | * Enables platform notifications of data state and proxy changes. |
Kristian Monsen | cbb59db | 2011-05-09 16:04:34 +0100 | [diff] [blame] | 581 | * Notifications are enabled by default. |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 582 | * |
| 583 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 584 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 585 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 586 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 587 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 588 | public static void enablePlatformNotifications() { |
Kristian Monsen | 10ca808 | 2014-04-29 11:02:42 -0700 | [diff] [blame] | 589 | // noop |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 590 | } |
| 591 | |
| 592 | /** |
Kristian Monsen | cbb59db | 2011-05-09 16:04:34 +0100 | [diff] [blame] | 593 | * Disables platform notifications of data state and proxy changes. |
| 594 | * Notifications are enabled by default. |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 595 | * |
| 596 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 597 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 598 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 599 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 600 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 601 | public static void disablePlatformNotifications() { |
Kristian Monsen | 10ca808 | 2014-04-29 11:02:42 -0700 | [diff] [blame] | 602 | // noop |
Feng Qian | b308137 | 2009-06-29 15:55:18 -0700 | [diff] [blame] | 603 | } |
| 604 | |
| 605 | /** |
Primiano Tucci | 2442675 | 2013-09-05 12:01:51 +0100 | [diff] [blame] | 606 | * Used only by internal tests to free up memory. |
| 607 | * |
| 608 | * @hide |
| 609 | */ |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 610 | @UnsupportedAppUsage |
Primiano Tucci | 2442675 | 2013-09-05 12:01:51 +0100 | [diff] [blame] | 611 | public static void freeMemoryForTests() { |
Primiano Tucci | 2442675 | 2013-09-05 12:01:51 +0100 | [diff] [blame] | 612 | getFactory().getStatics().freeMemoryForTests(); |
| 613 | } |
| 614 | |
| 615 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 616 | * Informs WebView of the network state. This is used to set |
Steve Block | 81f19ff | 2010-11-01 13:23:24 +0000 | [diff] [blame] | 617 | * the JavaScript property window.navigator.isOnline and |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 618 | * generates the online/offline event as specified in HTML5, sec. 5.7.7 |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 619 | * |
| 620 | * @param networkUp a boolean indicating if network is available |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 621 | */ |
| 622 | public void setNetworkAvailable(boolean networkUp) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 623 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 624 | mProvider.setNetworkAvailable(networkUp); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 625 | } |
| 626 | |
| 627 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 628 | * Saves the state of this WebView used in |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 629 | * {@link android.app.Activity#onSaveInstanceState}. Please note that this |
| 630 | * method no longer stores the display data for this WebView. The previous |
| 631 | * behavior could potentially leak files if {@link #restoreState} was never |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 632 | * called. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 633 | * |
| 634 | * @param outState the Bundle to store this WebView's state |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 635 | * @return the same copy of the back/forward list used to save the state, {@code null} if the |
| 636 | * method fails. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 637 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 638 | @Nullable |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 639 | public WebBackForwardList saveState(Bundle outState) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 640 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 641 | return mProvider.saveState(outState); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 642 | } |
| 643 | |
| 644 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 645 | * Saves the current display data to the Bundle given. Used in conjunction |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 646 | * with {@link #saveState}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 647 | * @param b a Bundle to store the display data |
| 648 | * @param dest the file to store the serialized picture data. Will be |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 649 | * overwritten with this WebView's picture data. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 650 | * @return {@code true} if the picture was successfully saved |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 651 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 652 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 653 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 654 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 655 | @UnsupportedAppUsage |
Patrick Scott | da9a22b | 2010-04-08 08:32:52 -0400 | [diff] [blame] | 656 | public boolean savePicture(Bundle b, final File dest) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 657 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 658 | return mProvider.savePicture(b, dest); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 659 | } |
| 660 | |
| 661 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 662 | * Restores the display data that was saved in {@link #savePicture}. Used in |
| 663 | * conjunction with {@link #restoreState}. Note that this will not work if |
| 664 | * this WebView is hardware accelerated. |
John Reck | 2df8f42 | 2011-09-22 19:50:41 -0700 | [diff] [blame] | 665 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 666 | * @param b a Bundle containing the saved display data |
| 667 | * @param src the file where the picture data was stored |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 668 | * @return {@code true} if the picture was successfully restored |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 669 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 670 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 671 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 672 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 673 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 674 | public boolean restorePicture(Bundle b, File src) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 675 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 676 | return mProvider.restorePicture(b, src); |
John Reck | 95b7d6f | 2011-06-03 15:23:43 -0700 | [diff] [blame] | 677 | } |
| 678 | |
| 679 | /** |
Steve Block | 4249906 | 2012-07-17 15:34:46 +0100 | [diff] [blame] | 680 | * Restores the state of this WebView from the given Bundle. This method is |
| 681 | * intended for use in {@link android.app.Activity#onRestoreInstanceState} |
| 682 | * and should be called to restore the state of this WebView. If |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 683 | * it is called after this WebView has had a chance to build state (load |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 684 | * pages, create a back/forward list, etc.) there may be undesirable |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 685 | * side-effects. Please note that this method no longer restores the |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 686 | * display data for this WebView. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 687 | * |
| 688 | * @param inState the incoming Bundle of state |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 689 | * @return the restored back/forward list or {@code null} if restoreState failed |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 690 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 691 | @Nullable |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 692 | public WebBackForwardList restoreState(Bundle inState) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 693 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 694 | return mProvider.restoreState(inState); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 695 | } |
| 696 | |
| 697 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 698 | * Loads the given URL with the specified additional HTTP headers. |
Bo Liu | e29d313 | 2016-04-22 16:23:22 -0700 | [diff] [blame] | 699 | * <p> |
| 700 | * Also see compatibility note on {@link #evaluateJavascript}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 701 | * |
| 702 | * @param url the URL of the resource to load |
| 703 | * @param additionalHttpHeaders the additional headers to be used in the |
Steve Block | f71dea0 | 2011-08-01 12:29:14 +0100 | [diff] [blame] | 704 | * HTTP request for this URL, specified as a map from name to |
| 705 | * value. Note that if this map contains any of the headers |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 706 | * that are set by default by this WebView, such as those |
Steve Block | f71dea0 | 2011-08-01 12:29:14 +0100 | [diff] [blame] | 707 | * controlling caching, accept types or the User-Agent, their |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 708 | * values may be overridden by this WebView's defaults. |
Grace Kloba | d0d9bc2 | 2010-01-26 18:08:28 -0800 | [diff] [blame] | 709 | */ |
Steve Block | f71dea0 | 2011-08-01 12:29:14 +0100 | [diff] [blame] | 710 | public void loadUrl(String url, Map<String, String> additionalHttpHeaders) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 711 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 712 | mProvider.loadUrl(url, additionalHttpHeaders); |
Grace Kloba | d0d9bc2 | 2010-01-26 18:08:28 -0800 | [diff] [blame] | 713 | } |
| 714 | |
| 715 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 716 | * Loads the given URL. |
Bo Liu | e29d313 | 2016-04-22 16:23:22 -0700 | [diff] [blame] | 717 | * <p> |
| 718 | * Also see compatibility note on {@link #evaluateJavascript}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 719 | * |
| 720 | * @param url the URL of the resource to load |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 721 | */ |
| 722 | public void loadUrl(String url) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 723 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 724 | mProvider.loadUrl(url); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 725 | } |
| 726 | |
| 727 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 728 | * Loads the URL with postData using "POST" method into this WebView. If url |
Hui Shu | c60ad9c | 2014-02-05 09:30:36 -0800 | [diff] [blame] | 729 | * is not a network URL, it will be loaded with {@link #loadUrl(String)} |
| 730 | * instead, ignoring the postData param. |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 731 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 732 | * @param url the URL of the resource to load |
Ben Murdoch | 851004a | 2013-08-16 16:43:22 +0100 | [diff] [blame] | 733 | * @param postData the data will be passed to "POST" request, which must be |
| 734 | * be "application/x-www-form-urlencoded" encoded. |
Grace Kloba | 5753430 | 2009-05-22 18:55:02 -0700 | [diff] [blame] | 735 | */ |
| 736 | public void postUrl(String url, byte[] postData) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 737 | checkThread(); |
Hui Shu | c60ad9c | 2014-02-05 09:30:36 -0800 | [diff] [blame] | 738 | if (URLUtil.isNetworkUrl(url)) { |
| 739 | mProvider.postUrl(url, postData); |
| 740 | } else { |
| 741 | mProvider.loadUrl(url); |
| 742 | } |
Grace Kloba | 5753430 | 2009-05-22 18:55:02 -0700 | [diff] [blame] | 743 | } |
| 744 | |
| 745 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 746 | * Loads the given data into this WebView using a 'data' scheme URL. |
Steve Block | b28b22a | 2011-07-04 13:01:25 +0100 | [diff] [blame] | 747 | * <p> |
| 748 | * Note that JavaScript's same origin policy means that script running in a |
| 749 | * page loaded using this method will be unable to access content loaded |
| 750 | * using any scheme other than 'data', including 'http(s)'. To avoid this |
| 751 | * restriction, use {@link |
| 752 | * #loadDataWithBaseURL(String,String,String,String,String) |
| 753 | * loadDataWithBaseURL()} with an appropriate base URL. |
Steve Block | f95d490 | 2011-06-09 11:53:26 +0100 | [diff] [blame] | 754 | * <p> |
Nate Fischer | 867d109 | 2018-01-04 21:57:33 -0800 | [diff] [blame] | 755 | * The {@code encoding} parameter specifies whether the data is base64 or URL |
Steve Block | 27f3e32 | 2012-07-23 10:45:59 +0100 | [diff] [blame] | 756 | * encoded. If the data is base64 encoded, the value of the encoding |
Nate Fischer | 867d109 | 2018-01-04 21:57:33 -0800 | [diff] [blame] | 757 | * parameter must be 'base64'. HTML can be encoded with {@link |
| 758 | * android.util.Base64#encodeToString(byte[],int)} like so: |
| 759 | * <pre> |
| 760 | * String unencodedHtml = |
| 761 | * "<html><body>'%28' is the code for '('</body></html>"; |
| 762 | * String encodedHtml = Base64.encodeToString(unencodedHtml.getBytes(), Base64.NO_PADDING); |
| 763 | * webView.loadData(encodedHtml, "text/html", "base64"); |
| 764 | * </pre> |
| 765 | * <p> |
| 766 | * For all other values of {@code encoding} (including {@code null}) it is assumed that the |
| 767 | * data uses ASCII encoding for octets inside the range of safe URL characters and use the |
| 768 | * standard %xx hex encoding of URLs for octets outside that range. See <a |
| 769 | * href="https://tools.ietf.org/html/rfc3986#section-2.2">RFC 3986</a> for more information. |
Steve Block | b19c787 | 2011-10-10 14:09:44 +0100 | [diff] [blame] | 770 | * <p> |
James Wallace-Lee | d38c2e3 | 2017-12-11 16:11:15 -0800 | [diff] [blame] | 771 | * The {@code mimeType} parameter specifies the format of the data. |
| 772 | * If WebView can't handle the specified MIME type, it will download the data. |
| 773 | * If {@code null}, defaults to 'text/html'. |
| 774 | * <p> |
Steve Block | b19c787 | 2011-10-10 14:09:44 +0100 | [diff] [blame] | 775 | * The 'data' scheme URL formed by this method uses the default US-ASCII |
Torne (Richard Coles) | 97bf0be | 2018-05-16 10:51:56 -0400 | [diff] [blame] | 776 | * charset. If you need to set a different charset, you should form a |
Steve Block | 33f962b | 2011-10-11 14:49:47 +0100 | [diff] [blame] | 777 | * 'data' scheme URL which explicitly specifies a charset parameter in the |
| 778 | * mediatype portion of the URL and call {@link #loadUrl(String)} instead. |
| 779 | * Note that the charset obtained from the mediatype portion of a data URL |
| 780 | * always overrides that specified in the HTML or XML document itself. |
Torne (Richard Coles) | 97bf0be | 2018-05-16 10:51:56 -0400 | [diff] [blame] | 781 | * <p> |
| 782 | * Content loaded using this method will have a {@code window.origin} value |
| 783 | * of {@code "null"}. This must not be considered to be a trusted origin |
| 784 | * by the application or by any JavaScript code running inside the WebView |
| 785 | * (for example, event sources in DOM event handlers or web messages), |
| 786 | * because malicious content can also create frames with a null origin. If |
| 787 | * you need to identify the main frame's origin in a trustworthy way, you |
| 788 | * should use {@link #loadDataWithBaseURL(String,String,String,String,String) |
| 789 | * loadDataWithBaseURL()} with a valid HTTP or HTTPS base URL to set the |
| 790 | * origin. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 791 | * |
| 792 | * @param data a String of data in the given encoding |
James Wallace-Lee | d38c2e3 | 2017-12-11 16:11:15 -0800 | [diff] [blame] | 793 | * @param mimeType the MIME type of the data, e.g. 'text/html'. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 794 | * @param encoding the encoding of the data |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 795 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 796 | public void loadData(String data, @Nullable String mimeType, @Nullable String encoding) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 797 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 798 | mProvider.loadData(data, mimeType, encoding); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 799 | } |
| 800 | |
| 801 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 802 | * Loads the given data into this WebView, using baseUrl as the base URL for |
Steve Block | b28b22a | 2011-07-04 13:01:25 +0100 | [diff] [blame] | 803 | * the content. The base URL is used both to resolve relative URLs and when |
| 804 | * applying JavaScript's same origin policy. The historyUrl is used for the |
| 805 | * history entry. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 806 | * <p> |
James Wallace-Lee | d38c2e3 | 2017-12-11 16:11:15 -0800 | [diff] [blame] | 807 | * The {@code mimeType} parameter specifies the format of the data. |
| 808 | * If WebView can't handle the specified MIME type, it will download the data. |
| 809 | * If {@code null}, defaults to 'text/html'. |
| 810 | * <p> |
Steve Block | ae32857 | 2011-06-08 18:58:51 +0100 | [diff] [blame] | 811 | * Note that content specified in this way can access local device files |
| 812 | * (via 'file' scheme URLs) only if baseUrl specifies a scheme other than |
| 813 | * 'http', 'https', 'ftp', 'ftps', 'about' or 'javascript'. |
Steve Block | e482d89 | 2011-07-01 13:57:32 +0100 | [diff] [blame] | 814 | * <p> |
| 815 | * If the base URL uses the data scheme, this method is equivalent to |
| 816 | * calling {@link #loadData(String,String,String) loadData()} and the |
Ben Murdoch | 597256e | 2013-07-22 16:52:12 +0100 | [diff] [blame] | 817 | * historyUrl is ignored, and the data will be treated as part of a data: URL. |
| 818 | * If the base URL uses any other scheme, then the data will be loaded into |
| 819 | * the WebView as a plain string (i.e. not part of a data URL) and any URL-encoded |
| 820 | * entities in the string will not be decoded. |
Mikhail Naganov | b29e0f6 | 2015-09-16 13:05:53 -0700 | [diff] [blame] | 821 | * <p> |
| 822 | * Note that the baseUrl is sent in the 'Referer' HTTP header when |
| 823 | * requesting subresources (images, etc.) of the page loaded using this method. |
Torne (Richard Coles) | 97bf0be | 2018-05-16 10:51:56 -0400 | [diff] [blame] | 824 | * <p> |
| 825 | * If a valid HTTP or HTTPS base URL is not specified in {@code baseUrl}, then |
| 826 | * content loaded using this method will have a {@code window.origin} value |
| 827 | * of {@code "null"}. This must not be considered to be a trusted origin |
| 828 | * by the application or by any JavaScript code running inside the WebView |
| 829 | * (for example, event sources in DOM event handlers or web messages), |
| 830 | * because malicious content can also create frames with a null origin. If |
| 831 | * you need to identify the main frame's origin in a trustworthy way, you |
| 832 | * should use a valid HTTP or HTTPS base URL to set the origin. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 833 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 834 | * @param baseUrl the URL to use as the page's base URL. If {@code null} defaults to |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 835 | * 'about:blank'. |
| 836 | * @param data a String of data in the given encoding |
James Wallace-Lee | d38c2e3 | 2017-12-11 16:11:15 -0800 | [diff] [blame] | 837 | * @param mimeType the MIME type of the data, e.g. 'text/html'. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 838 | * @param encoding the encoding of the data |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 839 | * @param historyUrl the URL to use as the history entry. If {@code null} defaults |
Ben Murdoch | 95afb3b | 2013-02-25 19:18:19 +0000 | [diff] [blame] | 840 | * to 'about:blank'. If non-null, this must be a valid URL. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 841 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 842 | public void loadDataWithBaseURL(@Nullable String baseUrl, String data, |
| 843 | @Nullable String mimeType, @Nullable String encoding, @Nullable String historyUrl) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 844 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 845 | mProvider.loadDataWithBaseURL(baseUrl, data, mimeType, encoding, historyUrl); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 846 | } |
| 847 | |
| 848 | /** |
Ben Murdoch | a5cdd51 | 2013-07-17 16:25:07 +0100 | [diff] [blame] | 849 | * Asynchronously evaluates JavaScript in the context of the currently displayed page. |
Nate Fischer | e0938b8 | 2018-12-26 15:36:35 -0800 | [diff] [blame] | 850 | * If non-null, {@code resultCallback} will be invoked with any result returned from that |
Ben Murdoch | a5cdd51 | 2013-07-17 16:25:07 +0100 | [diff] [blame] | 851 | * execution. This method must be called on the UI thread and the callback will |
| 852 | * be made on the UI thread. |
Bo Liu | e29d313 | 2016-04-22 16:23:22 -0700 | [diff] [blame] | 853 | * <p> |
| 854 | * Compatibility note. Applications targeting {@link android.os.Build.VERSION_CODES#N} or |
| 855 | * later, JavaScript state from an empty WebView is no longer persisted across navigations like |
| 856 | * {@link #loadUrl(String)}. For example, global variables and functions defined before calling |
| 857 | * {@link #loadUrl(String)} will not exist in the loaded page. Applications should use |
| 858 | * {@link #addJavascriptInterface} instead to persist JavaScript objects across navigations. |
Ben Murdoch | a5cdd51 | 2013-07-17 16:25:07 +0100 | [diff] [blame] | 859 | * |
| 860 | * @param script the JavaScript to execute. |
| 861 | * @param resultCallback A callback to be invoked when the script execution |
| 862 | * completes with the result of the execution (if any). |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 863 | * May be {@code null} if no notification of the result is required. |
Ben Murdoch | a5cdd51 | 2013-07-17 16:25:07 +0100 | [diff] [blame] | 864 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 865 | public void evaluateJavascript(String script, @Nullable ValueCallback<String> resultCallback) { |
Ben Murdoch | a5cdd51 | 2013-07-17 16:25:07 +0100 | [diff] [blame] | 866 | checkThread(); |
| 867 | mProvider.evaluateJavaScript(script, resultCallback); |
| 868 | } |
| 869 | |
| 870 | /** |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 871 | * Saves the current view as a web archive. |
| 872 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 873 | * @param filename the filename where the archive should be placed |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 874 | */ |
| 875 | public void saveWebArchive(String filename) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 876 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 877 | mProvider.saveWebArchive(filename); |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 878 | } |
| 879 | |
| 880 | /** |
| 881 | * Saves the current view as a web archive. |
| 882 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 883 | * @param basename the filename where the archive should be placed |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 884 | * @param autoname if {@code false}, takes basename to be a file. If {@code true}, basename |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 885 | * is assumed to be a directory in which a filename will be |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 886 | * chosen according to the URL of the current page. |
| 887 | * @param callback called after the web archive has been saved. The |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 888 | * parameter for onReceiveValue will either be the filename |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 889 | * under which the file was saved, or {@code null} if saving the |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 890 | * file failed. |
| 891 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 892 | public void saveWebArchive(String basename, boolean autoname, @Nullable ValueCallback<String> |
| 893 | callback) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 894 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 895 | mProvider.saveWebArchive(basename, autoname, callback); |
Elliott Slaughter | b48fdbe | 2010-06-30 11:39:52 -0700 | [diff] [blame] | 896 | } |
| 897 | |
| 898 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 899 | * Stops the current load. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 900 | */ |
| 901 | public void stopLoading() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 902 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 903 | mProvider.stopLoading(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 904 | } |
| 905 | |
| 906 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 907 | * Reloads the current URL. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 908 | */ |
| 909 | public void reload() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 910 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 911 | mProvider.reload(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 912 | } |
| 913 | |
| 914 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 915 | * Gets whether this WebView has a back history item. |
| 916 | * |
Nate Fischer | 2be201e | 2017-10-26 10:43:00 -0700 | [diff] [blame] | 917 | * @return {@code true} if this WebView has a back history item |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 918 | */ |
| 919 | public boolean canGoBack() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 920 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 921 | return mProvider.canGoBack(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 922 | } |
| 923 | |
| 924 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 925 | * Goes back in the history of this WebView. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 926 | */ |
| 927 | public void goBack() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 928 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 929 | mProvider.goBack(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 930 | } |
| 931 | |
| 932 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 933 | * Gets whether this WebView has a forward history item. |
| 934 | * |
Nate Fischer | 2be201e | 2017-10-26 10:43:00 -0700 | [diff] [blame] | 935 | * @return {@code true} if this WebView has a forward history item |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 936 | */ |
| 937 | public boolean canGoForward() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 938 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 939 | return mProvider.canGoForward(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 940 | } |
| 941 | |
| 942 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 943 | * Goes forward in the history of this WebView. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 944 | */ |
| 945 | public void goForward() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 946 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 947 | mProvider.goForward(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 948 | } |
| 949 | |
| 950 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 951 | * Gets whether the page can go back or forward the given |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 952 | * number of steps. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 953 | * |
| 954 | * @param steps the negative or positive number of steps to move the |
| 955 | * history |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 956 | */ |
| 957 | public boolean canGoBackOrForward(int steps) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 958 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 959 | return mProvider.canGoBackOrForward(steps); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 960 | } |
| 961 | |
| 962 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 963 | * Goes to the history item that is the number of steps away from |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 964 | * the current item. Steps is negative if backward and positive |
| 965 | * if forward. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 966 | * |
| 967 | * @param steps the number of steps to take back or forward in the back |
| 968 | * forward list |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 969 | */ |
| 970 | public void goBackOrForward(int steps) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 971 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 972 | mProvider.goBackOrForward(steps); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 973 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 974 | |
Elliott Slaughter | f21d2e3 | 2010-07-14 18:08:54 -0700 | [diff] [blame] | 975 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 976 | * Gets whether private browsing is enabled in this WebView. |
Elliott Slaughter | f21d2e3 | 2010-07-14 18:08:54 -0700 | [diff] [blame] | 977 | */ |
Elliott Slaughter | 7c2d135 | 2010-08-20 15:57:18 -0700 | [diff] [blame] | 978 | public boolean isPrivateBrowsingEnabled() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 979 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 980 | return mProvider.isPrivateBrowsingEnabled(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 981 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 982 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 983 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 984 | * Scrolls the contents of this WebView up by half the view size. |
| 985 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 986 | * @param top {@code true} to jump to the top of the page |
| 987 | * @return {@code true} if the page was scrolled |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 988 | */ |
| 989 | public boolean pageUp(boolean top) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 990 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 991 | return mProvider.pageUp(top); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 992 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 993 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 994 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 995 | * Scrolls the contents of this WebView down by half the page size. |
| 996 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 997 | * @param bottom {@code true} to jump to bottom of page |
| 998 | * @return {@code true} if the page was scrolled |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 999 | */ |
| 1000 | public boolean pageDown(boolean bottom) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1001 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1002 | return mProvider.pageDown(bottom); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1003 | } |
| 1004 | |
| 1005 | /** |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1006 | * Posts a {@link VisualStateCallback}, which will be called when |
| 1007 | * the current state of the WebView is ready to be drawn. |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1008 | * |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1009 | * <p>Because updates to the DOM are processed asynchronously, updates to the DOM may not |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1010 | * immediately be reflected visually by subsequent {@link WebView#onDraw} invocations. The |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1011 | * {@link VisualStateCallback} provides a mechanism to notify the caller when the contents of |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1012 | * the DOM at the current time are ready to be drawn the next time the {@link WebView} |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 1013 | * draws. |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1014 | * |
| 1015 | * <p>The next draw after the callback completes is guaranteed to reflect all the updates to the |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1016 | * DOM up to the point at which the {@link VisualStateCallback} was posted, but it may also |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 1017 | * contain updates applied after the callback was posted. |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1018 | * |
| 1019 | * <p>The state of the DOM covered by this API includes the following: |
| 1020 | * <ul> |
| 1021 | * <li>primitive HTML elements (div, img, span, etc..)</li> |
| 1022 | * <li>images</li> |
| 1023 | * <li>CSS animations</li> |
| 1024 | * <li>WebGL</li> |
| 1025 | * <li>canvas</li> |
| 1026 | * </ul> |
| 1027 | * It does not include the state of: |
| 1028 | * <ul> |
| 1029 | * <li>the video tag</li> |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 1030 | * </ul> |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1031 | * |
| 1032 | * <p>To guarantee that the {@link WebView} will successfully render the first frame |
| 1033 | * after the {@link VisualStateCallback#onComplete} method has been called a set of conditions |
| 1034 | * must be met: |
| 1035 | * <ul> |
| 1036 | * <li>If the {@link WebView}'s visibility is set to {@link View#VISIBLE VISIBLE} then |
| 1037 | * the {@link WebView} must be attached to the view hierarchy.</li> |
| 1038 | * <li>If the {@link WebView}'s visibility is set to {@link View#INVISIBLE INVISIBLE} |
| 1039 | * then the {@link WebView} must be attached to the view hierarchy and must be made |
| 1040 | * {@link View#VISIBLE VISIBLE} from the {@link VisualStateCallback#onComplete} method.</li> |
| 1041 | * <li>If the {@link WebView}'s visibility is set to {@link View#GONE GONE} then the |
| 1042 | * {@link WebView} must be attached to the view hierarchy and its |
| 1043 | * {@link AbsoluteLayout.LayoutParams LayoutParams}'s width and height need to be set to fixed |
| 1044 | * values and must be made {@link View#VISIBLE VISIBLE} from the |
| 1045 | * {@link VisualStateCallback#onComplete} method.</li> |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 1046 | * </ul> |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1047 | * |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1048 | * <p>When using this API it is also recommended to enable pre-rasterization if the {@link |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1049 | * WebView} is off screen to avoid flickering. See {@link WebSettings#setOffscreenPreRaster} for |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 1050 | * more details and do consider its caveats. |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1051 | * |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1052 | * @param requestId An id that will be returned in the callback to allow callers to match |
| 1053 | * requests with callbacks. |
| 1054 | * @param callback The callback to be invoked. |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1055 | */ |
Tobias Sargeant | b365604 | 2015-05-13 11:23:57 +0100 | [diff] [blame] | 1056 | public void postVisualStateCallback(long requestId, VisualStateCallback callback) { |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1057 | checkThread(); |
Tobias Sargeant | a8352f4 | 2015-03-03 18:07:40 +0000 | [diff] [blame] | 1058 | mProvider.insertVisualStateCallback(requestId, callback); |
| 1059 | } |
| 1060 | |
| 1061 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1062 | * Clears this WebView so that onDraw() will draw nothing but white background, |
| 1063 | * and onMeasure() will return 0 if MeasureSpec is not MeasureSpec.EXACTLY. |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1064 | * @deprecated Use WebView.loadUrl("about:blank") to reliably reset the view state |
| 1065 | * and release page resources (including any running JavaScript). |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1066 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1067 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1068 | public void clearView() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1069 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1070 | mProvider.clearView(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1071 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1072 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1073 | /** |
Steve Block | 72498ed | 2012-07-17 15:57:25 +0100 | [diff] [blame] | 1074 | * Gets a new picture that captures the current contents of this WebView. |
| 1075 | * The picture is of the entire document being displayed, and is not |
| 1076 | * limited to the area currently displayed by this WebView. Also, the |
| 1077 | * picture is a static copy and is unaffected by later changes to the |
| 1078 | * content being displayed. |
| 1079 | * <p> |
| 1080 | * Note that due to internal changes, for API levels between |
| 1081 | * {@link android.os.Build.VERSION_CODES#HONEYCOMB} and |
| 1082 | * {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH} inclusive, the |
| 1083 | * picture does not include fixed position elements or scrollable divs. |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1084 | * <p> |
| 1085 | * Note that from {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} the returned picture |
| 1086 | * should only be drawn into bitmap-backed Canvas - using any other type of Canvas will involve |
| 1087 | * additional conversion at a cost in memory and performance. Also the |
| 1088 | * {@link android.graphics.Picture#createFromStream} and |
| 1089 | * {@link android.graphics.Picture#writeToStream} methods are not supported on the |
| 1090 | * returned object. |
| 1091 | * |
| 1092 | * @deprecated Use {@link #onDraw} to obtain a bitmap snapshot of the WebView, or |
Jonathan Dixon | df3859e | 2013-09-18 12:51:47 -0700 | [diff] [blame] | 1093 | * {@link #saveWebArchive} to save the content to a file. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1094 | * |
Steve Block | 72498ed | 2012-07-17 15:57:25 +0100 | [diff] [blame] | 1095 | * @return a picture that captures the current contents of this WebView |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1096 | */ |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1097 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1098 | public Picture capturePicture() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1099 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1100 | return mProvider.capturePicture(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1101 | } |
| 1102 | |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1103 | /** |
Selim Gurun | 23a1af6 | 2014-03-14 16:52:45 -0700 | [diff] [blame] | 1104 | * @deprecated Use {@link #createPrintDocumentAdapter(String)} which requires user |
| 1105 | * to provide a print document name. |
| 1106 | */ |
| 1107 | @Deprecated |
| 1108 | public PrintDocumentAdapter createPrintDocumentAdapter() { |
| 1109 | checkThread(); |
Selim Gurun | 23a1af6 | 2014-03-14 16:52:45 -0700 | [diff] [blame] | 1110 | return mProvider.createPrintDocumentAdapter("default"); |
| 1111 | } |
| 1112 | |
| 1113 | /** |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1114 | * Creates a PrintDocumentAdapter that provides the content of this WebView for printing. |
Selim Gurun | 2167c0b | 2013-08-05 15:23:09 -0700 | [diff] [blame] | 1115 | * |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1116 | * The adapter works by converting the WebView contents to a PDF stream. The WebView cannot |
Selim Gurun | da7d642 | 2013-09-06 14:39:05 -0700 | [diff] [blame] | 1117 | * be drawn during the conversion process - any such draws are undefined. It is recommended |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1118 | * to use a dedicated off screen WebView for the printing. If necessary, an application may |
Selim Gurun | da7d642 | 2013-09-06 14:39:05 -0700 | [diff] [blame] | 1119 | * temporarily hide a visible WebView by using a custom PrintDocumentAdapter instance |
| 1120 | * wrapped around the object returned and observing the onStart and onFinish methods. See |
| 1121 | * {@link android.print.PrintDocumentAdapter} for more information. |
Selim Gurun | 23a1af6 | 2014-03-14 16:52:45 -0700 | [diff] [blame] | 1122 | * |
| 1123 | * @param documentName The user-facing name of the printed document. See |
| 1124 | * {@link android.print.PrintDocumentInfo} |
Selim Gurun | 2167c0b | 2013-08-05 15:23:09 -0700 | [diff] [blame] | 1125 | */ |
Selim Gurun | 23a1af6 | 2014-03-14 16:52:45 -0700 | [diff] [blame] | 1126 | public PrintDocumentAdapter createPrintDocumentAdapter(String documentName) { |
Selim Gurun | 2167c0b | 2013-08-05 15:23:09 -0700 | [diff] [blame] | 1127 | checkThread(); |
Selim Gurun | 23a1af6 | 2014-03-14 16:52:45 -0700 | [diff] [blame] | 1128 | return mProvider.createPrintDocumentAdapter(documentName); |
Selim Gurun | 2167c0b | 2013-08-05 15:23:09 -0700 | [diff] [blame] | 1129 | } |
| 1130 | |
| 1131 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1132 | * Gets the current scale of this WebView. |
| 1133 | * |
| 1134 | * @return the current scale |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 1135 | * |
| 1136 | * @deprecated This method is prone to inaccuracy due to race conditions |
| 1137 | * between the web rendering and UI threads; prefer |
| 1138 | * {@link WebViewClient#onScaleChanged}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1139 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 1140 | @Deprecated |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 1141 | @ViewDebug.ExportedProperty(category = "webview") |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1142 | public float getScale() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1143 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1144 | return mProvider.getScale(); |
Mangesh Ghiware | b5f9fc3 | 2011-08-31 17:49:07 -0700 | [diff] [blame] | 1145 | } |
| 1146 | |
| 1147 | /** |
Mikhail Naganov | 0030336 | 2013-09-02 10:57:04 +0100 | [diff] [blame] | 1148 | * Sets the initial scale for this WebView. 0 means default. |
| 1149 | * The behavior for the default scale depends on the state of |
| 1150 | * {@link WebSettings#getUseWideViewPort()} and |
| 1151 | * {@link WebSettings#getLoadWithOverviewMode()}. |
| 1152 | * If the content fits into the WebView control by width, then |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1153 | * the zoom is set to 100%. For wide content, the behavior |
Mikhail Naganov | 0030336 | 2013-09-02 10:57:04 +0100 | [diff] [blame] | 1154 | * depends on the state of {@link WebSettings#getLoadWithOverviewMode()}. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1155 | * If its value is {@code true}, the content will be zoomed out to be fit |
Mikhail Naganov | 0030336 | 2013-09-02 10:57:04 +0100 | [diff] [blame] | 1156 | * by width into the WebView control, otherwise not. |
| 1157 | * |
| 1158 | * If initial scale is greater than 0, WebView starts with this value |
| 1159 | * as initial scale. |
Mangesh Ghiware | e832b63 | 2011-11-16 11:46:39 -0800 | [diff] [blame] | 1160 | * Please note that unlike the scale properties in the viewport meta tag, |
| 1161 | * this method doesn't take the screen density into account. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1162 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1163 | * @param scaleInPercent the initial scale in percent |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1164 | */ |
| 1165 | public void setInitialScale(int scaleInPercent) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1166 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1167 | mProvider.setInitialScale(scaleInPercent); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1168 | } |
| 1169 | |
| 1170 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1171 | * Invokes the graphical zoom picker widget for this WebView. This will |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1172 | * result in the zoom widget appearing on the screen to control the zoom |
| 1173 | * level of this WebView. |
| 1174 | */ |
| 1175 | public void invokeZoomPicker() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1176 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1177 | mProvider.invokeZoomPicker(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1178 | } |
| 1179 | |
| 1180 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1181 | * Gets a HitTestResult based on the current cursor node. If a HTML::a |
| 1182 | * tag is found and the anchor has a non-JavaScript URL, the HitTestResult |
| 1183 | * type is set to SRC_ANCHOR_TYPE and the URL is set in the "extra" field. |
| 1184 | * If the anchor does not have a URL or if it is a JavaScript URL, the type |
| 1185 | * will be UNKNOWN_TYPE and the URL has to be retrieved through |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1186 | * {@link #requestFocusNodeHref} asynchronously. If a HTML::img tag is |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1187 | * found, the HitTestResult type is set to IMAGE_TYPE and the URL is set in |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1188 | * the "extra" field. A type of |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1189 | * SRC_IMAGE_ANCHOR_TYPE indicates an anchor with a URL that has an image as |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1190 | * a child node. If a phone number is found, the HitTestResult type is set |
| 1191 | * to PHONE_TYPE and the phone number is set in the "extra" field of |
| 1192 | * HitTestResult. If a map address is found, the HitTestResult type is set |
| 1193 | * to GEO_TYPE and the address is set in the "extra" field of HitTestResult. |
| 1194 | * If an email address is found, the HitTestResult type is set to EMAIL_TYPE |
| 1195 | * and the email is set in the "extra" field of HitTestResult. Otherwise, |
| 1196 | * HitTestResult type is set to UNKNOWN_TYPE. |
| 1197 | */ |
| 1198 | public HitTestResult getHitTestResult() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1199 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1200 | return mProvider.getHitTestResult(); |
Cary Clark | b849134 | 2010-11-29 16:23:19 -0500 | [diff] [blame] | 1201 | } |
| 1202 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1203 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1204 | * Requests the anchor or image element URL at the last tapped point. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1205 | * If hrefMsg is {@code null}, this method returns immediately and does not |
Cary Clark | 861368a | 2010-12-15 11:24:37 -0500 | [diff] [blame] | 1206 | * dispatch hrefMsg to its target. If the tapped point hits an image, |
| 1207 | * an anchor, or an image in an anchor, the message associates |
| 1208 | * strings in named keys in its data. The value paired with the key |
| 1209 | * may be an empty string. |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1210 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1211 | * @param hrefMsg the message to be dispatched with the result of the |
| 1212 | * request. The message data contains three keys. "url" |
| 1213 | * returns the anchor's href attribute. "title" returns the |
| 1214 | * anchor's text. "src" returns the image's src attribute. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1215 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1216 | public void requestFocusNodeHref(@Nullable Message hrefMsg) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1217 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1218 | mProvider.requestFocusNodeHref(hrefMsg); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1219 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1220 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1221 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1222 | * Requests the URL of the image last touched by the user. msg will be sent |
| 1223 | * to its target with a String representing the URL as its object. |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1224 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1225 | * @param msg the message to be dispatched with the result of the request |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1226 | * as the data member with "url" as key. The result can be {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1227 | */ |
| 1228 | public void requestImageRef(Message msg) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1229 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1230 | mProvider.requestImageRef(msg); |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 1231 | } |
| 1232 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1233 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1234 | * Gets the URL for the current page. This is not always the same as the URL |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1235 | * passed to WebViewClient.onPageStarted because although the load for |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1236 | * that URL has begun, the current page may not have changed. |
| 1237 | * |
| 1238 | * @return the URL for the current page |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1239 | */ |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 1240 | @ViewDebug.ExportedProperty(category = "webview") |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1241 | public String getUrl() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1242 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1243 | return mProvider.getUrl(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1244 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1245 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1246 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1247 | * Gets the original URL for the current page. This is not always the same |
| 1248 | * as the URL passed to WebViewClient.onPageStarted because although the |
| 1249 | * load for that URL has begun, the current page may not have changed. |
| 1250 | * Also, there may have been redirects resulting in a different URL to that |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1251 | * originally requested. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1252 | * |
| 1253 | * @return the URL that was originally requested for the current page |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1254 | */ |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 1255 | @ViewDebug.ExportedProperty(category = "webview") |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1256 | public String getOriginalUrl() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1257 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1258 | return mProvider.getOriginalUrl(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1259 | } |
| 1260 | |
| 1261 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1262 | * Gets the title for the current page. This is the title of the current page |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1263 | * until WebViewClient.onReceivedTitle is called. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1264 | * |
| 1265 | * @return the title for the current page |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1266 | */ |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 1267 | @ViewDebug.ExportedProperty(category = "webview") |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1268 | public String getTitle() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1269 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1270 | return mProvider.getTitle(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1271 | } |
| 1272 | |
| 1273 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1274 | * Gets the favicon for the current page. This is the favicon of the current |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1275 | * page until WebViewClient.onReceivedIcon is called. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1276 | * |
| 1277 | * @return the favicon for the current page |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1278 | */ |
| 1279 | public Bitmap getFavicon() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1280 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1281 | return mProvider.getFavicon(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1282 | } |
| 1283 | |
| 1284 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1285 | * Gets the touch icon URL for the apple-touch-icon <link> element, or |
Ben Murdoch | 372dfc8 | 2010-07-01 15:56:01 +0100 | [diff] [blame] | 1286 | * a URL on this site's server pointing to the standard location of a |
| 1287 | * touch icon. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1288 | * |
Patrick Scott | 2ba1262 | 2009-08-04 13:20:05 -0400 | [diff] [blame] | 1289 | * @hide |
| 1290 | */ |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 1291 | @UnsupportedAppUsage |
Patrick Scott | 2ba1262 | 2009-08-04 13:20:05 -0400 | [diff] [blame] | 1292 | public String getTouchIconUrl() { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1293 | return mProvider.getTouchIconUrl(); |
Patrick Scott | 2ba1262 | 2009-08-04 13:20:05 -0400 | [diff] [blame] | 1294 | } |
| 1295 | |
| 1296 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1297 | * Gets the progress for the current page. |
| 1298 | * |
| 1299 | * @return the progress for the current page between 0 and 100 |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1300 | */ |
| 1301 | public int getProgress() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1302 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1303 | return mProvider.getProgress(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1304 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1305 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1306 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1307 | * Gets the height of the HTML content. |
| 1308 | * |
| 1309 | * @return the height of the HTML content |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1310 | */ |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 1311 | @ViewDebug.ExportedProperty(category = "webview") |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1312 | public int getContentHeight() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1313 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1314 | return mProvider.getContentHeight(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1315 | } |
| 1316 | |
| 1317 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1318 | * Gets the width of the HTML content. |
| 1319 | * |
| 1320 | * @return the width of the HTML content |
Leon Scroggins | ea96d1e | 2009-09-23 13:41:01 -0400 | [diff] [blame] | 1321 | * @hide |
| 1322 | */ |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 1323 | @ViewDebug.ExportedProperty(category = "webview") |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 1324 | @UnsupportedAppUsage |
Leon Scroggins | ea96d1e | 2009-09-23 13:41:01 -0400 | [diff] [blame] | 1325 | public int getContentWidth() { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1326 | return mProvider.getContentWidth(); |
John Reck | 9b90d55 | 2011-06-14 15:19:17 -0700 | [diff] [blame] | 1327 | } |
| 1328 | |
| 1329 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1330 | * Pauses all layout, parsing, and JavaScript timers for all WebViews. This |
| 1331 | * is a global requests, not restricted to just this WebView. This can be |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1332 | * useful if the application has been paused. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1333 | */ |
| 1334 | public void pauseTimers() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1335 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1336 | mProvider.pauseTimers(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1337 | } |
| 1338 | |
| 1339 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1340 | * Resumes all layout, parsing, and JavaScript timers for all WebViews. |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1341 | * This will resume dispatching all timers. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1342 | */ |
| 1343 | public void resumeTimers() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1344 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1345 | mProvider.resumeTimers(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1346 | } |
| 1347 | |
| 1348 | /** |
Selim Gurun | 922cb58 | 2015-07-31 11:49:22 -0700 | [diff] [blame] | 1349 | * Does a best-effort attempt to pause any processing that can be paused |
| 1350 | * safely, such as animations and geolocation. Note that this call |
| 1351 | * does not pause JavaScript. To pause JavaScript globally, use |
| 1352 | * {@link #pauseTimers}. |
| 1353 | * |
| 1354 | * To resume WebView, call {@link #onResume}. |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1355 | */ |
| 1356 | public void onPause() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1357 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1358 | mProvider.onPause(); |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1359 | } |
| 1360 | |
| 1361 | /** |
Selim Gurun | 922cb58 | 2015-07-31 11:49:22 -0700 | [diff] [blame] | 1362 | * Resumes a WebView after a previous call to {@link #onPause}. |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1363 | */ |
| 1364 | public void onResume() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1365 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1366 | mProvider.onResume(); |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1367 | } |
| 1368 | |
| 1369 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1370 | * Gets whether this WebView is paused, meaning onPause() was called. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1371 | * Calling onResume() sets the paused state back to {@code false}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1372 | * |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1373 | * @hide |
| 1374 | */ |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 1375 | @UnsupportedAppUsage |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1376 | public boolean isPaused() { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1377 | return mProvider.isPaused(); |
Mike Reed | d205d5b | 2009-05-27 11:02:29 -0400 | [diff] [blame] | 1378 | } |
| 1379 | |
| 1380 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1381 | * Informs this WebView that memory is low so that it can free any available |
| 1382 | * memory. |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1383 | * @deprecated Memory caches are automatically dropped when no longer needed, and in response |
| 1384 | * to system memory pressure. |
Derek Sollenberger | e0155e9 | 2009-06-10 15:35:45 -0400 | [diff] [blame] | 1385 | */ |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1386 | @Deprecated |
Derek Sollenberger | e0155e9 | 2009-06-10 15:35:45 -0400 | [diff] [blame] | 1387 | public void freeMemory() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1388 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1389 | mProvider.freeMemory(); |
Derek Sollenberger | e0155e9 | 2009-06-10 15:35:45 -0400 | [diff] [blame] | 1390 | } |
| 1391 | |
| 1392 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1393 | * Clears the resource cache. Note that the cache is per-application, so |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 1394 | * this will clear the cache for all WebViews used. |
| 1395 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1396 | * @param includeDiskFiles if {@code false}, only the RAM cache is cleared |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1397 | */ |
| 1398 | public void clearCache(boolean includeDiskFiles) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1399 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1400 | mProvider.clearCache(includeDiskFiles); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1401 | } |
| 1402 | |
| 1403 | /** |
Steve Block | 219dfa4 | 2012-07-20 10:31:21 +0100 | [diff] [blame] | 1404 | * Removes the autocomplete popup from the currently focused form field, if |
| 1405 | * present. Note this only affects the display of the autocomplete popup, |
| 1406 | * it does not remove any saved form data from this WebView's store. To do |
| 1407 | * that, use {@link WebViewDatabase#clearFormData}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1408 | */ |
| 1409 | public void clearFormData() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1410 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1411 | mProvider.clearFormData(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1412 | } |
| 1413 | |
| 1414 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1415 | * Tells this WebView to clear its internal back/forward list. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1416 | */ |
| 1417 | public void clearHistory() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1418 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1419 | mProvider.clearHistory(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1420 | } |
| 1421 | |
| 1422 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1423 | * Clears the SSL preferences table stored in response to proceeding with |
| 1424 | * SSL certificate errors. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1425 | */ |
| 1426 | public void clearSslPreferences() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1427 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1428 | mProvider.clearSslPreferences(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1429 | } |
| 1430 | |
| 1431 | /** |
Selim Gurun | ee89ab4 | 2014-06-13 10:53:55 -0700 | [diff] [blame] | 1432 | * Clears the client certificate preferences stored in response |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1433 | * to proceeding/cancelling client cert requests. Note that WebView |
Torne (Richard Coles) | 5326772 | 2018-06-20 15:31:49 -0400 | [diff] [blame] | 1434 | * automatically clears these preferences when the system keychain is updated. |
| 1435 | * The preferences are shared by all the WebViews that are created by the embedder application. |
Selim Gurun | b6aa97e | 2014-03-26 14:10:28 -0700 | [diff] [blame] | 1436 | * |
Selim Gurun | e1c6c3a | 2014-04-28 14:21:21 -0700 | [diff] [blame] | 1437 | * @param onCleared A runnable to be invoked when client certs are cleared. |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1438 | * The runnable will be called in UI thread. |
Selim Gurun | b6aa97e | 2014-03-26 14:10:28 -0700 | [diff] [blame] | 1439 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1440 | public static void clearClientCertPreferences(@Nullable Runnable onCleared) { |
Selim Gurun | e1c6c3a | 2014-04-28 14:21:21 -0700 | [diff] [blame] | 1441 | getFactory().getStatics().clearClientCertPreferences(onCleared); |
Selim Gurun | b6aa97e | 2014-03-26 14:10:28 -0700 | [diff] [blame] | 1442 | } |
| 1443 | |
| 1444 | /** |
Nate Fischer | 2b108d8 | 2017-08-21 17:59:55 -0700 | [diff] [blame] | 1445 | * Starts Safe Browsing initialization. |
Nate Fischer | 471891d | 2017-07-18 19:15:52 -0700 | [diff] [blame] | 1446 | * <p> |
Nate Fischer | 2b108d8 | 2017-08-21 17:59:55 -0700 | [diff] [blame] | 1447 | * URL loads are not guaranteed to be protected by Safe Browsing until after {@code callback} is |
| 1448 | * invoked with {@code true}. Safe Browsing is not fully supported on all devices. For those |
| 1449 | * devices {@code callback} will receive {@code false}. |
Nate Fischer | 471891d | 2017-07-18 19:15:52 -0700 | [diff] [blame] | 1450 | * <p> |
Nate Fischer | fb92ee1 | 2018-01-18 12:01:19 -0800 | [diff] [blame] | 1451 | * This should not be called if Safe Browsing has been disabled by manifest tag or {@link |
| 1452 | * WebSettings#setSafeBrowsingEnabled}. This prepares resources used for Safe Browsing. |
Nate Fischer | 471891d | 2017-07-18 19:15:52 -0700 | [diff] [blame] | 1453 | * <p> |
Nate Fischer | 2b108d8 | 2017-08-21 17:59:55 -0700 | [diff] [blame] | 1454 | * This should be called with the Application Context (and will always use the Application |
| 1455 | * context to do its work regardless). |
Nate Fischer | 471891d | 2017-07-18 19:15:52 -0700 | [diff] [blame] | 1456 | * |
Nate Fischer | 3ca196a | 2017-07-12 18:45:03 -0700 | [diff] [blame] | 1457 | * @param context Application Context. |
Nate Fischer | 2b108d8 | 2017-08-21 17:59:55 -0700 | [diff] [blame] | 1458 | * @param callback will be called on the UI thread with {@code true} if initialization is |
| 1459 | * successful, {@code false} otherwise. |
Nate Fischer | 0e72c18 | 2017-05-30 11:25:17 -0700 | [diff] [blame] | 1460 | */ |
Nate Fischer | 65e3be0 | 2018-03-01 00:55:35 -0800 | [diff] [blame] | 1461 | public static void startSafeBrowsing(@NonNull Context context, |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1462 | @Nullable ValueCallback<Boolean> callback) { |
Nate Fischer | 0e72c18 | 2017-05-30 11:25:17 -0700 | [diff] [blame] | 1463 | getFactory().getStatics().initSafeBrowsing(context, callback); |
| 1464 | } |
| 1465 | |
| 1466 | /** |
Nate Fischer | 5a6ae8c | 2018-02-21 15:27:01 -0800 | [diff] [blame] | 1467 | * Sets the list of hosts (domain names/IP addresses) that are exempt from SafeBrowsing checks. |
| 1468 | * The list is global for all the WebViews. |
Selim Gurun | 89e9359 | 2017-07-28 10:33:58 -0700 | [diff] [blame] | 1469 | * <p> |
| 1470 | * Each rule should take one of these: |
| 1471 | * <table> |
| 1472 | * <tr><th> Rule </th> <th> Example </th> <th> Matches Subdomain</th> </tr> |
Nate Fischer | fbebfa9 | 2017-08-29 16:17:22 -0700 | [diff] [blame] | 1473 | * <tr><td> HOSTNAME </td> <td> example.com </td> <td> Yes </td> </tr> |
| 1474 | * <tr><td> .HOSTNAME </td> <td> .example.com </td> <td> No </td> </tr> |
| 1475 | * <tr><td> IPV4_LITERAL </td> <td> 192.168.1.1 </td> <td> No </td></tr> |
| 1476 | * <tr><td> IPV6_LITERAL_WITH_BRACKETS </td><td>[10:20:30:40:50:60:70:80]</td><td>No</td></tr> |
Selim Gurun | 89e9359 | 2017-07-28 10:33:58 -0700 | [diff] [blame] | 1477 | * </table> |
| 1478 | * <p> |
| 1479 | * All other rules, including wildcards, are invalid. |
Nate Fischer | 5a6ae8c | 2018-02-21 15:27:01 -0800 | [diff] [blame] | 1480 | * <p> |
| 1481 | * The correct syntax for hosts is defined by <a |
| 1482 | * href="https://tools.ietf.org/html/rfc3986#section-3.2.2">RFC 3986</a>. |
Nate Fischer | bf158ec | 2017-06-27 22:52:20 -0700 | [diff] [blame] | 1483 | * |
Nate Fischer | 5a6ae8c | 2018-02-21 15:27:01 -0800 | [diff] [blame] | 1484 | * @param hosts the list of hosts |
| 1485 | * @param callback will be called with {@code true} if hosts are successfully added to the |
| 1486 | * whitelist. It will be called with {@code false} if any hosts are malformed. The callback |
| 1487 | * will be run on the UI thread |
Nate Fischer | bf158ec | 2017-06-27 22:52:20 -0700 | [diff] [blame] | 1488 | */ |
Nate Fischer | 5a6ae8c | 2018-02-21 15:27:01 -0800 | [diff] [blame] | 1489 | public static void setSafeBrowsingWhitelist(@NonNull List<String> hosts, |
Nate Fischer | d6385d3 | 2017-07-17 12:58:18 -0700 | [diff] [blame] | 1490 | @Nullable ValueCallback<Boolean> callback) { |
Nate Fischer | 5a6ae8c | 2018-02-21 15:27:01 -0800 | [diff] [blame] | 1491 | getFactory().getStatics().setSafeBrowsingWhitelist(hosts, callback); |
Nate Fischer | bf158ec | 2017-06-27 22:52:20 -0700 | [diff] [blame] | 1492 | } |
| 1493 | |
| 1494 | /** |
Nate Fischer | 3898ac1 | 2017-08-09 23:02:36 -0700 | [diff] [blame] | 1495 | * Returns a URL pointing to the privacy policy for Safe Browsing reporting. |
| 1496 | * |
| 1497 | * @return the url pointing to a privacy policy document which can be displayed to users. |
| 1498 | */ |
| 1499 | @NonNull |
| 1500 | public static Uri getSafeBrowsingPrivacyPolicyUrl() { |
| 1501 | return getFactory().getStatics().getSafeBrowsingPrivacyPolicyUrl(); |
| 1502 | } |
| 1503 | |
| 1504 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1505 | * Gets the WebBackForwardList for this WebView. This contains the |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1506 | * back/forward list for use in querying each item in the history stack. |
| 1507 | * This is a copy of the private WebBackForwardList so it contains only a |
| 1508 | * snapshot of the current state. Multiple calls to this method may return |
| 1509 | * different objects. The object returned from this method will not be |
| 1510 | * updated to reflect any new state. |
| 1511 | */ |
| 1512 | public WebBackForwardList copyBackForwardList() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1513 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1514 | return mProvider.copyBackForwardList(); |
| 1515 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1516 | } |
| 1517 | |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1518 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1519 | * Registers the listener to be notified as find-on-page operations |
| 1520 | * progress. This will replace the current listener. |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1521 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1522 | * @param listener an implementation of {@link FindListener} |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1523 | */ |
| 1524 | public void setFindListener(FindListener listener) { |
| 1525 | checkThread(); |
Ben Murdoch | 52c9f7f | 2013-01-18 00:50:37 +0000 | [diff] [blame] | 1526 | setupFindListenerIfNeeded(); |
| 1527 | mFindListener.mUserFindListener = listener; |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1528 | } |
| 1529 | |
| 1530 | /** |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 1531 | * Highlights and scrolls to the next match found by |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1532 | * {@link #findAllAsync}, wrapping around page boundaries as necessary. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 1533 | * Notifies any registered {@link FindListener}. If {@link #findAllAsync(String)} |
| 1534 | * has not been called yet, or if {@link #clearMatches} has been called since the |
| 1535 | * last find operation, this function does nothing. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1536 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1537 | * @param forward the direction to search |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1538 | * @see #setFindListener |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1539 | */ |
| 1540 | public void findNext(boolean forward) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1541 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1542 | mProvider.findNext(forward); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1543 | } |
| 1544 | |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1545 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1546 | * Finds all instances of find on the page and highlights them. |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1547 | * Notifies any registered {@link FindListener}. |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1548 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1549 | * @param find the string to find |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 1550 | * @return the number of occurrences of the String "find" that were found |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1551 | * @deprecated {@link #findAllAsync} is preferred. |
| 1552 | * @see #setFindListener |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1553 | */ |
Jonathan Dixon | 9f21c1c | 2012-04-12 11:14:20 +0100 | [diff] [blame] | 1554 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1555 | public int findAll(String find) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1556 | checkThread(); |
Jonathan Dixon | 9f21c1c | 2012-04-12 11:14:20 +0100 | [diff] [blame] | 1557 | StrictMode.noteSlowCall("findAll blocks UI: prefer findAllAsync"); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1558 | return mProvider.findAll(find); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1559 | } |
| 1560 | |
Cary Clark | 3403eb3 | 2010-03-03 10:05:16 -0500 | [diff] [blame] | 1561 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1562 | * Finds all instances of find on the page and highlights them, |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1563 | * asynchronously. Notifies any registered {@link FindListener}. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 1564 | * Successive calls to this will cancel any pending searches. |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1565 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1566 | * @param find the string to find. |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1567 | * @see #setFindListener |
Victoria Lease | abeb6a7 | 2012-03-05 16:29:12 -0800 | [diff] [blame] | 1568 | */ |
| 1569 | public void findAllAsync(String find) { |
| 1570 | checkThread(); |
| 1571 | mProvider.findAllAsync(find); |
| 1572 | } |
| 1573 | |
| 1574 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1575 | * Starts an ActionMode for finding text in this WebView. Only works if this |
| 1576 | * WebView is attached to the view system. |
| 1577 | * |
| 1578 | * @param text if non-null, will be the initial text to search for. |
Leon Scroggins | fe026bd | 2010-08-24 14:16:09 -0400 | [diff] [blame] | 1579 | * Otherwise, the last String searched for in this WebView will |
| 1580 | * be used to start. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1581 | * @param showIme if {@code true}, show the IME, assuming the user will begin typing. |
| 1582 | * If {@code false} and text is non-null, perform a find all. |
| 1583 | * @return {@code true} if the find dialog is shown, {@code false} otherwise |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1584 | * @deprecated This method does not work reliably on all Android versions; |
| 1585 | * implementing a custom find dialog using WebView.findAllAsync() |
| 1586 | * provides a more robust solution. |
Cary Clark | de023c1 | 2010-03-03 10:05:16 -0500 | [diff] [blame] | 1587 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1588 | @Deprecated |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1589 | public boolean showFindDialog(@Nullable String text, boolean showIme) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1590 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1591 | return mProvider.showFindDialog(text, showIme); |
Leon Scroggins | fe026bd | 2010-08-24 14:16:09 -0400 | [diff] [blame] | 1592 | } |
| 1593 | |
| 1594 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1595 | * Gets the first substring consisting of the address of a physical |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1596 | * location. Currently, only addresses in the United States are detected, |
| 1597 | * and consist of: |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1598 | * <ul> |
| 1599 | * <li>a house number</li> |
| 1600 | * <li>a street name</li> |
| 1601 | * <li>a street type (Road, Circle, etc), either spelled out or |
| 1602 | * abbreviated</li> |
| 1603 | * <li>a city name</li> |
| 1604 | * <li>a state or territory, either spelled out or two-letter abbr</li> |
| 1605 | * <li>an optional 5 digit or 9 digit zip code</li> |
| 1606 | * </ul> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1607 | * All names must be correctly capitalized, and the zip code, if present, |
| 1608 | * must be valid for the state. The street type must be a standard USPS |
| 1609 | * spelling or abbreviation. The state or territory must also be spelled |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1610 | * or abbreviated using USPS standards. The house number may not exceed |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1611 | * five digits. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1612 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1613 | * @param addr the string to search for addresses |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1614 | * @return the address, or if no address is found, {@code null} |
Jan Althaus | 003889a | 2018-04-04 15:29:10 +0200 | [diff] [blame] | 1615 | * @deprecated this method is superseded by {@link TextClassifier#generateLinks( |
| 1616 | * android.view.textclassifier.TextLinks.Request)}. Avoid using this method even when targeting |
| 1617 | * API levels where no alternative is available. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1618 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1619 | @Nullable |
Jan Althaus | 003889a | 2018-04-04 15:29:10 +0200 | [diff] [blame] | 1620 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1621 | public static String findAddress(String addr) { |
Tobias Sargeant | f4d85d8 | 2018-01-05 14:34:38 +0000 | [diff] [blame] | 1622 | if (addr == null) { |
| 1623 | throw new NullPointerException("addr is null"); |
| 1624 | } |
| 1625 | return FindAddress.findAddress(addr); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1626 | } |
| 1627 | |
Victoria Lease | 0b8413b | 2012-03-26 13:04:10 -0700 | [diff] [blame] | 1628 | /** |
Selim Gurun | 17d1adb | 2014-08-27 11:22:26 -0700 | [diff] [blame] | 1629 | * For apps targeting the L release, WebView has a new default behavior that reduces |
| 1630 | * memory footprint and increases performance by intelligently choosing |
| 1631 | * the portion of the HTML document that needs to be drawn. These |
| 1632 | * optimizations are transparent to the developers. However, under certain |
| 1633 | * circumstances, an App developer may want to disable them: |
Ben Murdoch | 574fa34 | 2015-01-07 14:20:45 +0000 | [diff] [blame] | 1634 | * <ol> |
| 1635 | * <li>When an app uses {@link #onDraw} to do own drawing and accesses portions |
| 1636 | * of the page that is way outside the visible portion of the page.</li> |
| 1637 | * <li>When an app uses {@link #capturePicture} to capture a very large HTML document. |
| 1638 | * Note that capturePicture is a deprecated API.</li> |
| 1639 | * </ol> |
Selim Gurun | 17d1adb | 2014-08-27 11:22:26 -0700 | [diff] [blame] | 1640 | * Enabling drawing the entire HTML document has a significant performance |
| 1641 | * cost. This method should be called before any WebViews are created. |
Bo Liu | 9f3ed85 | 2014-07-18 10:03:12 -0700 | [diff] [blame] | 1642 | */ |
| 1643 | public static void enableSlowWholeDocumentDraw() { |
| 1644 | getFactory().getStatics().enableSlowWholeDocumentDraw(); |
| 1645 | } |
| 1646 | |
| 1647 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1648 | * Clears the highlighting surrounding text matches created by |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 1649 | * {@link #findAllAsync}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1650 | */ |
| 1651 | public void clearMatches() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1652 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1653 | mProvider.clearMatches(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1654 | } |
| 1655 | |
| 1656 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1657 | * Queries the document to see if it contains any image references. The |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1658 | * message object will be dispatched with arg1 being set to 1 if images |
| 1659 | * were found and 0 if the document does not reference any images. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1660 | * |
| 1661 | * @param response the message that will be dispatched with the result |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1662 | */ |
| 1663 | public void documentHasImages(Message response) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1664 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1665 | mProvider.documentHasImages(response); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1666 | } |
| 1667 | |
| 1668 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1669 | * Sets the WebViewClient that will receive various notifications and |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1670 | * requests. This will replace the current handler. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1671 | * |
| 1672 | * @param client an implementation of WebViewClient |
Nate Fischer | 6e58584 | 2016-09-29 18:30:58 -0700 | [diff] [blame] | 1673 | * @see #getWebViewClient |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1674 | */ |
| 1675 | public void setWebViewClient(WebViewClient client) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1676 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1677 | mProvider.setWebViewClient(client); |
Grace Kloba | 94ab3b6 | 2009-10-07 18:00:19 -0700 | [diff] [blame] | 1678 | } |
| 1679 | |
| 1680 | /** |
Nate Fischer | 6e58584 | 2016-09-29 18:30:58 -0700 | [diff] [blame] | 1681 | * Gets the WebViewClient. |
| 1682 | * |
| 1683 | * @return the WebViewClient, or a default client if not yet set |
| 1684 | * @see #setWebViewClient |
| 1685 | */ |
| 1686 | public WebViewClient getWebViewClient() { |
| 1687 | checkThread(); |
| 1688 | return mProvider.getWebViewClient(); |
| 1689 | } |
| 1690 | |
| 1691 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1692 | * Registers the interface to be used when content can not be handled by |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1693 | * the rendering engine, and should be downloaded instead. This will replace |
| 1694 | * the current handler. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1695 | * |
| 1696 | * @param listener an implementation of DownloadListener |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1697 | */ |
| 1698 | public void setDownloadListener(DownloadListener listener) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1699 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1700 | mProvider.setDownloadListener(listener); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1701 | } |
| 1702 | |
| 1703 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1704 | * Sets the chrome handler. This is an implementation of WebChromeClient for |
Steve Block | 81f19ff | 2010-11-01 13:23:24 +0000 | [diff] [blame] | 1705 | * use in handling JavaScript dialogs, favicons, titles, and the progress. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1706 | * This will replace the current handler. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1707 | * |
| 1708 | * @param client an implementation of WebChromeClient |
Nate Fischer | 6e58584 | 2016-09-29 18:30:58 -0700 | [diff] [blame] | 1709 | * @see #getWebChromeClient |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1710 | */ |
| 1711 | public void setWebChromeClient(WebChromeClient client) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1712 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1713 | mProvider.setWebChromeClient(client); |
Patrick Scott | 0b2e84b | 2010-03-02 08:58:44 -0500 | [diff] [blame] | 1714 | } |
| 1715 | |
| 1716 | /** |
Nate Fischer | 6e58584 | 2016-09-29 18:30:58 -0700 | [diff] [blame] | 1717 | * Gets the chrome handler. |
| 1718 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1719 | * @return the WebChromeClient, or {@code null} if not yet set |
Nate Fischer | 6e58584 | 2016-09-29 18:30:58 -0700 | [diff] [blame] | 1720 | * @see #setWebChromeClient |
| 1721 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1722 | @Nullable |
Nate Fischer | 6e58584 | 2016-09-29 18:30:58 -0700 | [diff] [blame] | 1723 | public WebChromeClient getWebChromeClient() { |
| 1724 | checkThread(); |
| 1725 | return mProvider.getWebChromeClient(); |
| 1726 | } |
| 1727 | |
| 1728 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1729 | * Sets the Picture listener. This is an interface used to receive |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1730 | * notifications of a new Picture. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1731 | * |
| 1732 | * @param listener an implementation of WebView.PictureListener |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 1733 | * @deprecated This method is now obsolete. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1734 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 1735 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1736 | public void setPictureListener(PictureListener listener) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1737 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1738 | mProvider.setPictureListener(listener); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1739 | } |
| 1740 | |
| 1741 | /** |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1742 | * Injects the supplied Java object into this WebView. The object is |
| 1743 | * injected into the JavaScript context of the main frame, using the |
Selim Gurun | e91d5be | 2012-09-11 16:11:22 -0700 | [diff] [blame] | 1744 | * supplied name. This allows the Java object's methods to be |
Selim Gurun | b4c02e6 | 2012-09-12 13:36:21 -0700 | [diff] [blame] | 1745 | * accessed from JavaScript. For applications targeted to API |
| 1746 | * level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
Selim Gurun | e91d5be | 2012-09-11 16:11:22 -0700 | [diff] [blame] | 1747 | * and above, only public methods that are annotated with |
| 1748 | * {@link android.webkit.JavascriptInterface} can be accessed from JavaScript. |
Selim Gurun | b4c02e6 | 2012-09-12 13:36:21 -0700 | [diff] [blame] | 1749 | * For applications targeted to API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN} or below, |
Selim Gurun | e91d5be | 2012-09-11 16:11:22 -0700 | [diff] [blame] | 1750 | * all public methods (including the inherited ones) can be accessed, see the |
Selim Gurun | b4c02e6 | 2012-09-12 13:36:21 -0700 | [diff] [blame] | 1751 | * important security note below for implications. |
Nate Fischer | 02e281a | 2017-08-21 12:03:58 -0700 | [diff] [blame] | 1752 | * <p> Note that injected objects will not appear in JavaScript until the page is next |
| 1753 | * (re)loaded. JavaScript should be enabled before injecting the object. For example: |
Selim Gurun | e91d5be | 2012-09-11 16:11:22 -0700 | [diff] [blame] | 1754 | * <pre> |
| 1755 | * class JsObject { |
| 1756 | * {@literal @}JavascriptInterface |
| 1757 | * public String toString() { return "injectedObject"; } |
| 1758 | * } |
Nate Fischer | 02e281a | 2017-08-21 12:03:58 -0700 | [diff] [blame] | 1759 | * webview.getSettings().setJavaScriptEnabled(true); |
Selim Gurun | e91d5be | 2012-09-11 16:11:22 -0700 | [diff] [blame] | 1760 | * webView.addJavascriptInterface(new JsObject(), "injectedObject"); |
Steve Block | 4cd73c5 | 2011-11-09 13:06:52 +0000 | [diff] [blame] | 1761 | * webView.loadData("<!DOCTYPE html><title></title>", "text/html", null); |
| 1762 | * webView.loadUrl("javascript:alert(injectedObject.toString())");</pre> |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1763 | * <p> |
| 1764 | * <strong>IMPORTANT:</strong> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1765 | * <ul> |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1766 | * <li> This method can be used to allow JavaScript to control the host |
| 1767 | * application. This is a powerful feature, but also presents a security |
Scott Rowe | 607c17f | 2014-08-07 11:42:09 -0700 | [diff] [blame] | 1768 | * risk for apps targeting {@link android.os.Build.VERSION_CODES#JELLY_BEAN} or earlier. |
| 1769 | * Apps that target a version later than {@link android.os.Build.VERSION_CODES#JELLY_BEAN} |
| 1770 | * are still vulnerable if the app runs on a device running Android earlier than 4.2. |
| 1771 | * The most secure way to use this method is to target {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
| 1772 | * and to ensure the method is called only when running on Android 4.2 or later. |
| 1773 | * With these older versions, JavaScript could use reflection to access an |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1774 | * injected object's public fields. Use of this method in a WebView |
| 1775 | * containing untrusted content could allow an attacker to manipulate the |
| 1776 | * host application in unintended ways, executing Java code with the |
| 1777 | * permissions of the host application. Use extreme care when using this |
| 1778 | * method in a WebView which could contain untrusted content.</li> |
Steve Block | 4cd73c5 | 2011-11-09 13:06:52 +0000 | [diff] [blame] | 1779 | * <li> JavaScript interacts with Java object on a private, background |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1780 | * thread of this WebView. Care is therefore required to maintain thread |
Scott Rowe | 607c17f | 2014-08-07 11:42:09 -0700 | [diff] [blame] | 1781 | * safety. |
| 1782 | * </li> |
Selim Gurun | e91d5be | 2012-09-11 16:11:22 -0700 | [diff] [blame] | 1783 | * <li> The Java object's fields are not accessible.</li> |
Dianne Hackborn | 955d8d6 | 2014-10-07 20:17:19 -0700 | [diff] [blame] | 1784 | * <li> For applications targeted to API level {@link android.os.Build.VERSION_CODES#LOLLIPOP} |
Mikhail Naganov | d380b20 | 2014-04-10 18:07:42 +0100 | [diff] [blame] | 1785 | * and above, methods of injected Java objects are enumerable from |
| 1786 | * JavaScript.</li> |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1787 | * </ul> |
| 1788 | * |
| 1789 | * @param object the Java object to inject into this WebView's JavaScript |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1790 | * context. {@code null} values are ignored. |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1791 | * @param name the name used to expose the object in JavaScript |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1792 | */ |
Steve Block | 4cd73c5 | 2011-11-09 13:06:52 +0000 | [diff] [blame] | 1793 | public void addJavascriptInterface(Object object, String name) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1794 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1795 | mProvider.addJavascriptInterface(object, name); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1796 | } |
| 1797 | |
| 1798 | /** |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1799 | * Removes a previously injected Java object from this WebView. Note that |
| 1800 | * the removal will not be reflected in JavaScript until the page is next |
| 1801 | * (re)loaded. See {@link #addJavascriptInterface}. |
| 1802 | * |
| 1803 | * @param name the name used to expose the object in JavaScript |
Steve Block | 689a342 | 2010-12-07 18:18:26 +0000 | [diff] [blame] | 1804 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 1805 | public void removeJavascriptInterface(@NonNull String name) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1806 | checkThread(); |
Steve Block | 3aa800b | 2012-04-24 13:01:34 +0100 | [diff] [blame] | 1807 | mProvider.removeJavascriptInterface(name); |
Steve Block | 689a342 | 2010-12-07 18:18:26 +0000 | [diff] [blame] | 1808 | } |
| 1809 | |
| 1810 | /** |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1811 | * Creates a message channel to communicate with JS and returns the message |
| 1812 | * ports that represent the endpoints of this message channel. The HTML5 message |
Selim Gurun | 0a814b6 | 2015-05-13 10:15:55 -0700 | [diff] [blame] | 1813 | * channel functionality is described |
| 1814 | * <a href="https://html.spec.whatwg.org/multipage/comms.html#messagechannel">here |
| 1815 | * </a> |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1816 | * |
Nate Fischer | f02f846 | 2017-09-11 15:16:33 -0700 | [diff] [blame] | 1817 | * <p>The returned message channels are entangled and already in started state. |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1818 | * |
| 1819 | * @return the two message ports that form the message channel. |
| 1820 | */ |
| 1821 | public WebMessagePort[] createWebMessageChannel() { |
| 1822 | checkThread(); |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1823 | return mProvider.createWebMessageChannel(); |
| 1824 | } |
| 1825 | |
| 1826 | /** |
| 1827 | * Post a message to main frame. The embedded application can restrict the |
| 1828 | * messages to a certain target origin. See |
Selim Gurun | 0a814b6 | 2015-05-13 10:15:55 -0700 | [diff] [blame] | 1829 | * <a href="https://html.spec.whatwg.org/multipage/comms.html#posting-messages"> |
| 1830 | * HTML5 spec</a> for how target origin can be used. |
Selim Gurun | b18fbfa | 2017-05-18 11:50:26 -0700 | [diff] [blame] | 1831 | * <p> |
| 1832 | * A target origin can be set as a wildcard ("*"). However this is not recommended. |
| 1833 | * See the page above for security issues. |
Torne (Richard Coles) | 97bf0be | 2018-05-16 10:51:56 -0400 | [diff] [blame] | 1834 | * <p> |
| 1835 | * Content loaded via {@link #loadData(String,String,String)} will not have a |
| 1836 | * valid origin, and thus cannot be sent messages securely. If you need to send |
| 1837 | * messages using this function, you should use |
| 1838 | * {@link #loadDataWithBaseURL(String,String,String,String,String)} with a valid |
| 1839 | * HTTP or HTTPS {@code baseUrl} to define a valid origin that can be used for |
| 1840 | * messaging. |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1841 | * |
| 1842 | * @param message the WebMessage |
Selim Gurun | b18fbfa | 2017-05-18 11:50:26 -0700 | [diff] [blame] | 1843 | * @param targetOrigin the target origin. |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1844 | */ |
Selim Gurun | 26de90a | 2015-05-15 11:02:45 -0700 | [diff] [blame] | 1845 | public void postWebMessage(WebMessage message, Uri targetOrigin) { |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1846 | checkThread(); |
Selim Gurun | 4c8093a | 2015-03-10 17:40:06 -0700 | [diff] [blame] | 1847 | mProvider.postMessageToMainFrame(message, targetOrigin); |
| 1848 | } |
| 1849 | |
| 1850 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1851 | * Gets the WebSettings object used to control the settings for this |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1852 | * WebView. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1853 | * |
| 1854 | * @return a WebSettings object that can be used to control this WebView's |
| 1855 | * settings |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1856 | */ |
| 1857 | public WebSettings getSettings() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1858 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1859 | return mProvider.getSettings(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1860 | } |
| 1861 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1862 | /** |
Mikhail Naganov | 057989e | 2013-09-06 16:35:25 -0700 | [diff] [blame] | 1863 | * Enables debugging of web contents (HTML / CSS / JavaScript) |
| 1864 | * loaded into any WebViews of this application. This flag can be enabled |
| 1865 | * in order to facilitate debugging of web layouts and JavaScript |
| 1866 | * code running inside WebViews. Please refer to WebView documentation |
| 1867 | * for the debugging guide. |
| 1868 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 1869 | * The default is {@code false}. |
Mikhail Naganov | 057989e | 2013-09-06 16:35:25 -0700 | [diff] [blame] | 1870 | * |
| 1871 | * @param enabled whether to enable web contents debugging |
| 1872 | */ |
| 1873 | public static void setWebContentsDebuggingEnabled(boolean enabled) { |
Mikhail Naganov | 057989e | 2013-09-06 16:35:25 -0700 | [diff] [blame] | 1874 | getFactory().getStatics().setWebContentsDebuggingEnabled(enabled); |
| 1875 | } |
| 1876 | |
| 1877 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1878 | * Gets the list of currently loaded plugins. |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1879 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1880 | * @return the list of currently loaded plugins |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1881 | * @deprecated This was used for Gears, which has been deprecated. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1882 | * @hide |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1883 | */ |
Andrei Popescu | 385df69 | 2009-08-13 11:59:57 +0100 | [diff] [blame] | 1884 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 1885 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1886 | public static synchronized PluginList getPluginList() { |
Grace Kloba | bb245ea | 2009-11-10 13:13:24 -0800 | [diff] [blame] | 1887 | return new PluginList(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1888 | } |
| 1889 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1890 | /** |
Torne (Richard Coles) | 12f64da | 2017-10-24 14:59:07 -0400 | [diff] [blame] | 1891 | * Define the directory used to store WebView data for the current process. |
| 1892 | * The provided suffix will be used when constructing data and cache |
| 1893 | * directory paths. If this API is not called, no suffix will be used. |
| 1894 | * Each directory can be used by only one process in the application. If more |
| 1895 | * than one process in an app wishes to use WebView, only one process can use |
| 1896 | * the default directory, and other processes must call this API to define |
| 1897 | * a unique suffix. |
| 1898 | * <p> |
Torne (Richard Coles) | de956b7 | 2018-01-29 16:58:44 -0500 | [diff] [blame] | 1899 | * This means that different processes in the same application cannot directly |
| 1900 | * share WebView-related data, since the data directories must be distinct. |
| 1901 | * Applications that use this API may have to explicitly pass data between |
| 1902 | * processes. For example, login cookies may have to be copied from one |
| 1903 | * process's cookie jar to the other using {@link CookieManager} if both |
| 1904 | * processes' WebViews are intended to be logged in. |
| 1905 | * <p> |
| 1906 | * Most applications should simply ensure that all components of the app |
| 1907 | * that rely on WebView are in the same process, to avoid needing multiple |
| 1908 | * data directories. The {@link #disableWebView} method can be used to ensure |
| 1909 | * that the other processes do not use WebView by accident in this case. |
| 1910 | * <p> |
Torne (Richard Coles) | 12f64da | 2017-10-24 14:59:07 -0400 | [diff] [blame] | 1911 | * This API must be called before any instances of WebView are created in |
| 1912 | * this process and before any other methods in the android.webkit package |
| 1913 | * are called by this process. |
| 1914 | * |
| 1915 | * @param suffix The directory name suffix to be used for the current |
| 1916 | * process. Must not contain a path separator. |
| 1917 | * @throws IllegalStateException if WebView has already been initialized |
| 1918 | * in the current process. |
| 1919 | * @throws IllegalArgumentException if the suffix contains a path separator. |
| 1920 | */ |
| 1921 | public static void setDataDirectorySuffix(String suffix) { |
| 1922 | WebViewFactory.setDataDirectorySuffix(suffix); |
| 1923 | } |
| 1924 | |
| 1925 | /** |
| 1926 | * Indicate that the current process does not intend to use WebView, and |
| 1927 | * that an exception should be thrown if a WebView is created or any other |
| 1928 | * methods in the android.webkit package are used. |
| 1929 | * <p> |
| 1930 | * Applications with multiple processes may wish to call this in processes |
Torne (Richard Coles) | de956b7 | 2018-01-29 16:58:44 -0500 | [diff] [blame] | 1931 | * that are not intended to use WebView to avoid accidentally incurring |
| 1932 | * the memory usage of initializing WebView in long-lived processes that |
| 1933 | * have no need for it, and to prevent potential data directory conflicts |
| 1934 | * (see {@link #setDataDirectorySuffix}). |
| 1935 | * <p> |
| 1936 | * For example, an audio player application with one process for its |
| 1937 | * activities and another process for its playback service may wish to call |
| 1938 | * this method in the playback service's {@link android.app.Service#onCreate}. |
Torne (Richard Coles) | 12f64da | 2017-10-24 14:59:07 -0400 | [diff] [blame] | 1939 | * |
| 1940 | * @throws IllegalStateException if WebView has already been initialized |
| 1941 | * in the current process. |
| 1942 | */ |
| 1943 | public static void disableWebView() { |
| 1944 | WebViewFactory.disableWebView(); |
| 1945 | } |
| 1946 | |
| 1947 | |
| 1948 | /** |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1949 | * @deprecated This was used for Gears, which has been deprecated. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1950 | * @hide |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1951 | */ |
Andrei Popescu | 385df69 | 2009-08-13 11:59:57 +0100 | [diff] [blame] | 1952 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 1953 | @UnsupportedAppUsage |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1954 | public void refreshPlugins(boolean reloadOpenPages) { |
| 1955 | checkThread(); |
| 1956 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1957 | |
Cary Clark | 966641a | 2010-03-04 08:41:56 -0500 | [diff] [blame] | 1958 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1959 | * Puts this WebView into text selection mode. Do not rely on this |
| 1960 | * functionality; it will be deprecated in the future. |
| 1961 | * |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 1962 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 1963 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
Cary Clark | 966641a | 2010-03-04 08:41:56 -0500 | [diff] [blame] | 1964 | */ |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 1965 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 1966 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1967 | public void emulateShiftHeld() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 1968 | checkThread(); |
Steve Howard | 16bd937 | 2010-04-12 14:46:09 -0700 | [diff] [blame] | 1969 | } |
| 1970 | |
Leon Scroggins | a57632f | 2009-11-16 10:51:12 -0500 | [diff] [blame] | 1971 | /** |
| 1972 | * @deprecated WebView no longer needs to implement |
| 1973 | * ViewGroup.OnHierarchyChangeListener. This method does nothing now. |
| 1974 | */ |
George Mount | fab67a1 | 2012-01-05 09:58:53 -0800 | [diff] [blame] | 1975 | @Override |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 1976 | // Cannot add @hide as this can always be accessed via the interface. |
Leon Scroggins | a57632f | 2009-11-16 10:51:12 -0500 | [diff] [blame] | 1977 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1978 | public void onChildViewAdded(View parent, View child) {} |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 1979 | |
Leon Scroggins | a57632f | 2009-11-16 10:51:12 -0500 | [diff] [blame] | 1980 | /** |
| 1981 | * @deprecated WebView no longer needs to implement |
| 1982 | * ViewGroup.OnHierarchyChangeListener. This method does nothing now. |
| 1983 | */ |
George Mount | fab67a1 | 2012-01-05 09:58:53 -0800 | [diff] [blame] | 1984 | @Override |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 1985 | // Cannot add @hide as this can always be accessed via the interface. |
Leon Scroggins | a57632f | 2009-11-16 10:51:12 -0500 | [diff] [blame] | 1986 | @Deprecated |
| 1987 | public void onChildViewRemoved(View p, View child) {} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1988 | |
| 1989 | /** |
| 1990 | * @deprecated WebView should not have implemented |
Gilles Debunne | 0e7d652d | 2011-02-22 15:26:14 -0800 | [diff] [blame] | 1991 | * ViewTreeObserver.OnGlobalFocusChangeListener. This method does nothing now. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1992 | */ |
George Mount | fab67a1 | 2012-01-05 09:58:53 -0800 | [diff] [blame] | 1993 | @Override |
Jonathan Dixon | e230e54 | 2011-12-21 10:57:00 +0000 | [diff] [blame] | 1994 | // Cannot add @hide as this can always be accessed via the interface. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1995 | @Deprecated |
| 1996 | public void onGlobalFocusChanged(View oldFocus, View newFocus) { |
| 1997 | } |
| 1998 | |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 1999 | /** |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2000 | * @deprecated Only the default case, {@code true}, will be supported in a future version. |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 2001 | */ |
| 2002 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2003 | public void setMapTrackballToArrowKeys(boolean setMap) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2004 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2005 | mProvider.setMapTrackballToArrowKeys(setMap); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2006 | } |
| 2007 | |
Derek Sollenberger | 03e4891 | 2010-05-18 17:03:42 -0400 | [diff] [blame] | 2008 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2009 | public void flingScroll(int vx, int vy) { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2010 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2011 | mProvider.flingScroll(vx, vy); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2012 | } |
| 2013 | |
The Android Open Source Project | c39a6e0 | 2009-03-11 12:11:56 -0700 | [diff] [blame] | 2014 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2015 | * Gets the zoom controls for this WebView, as a separate View. The caller |
| 2016 | * is responsible for inserting this View into the layout hierarchy. |
The Android Open Source Project | c39a6e0 | 2009-03-11 12:11:56 -0700 | [diff] [blame] | 2017 | * <p/> |
Steve Block | b838aef | 2012-04-23 18:22:15 +0100 | [diff] [blame] | 2018 | * API level {@link android.os.Build.VERSION_CODES#CUPCAKE} introduced |
| 2019 | * built-in zoom mechanisms for the WebView, as opposed to these separate |
| 2020 | * zoom controls. The built-in mechanisms are preferred and can be enabled |
| 2021 | * using {@link WebSettings#setBuiltInZoomControls}. |
The Android Open Source Project | 1059253 | 2009-03-18 17:39:46 -0700 | [diff] [blame] | 2022 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2023 | * @deprecated the built-in zoom mechanisms are preferred |
Steve Block | b838aef | 2012-04-23 18:22:15 +0100 | [diff] [blame] | 2024 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2025 | */ |
The Android Open Source Project | 1059253 | 2009-03-18 17:39:46 -0700 | [diff] [blame] | 2026 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2027 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2028 | public View getZoomControls() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2029 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2030 | return mProvider.getZoomControls(); |
Mangesh Ghiware | faab93d | 2011-09-21 13:58:47 -0700 | [diff] [blame] | 2031 | } |
| 2032 | |
| 2033 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2034 | * Gets whether this WebView can be zoomed in. |
| 2035 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2036 | * @return {@code true} if this WebView can be zoomed in |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 2037 | * |
| 2038 | * @deprecated This method is prone to inaccuracy due to race conditions |
| 2039 | * between the web rendering and UI threads; prefer |
| 2040 | * {@link WebViewClient#onScaleChanged}. |
Grace Kloba | 6164ef1 | 2010-06-01 15:59:13 -0700 | [diff] [blame] | 2041 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 2042 | @Deprecated |
Grace Kloba | 6164ef1 | 2010-06-01 15:59:13 -0700 | [diff] [blame] | 2043 | public boolean canZoomIn() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2044 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2045 | return mProvider.canZoomIn(); |
Grace Kloba | 6164ef1 | 2010-06-01 15:59:13 -0700 | [diff] [blame] | 2046 | } |
| 2047 | |
| 2048 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2049 | * Gets whether this WebView can be zoomed out. |
| 2050 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2051 | * @return {@code true} if this WebView can be zoomed out |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 2052 | * |
| 2053 | * @deprecated This method is prone to inaccuracy due to race conditions |
| 2054 | * between the web rendering and UI threads; prefer |
| 2055 | * {@link WebViewClient#onScaleChanged}. |
Grace Kloba | 6164ef1 | 2010-06-01 15:59:13 -0700 | [diff] [blame] | 2056 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 2057 | @Deprecated |
Grace Kloba | 6164ef1 | 2010-06-01 15:59:13 -0700 | [diff] [blame] | 2058 | public boolean canZoomOut() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2059 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2060 | return mProvider.canZoomOut(); |
Grace Kloba | 6164ef1 | 2010-06-01 15:59:13 -0700 | [diff] [blame] | 2061 | } |
| 2062 | |
| 2063 | /** |
Marcin Kosiba | 3ee06ef | 2014-07-15 17:59:51 +0100 | [diff] [blame] | 2064 | * Performs a zoom operation in this WebView. |
| 2065 | * |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 2066 | * @param zoomFactor the zoom factor to apply. The zoom factor will be clamped to the WebView's |
Marcin Kosiba | 3ee06ef | 2014-07-15 17:59:51 +0100 | [diff] [blame] | 2067 | * zoom limits. This value must be in the range 0.01 to 100.0 inclusive. |
Marcin Kosiba | 3ee06ef | 2014-07-15 17:59:51 +0100 | [diff] [blame] | 2068 | */ |
Martin Kosiba | 3a82acd | 2014-09-05 11:03:58 +0100 | [diff] [blame] | 2069 | public void zoomBy(float zoomFactor) { |
Marcin Kosiba | 3ee06ef | 2014-07-15 17:59:51 +0100 | [diff] [blame] | 2070 | checkThread(); |
| 2071 | if (zoomFactor < 0.01) |
| 2072 | throw new IllegalArgumentException("zoomFactor must be greater than 0.01."); |
| 2073 | if (zoomFactor > 100.0) |
| 2074 | throw new IllegalArgumentException("zoomFactor must be less than 100."); |
Martin Kosiba | 3a82acd | 2014-09-05 11:03:58 +0100 | [diff] [blame] | 2075 | mProvider.zoomBy(zoomFactor); |
Marcin Kosiba | 3ee06ef | 2014-07-15 17:59:51 +0100 | [diff] [blame] | 2076 | } |
| 2077 | |
| 2078 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2079 | * Performs zoom in in this WebView. |
| 2080 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2081 | * @return {@code true} if zoom in succeeds, {@code false} if no zoom changes |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2082 | */ |
| 2083 | public boolean zoomIn() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2084 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2085 | return mProvider.zoomIn(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2086 | } |
| 2087 | |
| 2088 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2089 | * Performs zoom out in this WebView. |
| 2090 | * |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2091 | * @return {@code true} if zoom out succeeds, {@code false} if no zoom changes |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2092 | */ |
| 2093 | public boolean zoomOut() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2094 | checkThread(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2095 | return mProvider.zoomOut(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2096 | } |
| 2097 | |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 2098 | /** |
| 2099 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 2100 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 2101 | */ |
| 2102 | @Deprecated |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2103 | @UnsupportedAppUsage |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2104 | public void debugDump() { |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2105 | checkThread(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2106 | } |
Cary Clark | d6982c9 | 2009-05-29 11:02:22 -0400 | [diff] [blame] | 2107 | |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 2108 | /** |
John Reck | f236115 | 2012-06-14 15:23:22 -0700 | [diff] [blame] | 2109 | * See {@link ViewDebug.HierarchyHandler#dumpViewHierarchyWithProperties(BufferedWriter, int)} |
John Reck | 926cf56 | 2012-06-14 10:00:31 -0700 | [diff] [blame] | 2110 | * @hide |
| 2111 | */ |
| 2112 | @Override |
| 2113 | public void dumpViewHierarchyWithProperties(BufferedWriter out, int level) { |
| 2114 | mProvider.dumpViewHierarchyWithProperties(out, level); |
| 2115 | } |
| 2116 | |
| 2117 | /** |
| 2118 | * See {@link ViewDebug.HierarchyHandler#findHierarchyView(String, int)} |
| 2119 | * @hide |
| 2120 | */ |
| 2121 | @Override |
| 2122 | public View findHierarchyView(String className, int hashCode) { |
| 2123 | return mProvider.findHierarchyView(className, hashCode); |
| 2124 | } |
| 2125 | |
Tobias Sargeant | d10e4af | 2017-01-19 14:03:09 +0000 | [diff] [blame] | 2126 | /** @hide */ |
Jeff Sharkey | ce8db99 | 2017-12-13 20:05:05 -0700 | [diff] [blame] | 2127 | @IntDef(prefix = { "RENDERER_PRIORITY_" }, value = { |
| 2128 | RENDERER_PRIORITY_WAIVED, |
| 2129 | RENDERER_PRIORITY_BOUND, |
| 2130 | RENDERER_PRIORITY_IMPORTANT |
Tobias Sargeant | d10e4af | 2017-01-19 14:03:09 +0000 | [diff] [blame] | 2131 | }) |
| 2132 | @Retention(RetentionPolicy.SOURCE) |
| 2133 | public @interface RendererPriority {} |
| 2134 | |
| 2135 | /** |
| 2136 | * The renderer associated with this WebView is bound with |
| 2137 | * {@link Context#BIND_WAIVE_PRIORITY}. At this priority level |
| 2138 | * {@link WebView} renderers will be strong targets for out of memory |
| 2139 | * killing. |
| 2140 | * |
| 2141 | * Use with {@link #setRendererPriorityPolicy}. |
| 2142 | */ |
| 2143 | public static final int RENDERER_PRIORITY_WAIVED = 0; |
| 2144 | /** |
| 2145 | * The renderer associated with this WebView is bound with |
| 2146 | * the default priority for services. |
| 2147 | * |
| 2148 | * Use with {@link #setRendererPriorityPolicy}. |
| 2149 | */ |
| 2150 | public static final int RENDERER_PRIORITY_BOUND = 1; |
| 2151 | /** |
| 2152 | * The renderer associated with this WebView is bound with |
| 2153 | * {@link Context#BIND_IMPORTANT}. |
| 2154 | * |
| 2155 | * Use with {@link #setRendererPriorityPolicy}. |
| 2156 | */ |
| 2157 | public static final int RENDERER_PRIORITY_IMPORTANT = 2; |
| 2158 | |
| 2159 | /** |
| 2160 | * Set the renderer priority policy for this {@link WebView}. The |
| 2161 | * priority policy will be used to determine whether an out of |
| 2162 | * process renderer should be considered to be a target for OOM |
| 2163 | * killing. |
| 2164 | * |
| 2165 | * Because a renderer can be associated with more than one |
| 2166 | * WebView, the final priority it is computed as the maximum of |
| 2167 | * any attached WebViews. When a WebView is destroyed it will |
| 2168 | * cease to be considerered when calculating the renderer |
| 2169 | * priority. Once no WebViews remain associated with the renderer, |
| 2170 | * the priority of the renderer will be reduced to |
| 2171 | * {@link #RENDERER_PRIORITY_WAIVED}. |
| 2172 | * |
| 2173 | * The default policy is to set the priority to |
| 2174 | * {@link #RENDERER_PRIORITY_IMPORTANT} regardless of visibility, |
| 2175 | * and this should not be changed unless the caller also handles |
| 2176 | * renderer crashes with |
| 2177 | * {@link WebViewClient#onRenderProcessGone}. Any other setting |
| 2178 | * will result in WebView renderers being killed by the system |
| 2179 | * more aggressively than the application. |
| 2180 | * |
| 2181 | * @param rendererRequestedPriority the minimum priority at which |
| 2182 | * this WebView desires the renderer process to be bound. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2183 | * @param waivedWhenNotVisible if {@code true}, this flag specifies that |
Tobias Sargeant | d10e4af | 2017-01-19 14:03:09 +0000 | [diff] [blame] | 2184 | * when this WebView is not visible, it will be treated as |
| 2185 | * if it had requested a priority of |
| 2186 | * {@link #RENDERER_PRIORITY_WAIVED}. |
| 2187 | */ |
| 2188 | public void setRendererPriorityPolicy( |
| 2189 | @RendererPriority int rendererRequestedPriority, |
| 2190 | boolean waivedWhenNotVisible) { |
| 2191 | mProvider.setRendererPriorityPolicy(rendererRequestedPriority, waivedWhenNotVisible); |
| 2192 | } |
| 2193 | |
| 2194 | /** |
| 2195 | * Get the requested renderer priority for this WebView. |
| 2196 | * |
| 2197 | * @return the requested renderer priority policy. |
| 2198 | */ |
| 2199 | @RendererPriority |
| 2200 | public int getRendererRequestedPriority() { |
| 2201 | return mProvider.getRendererRequestedPriority(); |
| 2202 | } |
| 2203 | |
| 2204 | /** |
| 2205 | * Return whether this WebView requests a priority of |
| 2206 | * {@link #RENDERER_PRIORITY_WAIVED} when not visible. |
| 2207 | * |
| 2208 | * @return whether this WebView requests a priority of |
| 2209 | * {@link #RENDERER_PRIORITY_WAIVED} when not visible. |
| 2210 | */ |
| 2211 | public boolean getRendererPriorityWaivedWhenNotVisible() { |
| 2212 | return mProvider.getRendererPriorityWaivedWhenNotVisible(); |
| 2213 | } |
Tima Vaisburd | cf49a23 | 2017-03-28 11:35:58 -0700 | [diff] [blame] | 2214 | |
| 2215 | /** |
| 2216 | * Sets the {@link TextClassifier} for this WebView. |
| 2217 | */ |
| 2218 | public void setTextClassifier(@Nullable TextClassifier textClassifier) { |
| 2219 | mProvider.setTextClassifier(textClassifier); |
| 2220 | } |
| 2221 | |
| 2222 | /** |
| 2223 | * Returns the {@link TextClassifier} used by this WebView. |
| 2224 | * If no TextClassifier has been set, this WebView uses the default set by the system. |
| 2225 | */ |
| 2226 | @NonNull |
| 2227 | public TextClassifier getTextClassifier() { |
| 2228 | return mProvider.getTextClassifier(); |
| 2229 | } |
| 2230 | |
Gustav Sennton | 265afdb | 2018-01-19 11:56:55 +0000 | [diff] [blame] | 2231 | /** |
| 2232 | * Returns the {@link ClassLoader} used to load internal WebView classes. |
| 2233 | * This method is meant for use by the WebView Support Library, there is no reason to use this |
| 2234 | * method otherwise. |
| 2235 | */ |
| 2236 | @NonNull |
| 2237 | public static ClassLoader getWebViewClassLoader() { |
| 2238 | return getFactory().getWebViewClassLoader(); |
| 2239 | } |
| 2240 | |
Gustav Sennton | 0167369 | 2018-01-19 12:11:25 +0000 | [diff] [blame] | 2241 | /** |
| 2242 | * Returns the {@link Looper} corresponding to the thread on which WebView calls must be made. |
| 2243 | */ |
| 2244 | @NonNull |
Gustav Sennton | 6abde8b | 2018-03-15 13:56:03 +0000 | [diff] [blame] | 2245 | public Looper getWebViewLooper() { |
| 2246 | return mWebViewThread; |
| 2247 | } |
| 2248 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2249 | //------------------------------------------------------------------------- |
| 2250 | // Interface for WebView providers |
| 2251 | //------------------------------------------------------------------------- |
| 2252 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2253 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2254 | * Gets the WebViewProvider. Used by providers to obtain the underlying |
Nate Fischer | ffb81c4 | 2016-09-26 12:35:47 -0700 | [diff] [blame] | 2255 | * implementation, e.g. when the application responds to |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 2256 | * WebViewClient.onCreateWindow() request. |
Mike Reed | efe2c72 | 2009-10-14 09:42:02 -0400 | [diff] [blame] | 2257 | * |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2258 | * @hide WebViewProvider is not public API. |
Mike Reed | efe2c72 | 2009-10-14 09:42:02 -0400 | [diff] [blame] | 2259 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 2260 | @SystemApi |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2261 | public WebViewProvider getWebViewProvider() { |
| 2262 | return mProvider; |
Mike Reed | efe2c72 | 2009-10-14 09:42:02 -0400 | [diff] [blame] | 2263 | } |
| 2264 | |
| 2265 | /** |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2266 | * Callback interface, allows the provider implementation to access non-public methods |
| 2267 | * and fields, and make super-class calls in this WebView instance. |
| 2268 | * @hide Only for use by WebViewProvider implementations |
Teng-Hui Zhu | 661e8b1 | 2011-03-02 15:09:34 -0800 | [diff] [blame] | 2269 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 2270 | @SystemApi |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2271 | public class PrivateAccess { |
| 2272 | // ---- Access to super-class methods ---- |
| 2273 | public int super_getScrollBarStyle() { |
| 2274 | return WebView.super.getScrollBarStyle(); |
| 2275 | } |
| 2276 | |
| 2277 | public void super_scrollTo(int scrollX, int scrollY) { |
| 2278 | WebView.super.scrollTo(scrollX, scrollY); |
| 2279 | } |
| 2280 | |
| 2281 | public void super_computeScroll() { |
| 2282 | WebView.super.computeScroll(); |
| 2283 | } |
| 2284 | |
alanv | eebebc9 | 2012-06-15 18:59:11 -0700 | [diff] [blame] | 2285 | public boolean super_onHoverEvent(MotionEvent event) { |
| 2286 | return WebView.super.onHoverEvent(event); |
| 2287 | } |
| 2288 | |
Marcin Kosiba | 3e853fb | 2015-01-08 12:45:40 +0000 | [diff] [blame] | 2289 | public boolean super_performAccessibilityAction(int action, Bundle arguments) { |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2290 | return WebView.super.performAccessibilityActionInternal(action, arguments); |
alanv | 448902d | 2012-05-16 20:27:47 -0700 | [diff] [blame] | 2291 | } |
| 2292 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2293 | public boolean super_performLongClick() { |
| 2294 | return WebView.super.performLongClick(); |
| 2295 | } |
| 2296 | |
| 2297 | public boolean super_setFrame(int left, int top, int right, int bottom) { |
| 2298 | return WebView.super.setFrame(left, top, right, bottom); |
| 2299 | } |
| 2300 | |
| 2301 | public boolean super_dispatchKeyEvent(KeyEvent event) { |
| 2302 | return WebView.super.dispatchKeyEvent(event); |
| 2303 | } |
| 2304 | |
| 2305 | public boolean super_onGenericMotionEvent(MotionEvent event) { |
| 2306 | return WebView.super.onGenericMotionEvent(event); |
| 2307 | } |
| 2308 | |
| 2309 | public boolean super_requestFocus(int direction, Rect previouslyFocusedRect) { |
| 2310 | return WebView.super.requestFocus(direction, previouslyFocusedRect); |
| 2311 | } |
| 2312 | |
| 2313 | public void super_setLayoutParams(ViewGroup.LayoutParams params) { |
| 2314 | WebView.super.setLayoutParams(params); |
| 2315 | } |
| 2316 | |
Hui Shu | f119c52 | 2015-10-08 10:07:13 -0700 | [diff] [blame] | 2317 | public void super_startActivityForResult(Intent intent, int requestCode) { |
| 2318 | WebView.super.startActivityForResult(intent, requestCode); |
| 2319 | } |
| 2320 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2321 | // ---- Access to non-public methods ---- |
| 2322 | public void overScrollBy(int deltaX, int deltaY, |
| 2323 | int scrollX, int scrollY, |
| 2324 | int scrollRangeX, int scrollRangeY, |
| 2325 | int maxOverScrollX, int maxOverScrollY, |
| 2326 | boolean isTouchEvent) { |
| 2327 | WebView.this.overScrollBy(deltaX, deltaY, scrollX, scrollY, scrollRangeX, scrollRangeY, |
| 2328 | maxOverScrollX, maxOverScrollY, isTouchEvent); |
| 2329 | } |
| 2330 | |
| 2331 | public void awakenScrollBars(int duration) { |
| 2332 | WebView.this.awakenScrollBars(duration); |
| 2333 | } |
| 2334 | |
| 2335 | public void awakenScrollBars(int duration, boolean invalidate) { |
| 2336 | WebView.this.awakenScrollBars(duration, invalidate); |
| 2337 | } |
| 2338 | |
| 2339 | public float getVerticalScrollFactor() { |
| 2340 | return WebView.this.getVerticalScrollFactor(); |
| 2341 | } |
| 2342 | |
| 2343 | public float getHorizontalScrollFactor() { |
| 2344 | return WebView.this.getHorizontalScrollFactor(); |
| 2345 | } |
| 2346 | |
| 2347 | public void setMeasuredDimension(int measuredWidth, int measuredHeight) { |
| 2348 | WebView.this.setMeasuredDimension(measuredWidth, measuredHeight); |
| 2349 | } |
| 2350 | |
| 2351 | public void onScrollChanged(int l, int t, int oldl, int oldt) { |
| 2352 | WebView.this.onScrollChanged(l, t, oldl, oldt); |
| 2353 | } |
| 2354 | |
| 2355 | public int getHorizontalScrollbarHeight() { |
| 2356 | return WebView.this.getHorizontalScrollbarHeight(); |
| 2357 | } |
| 2358 | |
Martin Kosiba | 9a68f82 | 2013-08-08 14:02:41 +0100 | [diff] [blame] | 2359 | public void super_onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, |
| 2360 | int l, int t, int r, int b) { |
| 2361 | WebView.super.onDrawVerticalScrollBar(canvas, scrollBar, l, t, r, b); |
| 2362 | } |
| 2363 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2364 | // ---- Access to (non-public) fields ---- |
| 2365 | /** Raw setter for the scroll X value, without invoking onScrollChanged handlers etc. */ |
| 2366 | public void setScrollXRaw(int scrollX) { |
| 2367 | WebView.this.mScrollX = scrollX; |
| 2368 | } |
| 2369 | |
| 2370 | /** Raw setter for the scroll Y value, without invoking onScrollChanged handlers etc. */ |
| 2371 | public void setScrollYRaw(int scrollY) { |
| 2372 | WebView.this.mScrollY = scrollY; |
| 2373 | } |
| 2374 | |
Teng-Hui Zhu | 661e8b1 | 2011-03-02 15:09:34 -0800 | [diff] [blame] | 2375 | } |
| 2376 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2377 | //------------------------------------------------------------------------- |
Ben Murdoch | 52c9f7f | 2013-01-18 00:50:37 +0000 | [diff] [blame] | 2378 | // Package-private internal stuff |
| 2379 | //------------------------------------------------------------------------- |
| 2380 | |
| 2381 | // Only used by android.webkit.FindActionModeCallback. |
| 2382 | void setFindDialogFindListener(FindListener listener) { |
| 2383 | checkThread(); |
| 2384 | setupFindListenerIfNeeded(); |
| 2385 | mFindListener.mFindDialogFindListener = listener; |
| 2386 | } |
| 2387 | |
| 2388 | // Only used by android.webkit.FindActionModeCallback. |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2389 | @UnsupportedAppUsage |
Ben Murdoch | 52c9f7f | 2013-01-18 00:50:37 +0000 | [diff] [blame] | 2390 | void notifyFindDialogDismissed() { |
| 2391 | checkThread(); |
| 2392 | mProvider.notifyFindDialogDismissed(); |
| 2393 | } |
| 2394 | |
| 2395 | //------------------------------------------------------------------------- |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2396 | // Private internal stuff |
| 2397 | //------------------------------------------------------------------------- |
| 2398 | |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2399 | @UnsupportedAppUsage |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2400 | private WebViewProvider mProvider; |
| 2401 | |
Ben Murdoch | 52c9f7f | 2013-01-18 00:50:37 +0000 | [diff] [blame] | 2402 | /** |
| 2403 | * In addition to the FindListener that the user may set via the WebView.setFindListener |
| 2404 | * API, FindActionModeCallback will register it's own FindListener. We keep them separate |
Mark Doliner | d0646dc | 2014-08-27 16:04:02 -0700 | [diff] [blame] | 2405 | * via this class so that the two FindListeners can potentially exist at once. |
Ben Murdoch | 52c9f7f | 2013-01-18 00:50:37 +0000 | [diff] [blame] | 2406 | */ |
| 2407 | private class FindListenerDistributor implements FindListener { |
| 2408 | private FindListener mFindDialogFindListener; |
| 2409 | private FindListener mUserFindListener; |
| 2410 | |
| 2411 | @Override |
| 2412 | public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, |
| 2413 | boolean isDoneCounting) { |
| 2414 | if (mFindDialogFindListener != null) { |
| 2415 | mFindDialogFindListener.onFindResultReceived(activeMatchOrdinal, numberOfMatches, |
| 2416 | isDoneCounting); |
| 2417 | } |
| 2418 | |
| 2419 | if (mUserFindListener != null) { |
| 2420 | mUserFindListener.onFindResultReceived(activeMatchOrdinal, numberOfMatches, |
| 2421 | isDoneCounting); |
| 2422 | } |
| 2423 | } |
| 2424 | } |
| 2425 | private FindListenerDistributor mFindListener; |
| 2426 | |
| 2427 | private void setupFindListenerIfNeeded() { |
| 2428 | if (mFindListener == null) { |
| 2429 | mFindListener = new FindListenerDistributor(); |
| 2430 | mProvider.setFindListener(mFindListener); |
| 2431 | } |
| 2432 | } |
| 2433 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2434 | private void ensureProviderCreated() { |
| 2435 | checkThread(); |
| 2436 | if (mProvider == null) { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2437 | // As this can get called during the base class constructor chain, pass the minimum |
| 2438 | // number of dependencies here; the rest are deferred to init(). |
| 2439 | mProvider = getFactory().createWebView(this, new PrivateAccess()); |
| 2440 | } |
Ben Murdoch | ecbc65c | 2010-01-13 10:54:56 +0000 | [diff] [blame] | 2441 | } |
| 2442 | |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2443 | @UnsupportedAppUsage |
Torne (Richard Coles) | 59375a0 | 2016-07-18 18:34:02 +0100 | [diff] [blame] | 2444 | private static WebViewFactoryProvider getFactory() { |
Jonathan Dixon | d3101b1 | 2012-04-12 20:51:51 +0100 | [diff] [blame] | 2445 | return WebViewFactory.getProvider(); |
Ben Murdoch | 1708ad5 | 2010-11-11 15:56:16 +0000 | [diff] [blame] | 2446 | } |
| 2447 | |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2448 | @UnsupportedAppUsage |
Jonathan Dixon | 517771b | 2013-10-08 13:32:11 -0700 | [diff] [blame] | 2449 | private final Looper mWebViewThread = Looper.myLooper(); |
| 2450 | |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2451 | @UnsupportedAppUsage |
Jonathan Dixon | 517771b | 2013-10-08 13:32:11 -0700 | [diff] [blame] | 2452 | private void checkThread() { |
| 2453 | // Ignore mWebViewThread == null because this can be called during in the super class |
| 2454 | // constructor, before this class's own constructor has even started. |
| 2455 | if (mWebViewThread != null && Looper.myLooper() != mWebViewThread) { |
Steve Block | 7a01d94 | 2011-09-26 12:30:31 +0100 | [diff] [blame] | 2456 | Throwable throwable = new Throwable( |
Jonathan Dixon | 517771b | 2013-10-08 13:32:11 -0700 | [diff] [blame] | 2457 | "A WebView method was called on thread '" + |
Steve Block | 08d584c | 2011-05-17 19:05:03 +0100 | [diff] [blame] | 2458 | Thread.currentThread().getName() + "'. " + |
Jonathan Dixon | 517771b | 2013-10-08 13:32:11 -0700 | [diff] [blame] | 2459 | "All WebView methods must be called on the same thread. " + |
| 2460 | "(Expected Looper " + mWebViewThread + " called on " + Looper.myLooper() + |
| 2461 | ", FYI main Looper is " + Looper.getMainLooper() + ")"); |
Steve Block | 7a01d94 | 2011-09-26 12:30:31 +0100 | [diff] [blame] | 2462 | Log.w(LOGTAG, Log.getStackTraceString(throwable)); |
| 2463 | StrictMode.onWebViewMethodCalledOnWrongThread(throwable); |
Kristian Monsen | b5cd8c0 | 2013-04-09 17:57:37 -0700 | [diff] [blame] | 2464 | |
| 2465 | if (sEnforceThreadChecking) { |
| 2466 | throw new RuntimeException(throwable); |
| 2467 | } |
Steve Block | 51b0891 | 2011-04-27 15:04:48 +0100 | [diff] [blame] | 2468 | } |
| 2469 | } |
| 2470 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2471 | //------------------------------------------------------------------------- |
| 2472 | // Override View methods |
| 2473 | //------------------------------------------------------------------------- |
| 2474 | |
| 2475 | // TODO: Add a test that enumerates all methods in ViewDelegte & ScrollDelegate, and ensures |
| 2476 | // there's a corresponding override (or better, caller) for each of them in here. |
| 2477 | |
| 2478 | @Override |
| 2479 | protected void onAttachedToWindow() { |
| 2480 | super.onAttachedToWindow(); |
| 2481 | mProvider.getViewDelegate().onAttachedToWindow(); |
Chris Craik | 555c55e | 2011-07-28 15:39:43 -0700 | [diff] [blame] | 2482 | } |
| 2483 | |
John Reck | 34dbce1 | 2014-03-06 12:52:24 -0800 | [diff] [blame] | 2484 | /** @hide */ |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2485 | @Override |
John Reck | 34dbce1 | 2014-03-06 12:52:24 -0800 | [diff] [blame] | 2486 | protected void onDetachedFromWindowInternal() { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2487 | mProvider.getViewDelegate().onDetachedFromWindow(); |
John Reck | 34dbce1 | 2014-03-06 12:52:24 -0800 | [diff] [blame] | 2488 | super.onDetachedFromWindowInternal(); |
Chris Craik | 555c55e | 2011-07-28 15:39:43 -0700 | [diff] [blame] | 2489 | } |
| 2490 | |
Tima Vaisburd | 5544f6c | 2017-04-27 10:53:27 -0700 | [diff] [blame] | 2491 | /** @hide */ |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2492 | @Override |
Tima Vaisburd | 134752b | 2017-04-06 15:50:05 -0700 | [diff] [blame] | 2493 | public void onMovedToDisplay(int displayId, Configuration config) { |
| 2494 | mProvider.getViewDelegate().onMovedToDisplay(displayId, config); |
| 2495 | } |
| 2496 | |
| 2497 | @Override |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2498 | public void setLayoutParams(ViewGroup.LayoutParams params) { |
| 2499 | mProvider.getViewDelegate().setLayoutParams(params); |
Chris Craik | 445ab74 | 2011-07-13 13:19:37 -0700 | [diff] [blame] | 2500 | } |
| 2501 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2502 | @Override |
| 2503 | public void setOverScrollMode(int mode) { |
| 2504 | super.setOverScrollMode(mode); |
Martin Kosiba | 5ee743e | 2012-12-21 12:39:50 +0000 | [diff] [blame] | 2505 | // This method may be called in the constructor chain, before the WebView provider is |
| 2506 | // created. |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2507 | ensureProviderCreated(); |
| 2508 | mProvider.getViewDelegate().setOverScrollMode(mode); |
Chris Craik | 445ab74 | 2011-07-13 13:19:37 -0700 | [diff] [blame] | 2509 | } |
| 2510 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2511 | @Override |
| 2512 | public void setScrollBarStyle(int style) { |
| 2513 | mProvider.getViewDelegate().setScrollBarStyle(style); |
| 2514 | super.setScrollBarStyle(style); |
George Mount | 3d09531 | 2012-01-10 11:24:02 -0800 | [diff] [blame] | 2515 | } |
| 2516 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2517 | @Override |
| 2518 | protected int computeHorizontalScrollRange() { |
| 2519 | return mProvider.getScrollDelegate().computeHorizontalScrollRange(); |
John Reck | 5528d7c | 2012-02-28 11:29:29 -0800 | [diff] [blame] | 2520 | } |
| 2521 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2522 | @Override |
| 2523 | protected int computeHorizontalScrollOffset() { |
| 2524 | return mProvider.getScrollDelegate().computeHorizontalScrollOffset(); |
| 2525 | } |
Grace Kloba | 8abd50b | 2010-07-08 15:02:14 -0700 | [diff] [blame] | 2526 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2527 | @Override |
| 2528 | protected int computeVerticalScrollRange() { |
| 2529 | return mProvider.getScrollDelegate().computeVerticalScrollRange(); |
| 2530 | } |
Patrick Scott | a3ebcc9 | 2010-07-16 11:52:22 -0400 | [diff] [blame] | 2531 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2532 | @Override |
| 2533 | protected int computeVerticalScrollOffset() { |
| 2534 | return mProvider.getScrollDelegate().computeVerticalScrollOffset(); |
| 2535 | } |
Ben Murdoch | fa148f6 | 2011-02-01 20:51:27 +0000 | [diff] [blame] | 2536 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2537 | @Override |
| 2538 | protected int computeVerticalScrollExtent() { |
| 2539 | return mProvider.getScrollDelegate().computeVerticalScrollExtent(); |
| 2540 | } |
| 2541 | |
| 2542 | @Override |
| 2543 | public void computeScroll() { |
| 2544 | mProvider.getScrollDelegate().computeScroll(); |
| 2545 | } |
| 2546 | |
| 2547 | @Override |
| 2548 | public boolean onHoverEvent(MotionEvent event) { |
| 2549 | return mProvider.getViewDelegate().onHoverEvent(event); |
| 2550 | } |
| 2551 | |
| 2552 | @Override |
| 2553 | public boolean onTouchEvent(MotionEvent event) { |
| 2554 | return mProvider.getViewDelegate().onTouchEvent(event); |
| 2555 | } |
| 2556 | |
| 2557 | @Override |
| 2558 | public boolean onGenericMotionEvent(MotionEvent event) { |
| 2559 | return mProvider.getViewDelegate().onGenericMotionEvent(event); |
| 2560 | } |
| 2561 | |
| 2562 | @Override |
| 2563 | public boolean onTrackballEvent(MotionEvent event) { |
| 2564 | return mProvider.getViewDelegate().onTrackballEvent(event); |
| 2565 | } |
| 2566 | |
| 2567 | @Override |
| 2568 | public boolean onKeyDown(int keyCode, KeyEvent event) { |
| 2569 | return mProvider.getViewDelegate().onKeyDown(keyCode, event); |
| 2570 | } |
| 2571 | |
| 2572 | @Override |
| 2573 | public boolean onKeyUp(int keyCode, KeyEvent event) { |
| 2574 | return mProvider.getViewDelegate().onKeyUp(keyCode, event); |
| 2575 | } |
| 2576 | |
| 2577 | @Override |
| 2578 | public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { |
| 2579 | return mProvider.getViewDelegate().onKeyMultiple(keyCode, repeatCount, event); |
| 2580 | } |
| 2581 | |
| 2582 | /* |
| 2583 | TODO: These are not currently implemented in WebViewClassic, but it seems inconsistent not |
| 2584 | to be delegating them too. |
| 2585 | |
| 2586 | @Override |
| 2587 | public boolean onKeyPreIme(int keyCode, KeyEvent event) { |
| 2588 | return mProvider.getViewDelegate().onKeyPreIme(keyCode, event); |
| 2589 | } |
| 2590 | @Override |
| 2591 | public boolean onKeyLongPress(int keyCode, KeyEvent event) { |
| 2592 | return mProvider.getViewDelegate().onKeyLongPress(keyCode, event); |
| 2593 | } |
| 2594 | @Override |
| 2595 | public boolean onKeyShortcut(int keyCode, KeyEvent event) { |
| 2596 | return mProvider.getViewDelegate().onKeyShortcut(keyCode, event); |
| 2597 | } |
| 2598 | */ |
| 2599 | |
Ben Murdoch | e3f9071 | 2013-06-05 14:19:48 +0100 | [diff] [blame] | 2600 | @Override |
| 2601 | public AccessibilityNodeProvider getAccessibilityNodeProvider() { |
| 2602 | AccessibilityNodeProvider provider = |
| 2603 | mProvider.getViewDelegate().getAccessibilityNodeProvider(); |
| 2604 | return provider == null ? super.getAccessibilityNodeProvider() : provider; |
| 2605 | } |
| 2606 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2607 | @Deprecated |
| 2608 | @Override |
| 2609 | public boolean shouldDelayChildPressedState() { |
| 2610 | return mProvider.getViewDelegate().shouldDelayChildPressedState(); |
| 2611 | } |
| 2612 | |
Felipe Leme | 1ca634a | 2016-11-28 17:21:21 -0800 | [diff] [blame] | 2613 | @Override |
Dianne Hackborn | a7bb6fb | 2015-02-03 18:13:40 -0800 | [diff] [blame] | 2614 | public CharSequence getAccessibilityClassName() { |
| 2615 | return WebView.class.getName(); |
| 2616 | } |
| 2617 | |
Selim Gurun | 1b650cb | 2015-04-06 20:13:37 -0700 | [diff] [blame] | 2618 | @Override |
Dianne Hackborn | 49b043f | 2015-05-07 14:21:38 -0700 | [diff] [blame] | 2619 | public void onProvideVirtualStructure(ViewStructure structure) { |
Selim Gurun | 50b26a5 | 2015-06-01 16:26:10 -0700 | [diff] [blame] | 2620 | mProvider.getViewDelegate().onProvideVirtualStructure(structure); |
Selim Gurun | 1b650cb | 2015-04-06 20:13:37 -0700 | [diff] [blame] | 2621 | } |
| 2622 | |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2623 | /** |
| 2624 | * {@inheritDoc} |
| 2625 | * |
| 2626 | * <p>The {@link ViewStructure} traditionally represents a {@link View}, while for web pages |
| 2627 | * it represent HTML nodes. Hence, it's necessary to "map" the HTML properties in a way that is |
| 2628 | * understood by the {@link android.service.autofill.AutofillService} implementations: |
| 2629 | * |
| 2630 | * <ol> |
Felipe Leme | 303b609 | 2017-07-31 18:01:15 -0700 | [diff] [blame] | 2631 | * <li>Only the HTML nodes inside a {@code FORM} are generated. |
| 2632 | * <li>The source of the HTML is set using {@link ViewStructure#setWebDomain(String)} in the |
| 2633 | * node representing the WebView. |
| 2634 | * <li>If a web page has multiple {@code FORM}s, only the data for the current form is |
| 2635 | * represented—if the user taps a field from another form, then the current autofill |
| 2636 | * context is canceled (by calling {@link android.view.autofill.AutofillManager#cancel()} and |
| 2637 | * a new context is created for that {@code FORM}. |
| 2638 | * <li>Similarly, if the page has {@code IFRAME} nodes, they are not initially represented in |
| 2639 | * the view structure until the user taps a field from a {@code FORM} inside the |
| 2640 | * {@code IFRAME}, in which case it would be treated the same way as multiple forms described |
| 2641 | * above, except that the {@link ViewStructure#setWebDomain(String) web domain} of the |
| 2642 | * {@code FORM} contains the {@code src} attribute from the {@code IFRAME} node. |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2643 | * <li>The W3C autofill field ({@code autocomplete} tag attribute) maps to |
Felipe Leme | 58390fe | 2017-09-15 15:16:28 -0700 | [diff] [blame] | 2644 | * {@link ViewStructure#setAutofillHints(String[])}. |
| 2645 | * <li>If the view is editable, the {@link ViewStructure#setAutofillType(int)} and |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2646 | * {@link ViewStructure#setAutofillValue(AutofillValue)} must be set. |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2647 | * <li>The {@code placeholder} attribute maps to {@link ViewStructure#setHint(CharSequence)}. |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2648 | * <li>Other HTML attributes can be represented through |
| 2649 | * {@link ViewStructure#setHtmlInfo(android.view.ViewStructure.HtmlInfo)}. |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2650 | * </ol> |
| 2651 | * |
Felipe Leme | 58390fe | 2017-09-15 15:16:28 -0700 | [diff] [blame] | 2652 | * <p>If the WebView implementation can determine that the value of a field was set statically |
| 2653 | * (for example, not through Javascript), it should also call |
| 2654 | * {@code structure.setDataIsSensitive(false)}. |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2655 | * |
Felipe Leme | 58390fe | 2017-09-15 15:16:28 -0700 | [diff] [blame] | 2656 | * <p>For example, an HTML form with 2 fields for username and password: |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2657 | * |
| 2658 | * <pre class="prettyprint"> |
Felipe Leme | f485f89 | 2017-11-22 08:15:59 -0800 | [diff] [blame] | 2659 | * <label>Username:</label> |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2660 | * <input type="text" name="username" id="user" value="Type your username" autocomplete="username" placeholder="Email or username"> |
Felipe Leme | f485f89 | 2017-11-22 08:15:59 -0800 | [diff] [blame] | 2661 | * <label>Password:</label> |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2662 | * <input type="password" name="password" id="pass" autocomplete="current-password" placeholder="Password"> |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2663 | * </pre> |
| 2664 | * |
| 2665 | * <p>Would map to: |
| 2666 | * |
| 2667 | * <pre class="prettyprint"> |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2668 | * int index = structure.addChildCount(2); |
| 2669 | * ViewStructure username = structure.newChild(index); |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2670 | * username.setAutofillId(structure.getAutofillId(), 1); // id 1 - first child |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2671 | * username.setAutofillHints("username"); |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2672 | * username.setHtmlInfo(username.newHtmlInfoBuilder("input") |
| 2673 | * .addAttribute("type", "text") |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2674 | * .addAttribute("name", "username") |
Felipe Leme | f485f89 | 2017-11-22 08:15:59 -0800 | [diff] [blame] | 2675 | * .addAttribute("label", "Username:") |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2676 | * .build()); |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2677 | * username.setHint("Email or username"); |
| 2678 | * username.setAutofillType(View.AUTOFILL_TYPE_TEXT); |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2679 | * username.setAutofillValue(AutofillValue.forText("Type your username")); |
Felipe Leme | 58390fe | 2017-09-15 15:16:28 -0700 | [diff] [blame] | 2680 | * // Value of the field is not sensitive because it was created statically and not changed. |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2681 | * username.setDataIsSensitive(false); |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2682 | * |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2683 | * ViewStructure password = structure.newChild(index + 1); |
| 2684 | * username.setAutofillId(structure, 2); // id 2 - second child |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2685 | * password.setAutofillHints("current-password"); |
Felipe Leme | 6dcec87 | 2017-05-25 11:24:23 -0700 | [diff] [blame] | 2686 | * password.setHtmlInfo(password.newHtmlInfoBuilder("input") |
| 2687 | * .addAttribute("type", "password") |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2688 | * .addAttribute("name", "password") |
Felipe Leme | f485f89 | 2017-11-22 08:15:59 -0800 | [diff] [blame] | 2689 | * .addAttribute("label", "Password:") |
Felipe Leme | 25bf787 | 2017-03-28 15:32:29 -0700 | [diff] [blame] | 2690 | * .build()); |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2691 | * password.setHint("Password"); |
| 2692 | * password.setAutofillType(View.AUTOFILL_TYPE_TEXT); |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2693 | * </pre> |
Felipe Leme | 1a1e468 | 2017-03-13 16:34:03 -0700 | [diff] [blame] | 2694 | */ |
Felipe Leme | 1ca634a | 2016-11-28 17:21:21 -0800 | [diff] [blame] | 2695 | @Override |
Felipe Leme | 640f30a | 2017-03-06 15:44:06 -0800 | [diff] [blame] | 2696 | public void onProvideAutofillVirtualStructure(ViewStructure structure, int flags) { |
| 2697 | mProvider.getViewDelegate().onProvideAutofillVirtualStructure(structure, flags); |
Felipe Leme | 1ca634a | 2016-11-28 17:21:21 -0800 | [diff] [blame] | 2698 | } |
| 2699 | |
Tao Bai | a571733 | 2017-03-30 14:58:53 -0700 | [diff] [blame] | 2700 | @Override |
| 2701 | public void autofill(SparseArray<AutofillValue>values) { |
| 2702 | mProvider.getViewDelegate().autofill(values); |
| 2703 | } |
| 2704 | |
Felipe Leme | ef33526 | 2018-03-07 11:49:44 -0800 | [diff] [blame] | 2705 | @Override |
| 2706 | public boolean isVisibleToUserForAutofill(int virtualId) { |
| 2707 | return mProvider.getViewDelegate().isVisibleToUserForAutofill(virtualId); |
| 2708 | } |
| 2709 | |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2710 | /** @hide */ |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2711 | @Override |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2712 | public void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) { |
| 2713 | super.onInitializeAccessibilityNodeInfoInternal(info); |
Marcin Kosiba | 3e853fb | 2015-01-08 12:45:40 +0000 | [diff] [blame] | 2714 | mProvider.getViewDelegate().onInitializeAccessibilityNodeInfo(info); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2715 | } |
| 2716 | |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2717 | /** @hide */ |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2718 | @Override |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2719 | public void onInitializeAccessibilityEventInternal(AccessibilityEvent event) { |
| 2720 | super.onInitializeAccessibilityEventInternal(event); |
Marcin Kosiba | 3e853fb | 2015-01-08 12:45:40 +0000 | [diff] [blame] | 2721 | mProvider.getViewDelegate().onInitializeAccessibilityEvent(event); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2722 | } |
| 2723 | |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2724 | /** @hide */ |
alanv | 448902d | 2012-05-16 20:27:47 -0700 | [diff] [blame] | 2725 | @Override |
Alan Viverette | a54956a | 2015-01-07 16:05:02 -0800 | [diff] [blame] | 2726 | public boolean performAccessibilityActionInternal(int action, Bundle arguments) { |
Marcin Kosiba | 3e853fb | 2015-01-08 12:45:40 +0000 | [diff] [blame] | 2727 | return mProvider.getViewDelegate().performAccessibilityAction(action, arguments); |
alanv | 448902d | 2012-05-16 20:27:47 -0700 | [diff] [blame] | 2728 | } |
| 2729 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2730 | /** @hide */ |
| 2731 | @Override |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2732 | @UnsupportedAppUsage |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2733 | protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, |
| 2734 | int l, int t, int r, int b) { |
| 2735 | mProvider.getViewDelegate().onDrawVerticalScrollBar(canvas, scrollBar, l, t, r, b); |
| 2736 | } |
| 2737 | |
| 2738 | @Override |
| 2739 | protected void onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY) { |
| 2740 | mProvider.getViewDelegate().onOverScrolled(scrollX, scrollY, clampedX, clampedY); |
| 2741 | } |
| 2742 | |
| 2743 | @Override |
| 2744 | protected void onWindowVisibilityChanged(int visibility) { |
| 2745 | super.onWindowVisibilityChanged(visibility); |
| 2746 | mProvider.getViewDelegate().onWindowVisibilityChanged(visibility); |
| 2747 | } |
| 2748 | |
| 2749 | @Override |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2750 | protected void onDraw(Canvas canvas) { |
| 2751 | mProvider.getViewDelegate().onDraw(canvas); |
| 2752 | } |
| 2753 | |
| 2754 | @Override |
| 2755 | public boolean performLongClick() { |
| 2756 | return mProvider.getViewDelegate().performLongClick(); |
| 2757 | } |
| 2758 | |
| 2759 | @Override |
| 2760 | protected void onConfigurationChanged(Configuration newConfig) { |
| 2761 | mProvider.getViewDelegate().onConfigurationChanged(newConfig); |
| 2762 | } |
| 2763 | |
Selim Gurun | c92080b | 2016-10-20 11:53:14 -0700 | [diff] [blame] | 2764 | /** |
| 2765 | * Creates a new InputConnection for an InputMethod to interact with the WebView. |
| 2766 | * This is similar to {@link View#onCreateInputConnection} but note that WebView |
| 2767 | * calls InputConnection methods on a thread other than the UI thread. |
| 2768 | * If these methods are overridden, then the overriding methods should respect |
| 2769 | * thread restrictions when calling View methods or accessing data. |
| 2770 | */ |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2771 | @Override |
| 2772 | public InputConnection onCreateInputConnection(EditorInfo outAttrs) { |
| 2773 | return mProvider.getViewDelegate().onCreateInputConnection(outAttrs); |
| 2774 | } |
| 2775 | |
| 2776 | @Override |
Hui Shu | ecdce96 | 2016-02-04 15:00:19 -0800 | [diff] [blame] | 2777 | public boolean onDragEvent(DragEvent event) { |
| 2778 | return mProvider.getViewDelegate().onDragEvent(event); |
| 2779 | } |
| 2780 | |
| 2781 | @Override |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2782 | protected void onVisibilityChanged(View changedView, int visibility) { |
| 2783 | super.onVisibilityChanged(changedView, visibility); |
Martin Kosiba | 5ee743e | 2012-12-21 12:39:50 +0000 | [diff] [blame] | 2784 | // This method may be called in the constructor chain, before the WebView provider is |
| 2785 | // created. |
| 2786 | ensureProviderCreated(); |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2787 | mProvider.getViewDelegate().onVisibilityChanged(changedView, visibility); |
| 2788 | } |
| 2789 | |
| 2790 | @Override |
| 2791 | public void onWindowFocusChanged(boolean hasWindowFocus) { |
| 2792 | mProvider.getViewDelegate().onWindowFocusChanged(hasWindowFocus); |
| 2793 | super.onWindowFocusChanged(hasWindowFocus); |
| 2794 | } |
| 2795 | |
| 2796 | @Override |
| 2797 | protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) { |
| 2798 | mProvider.getViewDelegate().onFocusChanged(focused, direction, previouslyFocusedRect); |
| 2799 | super.onFocusChanged(focused, direction, previouslyFocusedRect); |
| 2800 | } |
| 2801 | |
| 2802 | /** @hide */ |
| 2803 | @Override |
Mathew Inwood | 42afea2 | 2018-08-16 19:18:28 +0100 | [diff] [blame] | 2804 | @UnsupportedAppUsage |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2805 | protected boolean setFrame(int left, int top, int right, int bottom) { |
| 2806 | return mProvider.getViewDelegate().setFrame(left, top, right, bottom); |
| 2807 | } |
| 2808 | |
| 2809 | @Override |
| 2810 | protected void onSizeChanged(int w, int h, int ow, int oh) { |
| 2811 | super.onSizeChanged(w, h, ow, oh); |
| 2812 | mProvider.getViewDelegate().onSizeChanged(w, h, ow, oh); |
| 2813 | } |
| 2814 | |
| 2815 | @Override |
| 2816 | protected void onScrollChanged(int l, int t, int oldl, int oldt) { |
| 2817 | super.onScrollChanged(l, t, oldl, oldt); |
| 2818 | mProvider.getViewDelegate().onScrollChanged(l, t, oldl, oldt); |
| 2819 | } |
| 2820 | |
| 2821 | @Override |
| 2822 | public boolean dispatchKeyEvent(KeyEvent event) { |
| 2823 | return mProvider.getViewDelegate().dispatchKeyEvent(event); |
| 2824 | } |
| 2825 | |
| 2826 | @Override |
| 2827 | public boolean requestFocus(int direction, Rect previouslyFocusedRect) { |
| 2828 | return mProvider.getViewDelegate().requestFocus(direction, previouslyFocusedRect); |
| 2829 | } |
| 2830 | |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 2831 | @Override |
| 2832 | protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { |
| 2833 | super.onMeasure(widthMeasureSpec, heightMeasureSpec); |
| 2834 | mProvider.getViewDelegate().onMeasure(widthMeasureSpec, heightMeasureSpec); |
| 2835 | } |
| 2836 | |
| 2837 | @Override |
| 2838 | public boolean requestChildRectangleOnScreen(View child, Rect rect, boolean immediate) { |
| 2839 | return mProvider.getViewDelegate().requestChildRectangleOnScreen(child, rect, immediate); |
| 2840 | } |
| 2841 | |
| 2842 | @Override |
| 2843 | public void setBackgroundColor(int color) { |
| 2844 | mProvider.getViewDelegate().setBackgroundColor(color); |
| 2845 | } |
John Reck | a5408e6 | 2012-03-16 14:18:44 -0700 | [diff] [blame] | 2846 | |
| 2847 | @Override |
| 2848 | public void setLayerType(int layerType, Paint paint) { |
| 2849 | super.setLayerType(layerType, paint); |
| 2850 | mProvider.getViewDelegate().setLayerType(layerType, paint); |
| 2851 | } |
Ben Murdoch | e623e24 | 2012-09-07 20:47:07 +0100 | [diff] [blame] | 2852 | |
| 2853 | @Override |
| 2854 | protected void dispatchDraw(Canvas canvas) { |
| 2855 | mProvider.getViewDelegate().preDispatchDraw(canvas); |
| 2856 | super.dispatchDraw(canvas); |
| 2857 | } |
Ben Murdoch | 7302f4f | 2014-07-03 14:47:44 +0100 | [diff] [blame] | 2858 | |
| 2859 | @Override |
| 2860 | public void onStartTemporaryDetach() { |
| 2861 | super.onStartTemporaryDetach(); |
| 2862 | mProvider.getViewDelegate().onStartTemporaryDetach(); |
| 2863 | } |
| 2864 | |
| 2865 | @Override |
| 2866 | public void onFinishTemporaryDetach() { |
| 2867 | super.onFinishTemporaryDetach(); |
| 2868 | mProvider.getViewDelegate().onFinishTemporaryDetach(); |
| 2869 | } |
Siva Velusamy | 94a6d15 | 2015-05-05 15:07:00 -0700 | [diff] [blame] | 2870 | |
Selim Gurun | e319dad | 2016-03-17 01:40:40 +0000 | [diff] [blame] | 2871 | @Override |
| 2872 | public Handler getHandler() { |
| 2873 | return mProvider.getViewDelegate().getHandler(super.getHandler()); |
| 2874 | } |
| 2875 | |
| 2876 | @Override |
| 2877 | public View findFocus() { |
| 2878 | return mProvider.getViewDelegate().findFocus(super.findFocus()); |
| 2879 | } |
| 2880 | |
Hui Shu | f119c52 | 2015-10-08 10:07:13 -0700 | [diff] [blame] | 2881 | /** |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 2882 | * If WebView has already been loaded into the current process this method will return the |
| 2883 | * package that was used to load it. Otherwise, the package that would be used if the WebView |
| 2884 | * was loaded right now will be returned; this does not cause WebView to be loaded, so this |
| 2885 | * information may become outdated at any time. |
Gustav Sennton | 4cbfe71 | 2017-03-07 14:22:01 +0000 | [diff] [blame] | 2886 | * The WebView package changes either when the current WebView package is updated, disabled, or |
| 2887 | * uninstalled. It can also be changed through a Developer Setting. |
| 2888 | * If the WebView package changes, any app process that has loaded WebView will be killed. The |
| 2889 | * next time the app starts and loads WebView it will use the new WebView package instead. |
Nate Fischer | 0a6140d | 2017-09-05 12:37:49 -0700 | [diff] [blame] | 2890 | * @return the current WebView package, or {@code null} if there is none. |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 2891 | */ |
Nate Fischer | 3442c74 | 2017-09-08 17:02:00 -0700 | [diff] [blame] | 2892 | @Nullable |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 2893 | public static PackageInfo getCurrentWebViewPackage() { |
| 2894 | PackageInfo webviewPackage = WebViewFactory.getLoadedPackageInfo(); |
| 2895 | if (webviewPackage != null) { |
| 2896 | return webviewPackage; |
| 2897 | } |
| 2898 | |
Torne (Richard Coles) | ff937ac | 2017-10-02 17:09:32 -0400 | [diff] [blame] | 2899 | IWebViewUpdateService service = WebViewFactory.getUpdateService(); |
| 2900 | if (service == null) { |
| 2901 | return null; |
| 2902 | } |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 2903 | try { |
Torne (Richard Coles) | ff937ac | 2017-10-02 17:09:32 -0400 | [diff] [blame] | 2904 | return service.getCurrentWebViewPackage(); |
Gustav Sennton | bf683e0 | 2016-09-15 14:42:50 +0100 | [diff] [blame] | 2905 | } catch (RemoteException e) { |
| 2906 | throw e.rethrowFromSystemServer(); |
| 2907 | } |
| 2908 | } |
| 2909 | |
| 2910 | /** |
Hui Shu | f119c52 | 2015-10-08 10:07:13 -0700 | [diff] [blame] | 2911 | * Receive the result from a previous call to {@link #startActivityForResult(Intent, int)}. |
| 2912 | * |
| 2913 | * @param requestCode The integer request code originally supplied to |
| 2914 | * startActivityForResult(), allowing you to identify who this |
| 2915 | * result came from. |
| 2916 | * @param resultCode The integer result code returned by the child activity |
| 2917 | * through its setResult(). |
| 2918 | * @param data An Intent, which can return result data to the caller |
| 2919 | * (various data can be attached to Intent "extras"). |
| 2920 | * @hide |
| 2921 | */ |
| 2922 | @Override |
| 2923 | public void onActivityResult(int requestCode, int resultCode, Intent data) { |
| 2924 | mProvider.getViewDelegate().onActivityResult(requestCode, resultCode, data); |
| 2925 | } |
| 2926 | |
Changwan Ryu | 15e9afc | 2018-03-06 15:55:19 -0800 | [diff] [blame] | 2927 | @Override |
| 2928 | public boolean onCheckIsTextEditor() { |
| 2929 | return mProvider.getViewDelegate().onCheckIsTextEditor(); |
| 2930 | } |
| 2931 | |
Siva Velusamy | 94a6d15 | 2015-05-05 15:07:00 -0700 | [diff] [blame] | 2932 | /** @hide */ |
| 2933 | @Override |
| 2934 | protected void encodeProperties(@NonNull ViewHierarchyEncoder encoder) { |
| 2935 | super.encodeProperties(encoder); |
| 2936 | |
| 2937 | checkThread(); |
| 2938 | encoder.addProperty("webview:contentHeight", mProvider.getContentHeight()); |
| 2939 | encoder.addProperty("webview:contentWidth", mProvider.getContentWidth()); |
| 2940 | encoder.addProperty("webview:scale", mProvider.getScale()); |
| 2941 | encoder.addProperty("webview:title", mProvider.getTitle()); |
| 2942 | encoder.addProperty("webview:url", mProvider.getUrl()); |
| 2943 | encoder.addProperty("webview:originalUrl", mProvider.getOriginalUrl()); |
| 2944 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 2945 | } |