WebView.java revision e0a7b08d369e323f524251a44251c902122a6414
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 17package android.webkit; 18 19import android.annotation.Widget; 20import android.content.Context; 21import android.content.res.Configuration; 22import android.graphics.Bitmap; 23import android.graphics.Canvas; 24import android.graphics.Paint; 25import android.graphics.Picture; 26import android.graphics.Rect; 27import android.graphics.drawable.Drawable; 28import android.net.http.SslCertificate; 29import android.os.Build; 30import android.os.Bundle; 31import android.os.Looper; 32import android.os.Message; 33import android.os.StrictMode; 34import android.print.PrintDocumentAdapter; 35import android.util.AttributeSet; 36import android.util.Log; 37import android.view.KeyEvent; 38import android.view.MotionEvent; 39import android.view.View; 40import android.view.ViewDebug; 41import android.view.ViewGroup; 42import android.view.ViewTreeObserver; 43import android.view.accessibility.AccessibilityEvent; 44import android.view.accessibility.AccessibilityNodeInfo; 45import android.view.accessibility.AccessibilityNodeProvider; 46import android.view.inputmethod.EditorInfo; 47import android.view.inputmethod.InputConnection; 48import android.widget.AbsoluteLayout; 49 50import java.io.BufferedWriter; 51import java.io.File; 52import java.util.Map; 53 54/** 55 * <p>A View that displays web pages. This class is the basis upon which you 56 * can roll your own web browser or simply display some online content within your Activity. 57 * It uses the WebKit rendering engine to display 58 * web pages and includes methods to navigate forward and backward 59 * through a history, zoom in and out, perform text searches and more.</p> 60 * <p>Note that, in order for your Activity to access the Internet and load web pages 61 * in a WebView, you must add the {@code INTERNET} permissions to your 62 * Android Manifest file:</p> 63 * <pre><uses-permission android:name="android.permission.INTERNET" /></pre> 64 * 65 * <p>This must be a child of the <a 66 * href="{@docRoot}guide/topics/manifest/manifest-element.html">{@code <manifest>}</a> 67 * element.</p> 68 * 69 * <p>For more information, read 70 * <a href="{@docRoot}guide/webapps/webview.html">Building Web Apps in WebView</a>.</p> 71 * 72 * <h3>Basic usage</h3> 73 * 74 * <p>By default, a WebView provides no browser-like widgets, does not 75 * enable JavaScript and web page errors are ignored. If your goal is only 76 * to display some HTML as a part of your UI, this is probably fine; 77 * the user won't need to interact with the web page beyond reading 78 * it, and the web page won't need to interact with the user. If you 79 * actually want a full-blown web browser, then you probably want to 80 * invoke the Browser application with a URL Intent rather than show it 81 * with a WebView. For example: 82 * <pre> 83 * Uri uri = Uri.parse("http://www.example.com"); 84 * Intent intent = new Intent(Intent.ACTION_VIEW, uri); 85 * startActivity(intent); 86 * </pre> 87 * <p>See {@link android.content.Intent} for more information.</p> 88 * 89 * <p>To provide a WebView in your own Activity, include a {@code <WebView>} in your layout, 90 * or set the entire Activity window as a WebView during {@link 91 * android.app.Activity#onCreate(Bundle) onCreate()}:</p> 92 * <pre class="prettyprint"> 93 * WebView webview = new WebView(this); 94 * setContentView(webview); 95 * </pre> 96 * 97 * <p>Then load the desired web page:</p> 98 * <pre> 99 * // Simplest usage: note that an exception will NOT be thrown 100 * // if there is an error loading this page (see below). 101 * webview.loadUrl("http://slashdot.org/"); 102 * 103 * // OR, you can also load from an HTML string: 104 * String summary = "<html><body>You scored <b>192</b> points.</body></html>"; 105 * webview.loadData(summary, "text/html", null); 106 * // ... although note that there are restrictions on what this HTML can do. 107 * // See the JavaDocs for {@link #loadData(String,String,String) loadData()} and {@link 108 * #loadDataWithBaseURL(String,String,String,String,String) loadDataWithBaseURL()} for more info. 109 * </pre> 110 * 111 * <p>A WebView has several customization points where you can add your 112 * own behavior. These are:</p> 113 * 114 * <ul> 115 * <li>Creating and setting a {@link android.webkit.WebChromeClient} subclass. 116 * This class is called when something that might impact a 117 * browser UI happens, for instance, progress updates and 118 * JavaScript alerts are sent here (see <a 119 * href="{@docRoot}guide/developing/debug-tasks.html#DebuggingWebPages">Debugging Tasks</a>). 120 * </li> 121 * <li>Creating and setting a {@link android.webkit.WebViewClient} subclass. 122 * It will be called when things happen that impact the 123 * rendering of the content, eg, errors or form submissions. You 124 * can also intercept URL loading here (via {@link 125 * android.webkit.WebViewClient#shouldOverrideUrlLoading(WebView,String) 126 * shouldOverrideUrlLoading()}).</li> 127 * <li>Modifying the {@link android.webkit.WebSettings}, such as 128 * enabling JavaScript with {@link android.webkit.WebSettings#setJavaScriptEnabled(boolean) 129 * setJavaScriptEnabled()}. </li> 130 * <li>Injecting Java objects into the WebView using the 131 * {@link android.webkit.WebView#addJavascriptInterface} method. This 132 * method allows you to inject Java objects into a page's JavaScript 133 * context, so that they can be accessed by JavaScript in the page.</li> 134 * </ul> 135 * 136 * <p>Here's a more complicated example, showing error handling, 137 * settings, and progress notification:</p> 138 * 139 * <pre class="prettyprint"> 140 * // Let's display the progress in the activity title bar, like the 141 * // browser app does. 142 * getWindow().requestFeature(Window.FEATURE_PROGRESS); 143 * 144 * webview.getSettings().setJavaScriptEnabled(true); 145 * 146 * final Activity activity = this; 147 * webview.setWebChromeClient(new WebChromeClient() { 148 * public void onProgressChanged(WebView view, int progress) { 149 * // Activities and WebViews measure progress with different scales. 150 * // The progress meter will automatically disappear when we reach 100% 151 * activity.setProgress(progress * 1000); 152 * } 153 * }); 154 * webview.setWebViewClient(new WebViewClient() { 155 * public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) { 156 * Toast.makeText(activity, "Oh no! " + description, Toast.LENGTH_SHORT).show(); 157 * } 158 * }); 159 * 160 * webview.loadUrl("http://developer.android.com/"); 161 * </pre> 162 * 163 * <h3>Zoom</h3> 164 * 165 * <p>To enable the built-in zoom, set 166 * {@link #getSettings() WebSettings}.{@link WebSettings#setBuiltInZoomControls(boolean)} 167 * (introduced in API level {@link android.os.Build.VERSION_CODES#CUPCAKE}).</p> 168 * <p>NOTE: Using zoom if either the height or width is set to 169 * {@link android.view.ViewGroup.LayoutParams#WRAP_CONTENT} may lead to undefined behavior 170 * and should be avoided.</p> 171 * 172 * <h3>Cookie and window management</h3> 173 * 174 * <p>For obvious security reasons, your application has its own 175 * cache, cookie store etc.—it does not share the Browser 176 * application's data. 177 * </p> 178 * 179 * <p>By default, requests by the HTML to open new windows are 180 * ignored. This is true whether they be opened by JavaScript or by 181 * the target attribute on a link. You can customize your 182 * {@link WebChromeClient} to provide your own behaviour for opening multiple windows, 183 * and render them in whatever manner you want.</p> 184 * 185 * <p>The standard behavior for an Activity is to be destroyed and 186 * recreated when the device orientation or any other configuration changes. This will cause 187 * the WebView to reload the current page. If you don't want that, you 188 * can set your Activity to handle the {@code orientation} and {@code keyboardHidden} 189 * changes, and then just leave the WebView alone. It'll automatically 190 * re-orient itself as appropriate. Read <a 191 * href="{@docRoot}guide/topics/resources/runtime-changes.html">Handling Runtime Changes</a> for 192 * more information about how to handle configuration changes during runtime.</p> 193 * 194 * 195 * <h3>Building web pages to support different screen densities</h3> 196 * 197 * <p>The screen density of a device is based on the screen resolution. A screen with low density 198 * has fewer available pixels per inch, where a screen with high density 199 * has more — sometimes significantly more — pixels per inch. The density of a 200 * screen is important because, other things being equal, a UI element (such as a button) whose 201 * height and width are defined in terms of screen pixels will appear larger on the lower density 202 * screen and smaller on the higher density screen. 203 * For simplicity, Android collapses all actual screen densities into three generalized densities: 204 * high, medium, and low.</p> 205 * <p>By default, WebView scales a web page so that it is drawn at a size that matches the default 206 * appearance on a medium density screen. So, it applies 1.5x scaling on a high density screen 207 * (because its pixels are smaller) and 0.75x scaling on a low density screen (because its pixels 208 * are bigger). 209 * Starting with API level {@link android.os.Build.VERSION_CODES#ECLAIR}, WebView supports DOM, CSS, 210 * and meta tag features to help you (as a web developer) target screens with different screen 211 * densities.</p> 212 * <p>Here's a summary of the features you can use to handle different screen densities:</p> 213 * <ul> 214 * <li>The {@code window.devicePixelRatio} DOM property. The value of this property specifies the 215 * default scaling factor used for the current device. For example, if the value of {@code 216 * window.devicePixelRatio} is "1.0", then the device is considered a medium density (mdpi) device 217 * and default scaling is not applied to the web page; if the value is "1.5", then the device is 218 * considered a high density device (hdpi) and the page content is scaled 1.5x; if the 219 * value is "0.75", then the device is considered a low density device (ldpi) and the content is 220 * scaled 0.75x.</li> 221 * <li>The {@code -webkit-device-pixel-ratio} CSS media query. Use this to specify the screen 222 * densities for which this style sheet is to be used. The corresponding value should be either 223 * "0.75", "1", or "1.5", to indicate that the styles are for devices with low density, medium 224 * density, or high density screens, respectively. For example: 225 * <pre> 226 * <link rel="stylesheet" media="screen and (-webkit-device-pixel-ratio:1.5)" href="hdpi.css" /></pre> 227 * <p>The {@code hdpi.css} stylesheet is only used for devices with a screen pixel ration of 1.5, 228 * which is the high density pixel ratio.</p> 229 * </li> 230 * </ul> 231 * 232 * <h3>HTML5 Video support</h3> 233 * 234 * <p>In order to support inline HTML5 video in your application, you need to have hardware 235 * acceleration turned on, and set a {@link android.webkit.WebChromeClient}. For full screen support, 236 * implementations of {@link WebChromeClient#onShowCustomView(View, WebChromeClient.CustomViewCallback)} 237 * and {@link WebChromeClient#onHideCustomView()} are required, 238 * {@link WebChromeClient#getVideoLoadingProgressView()} is optional. 239 * </p> 240 */ 241// Implementation notes. 242// The WebView is a thin API class that delegates its public API to a backend WebViewProvider 243// class instance. WebView extends {@link AbsoluteLayout} for backward compatibility reasons. 244// Methods are delegated to the provider implementation: all public API methods introduced in this 245// file are fully delegated, whereas public and protected methods from the View base classes are 246// only delegated where a specific need exists for them to do so. 247@Widget 248public class WebView extends AbsoluteLayout 249 implements ViewTreeObserver.OnGlobalFocusChangeListener, 250 ViewGroup.OnHierarchyChangeListener, ViewDebug.HierarchyHandler { 251 252 private static final String LOGTAG = "WebView"; 253 254 // Throwing an exception for incorrect thread usage if the 255 // build target is JB MR2 or newer. Defaults to false, and is 256 // set in the WebView constructor. 257 private static volatile boolean sEnforceThreadChecking = false; 258 259 /** 260 * Transportation object for returning WebView across thread boundaries. 261 */ 262 public class WebViewTransport { 263 private WebView mWebview; 264 265 /** 266 * Sets the WebView to the transportation object. 267 * 268 * @param webview the WebView to transport 269 */ 270 public synchronized void setWebView(WebView webview) { 271 mWebview = webview; 272 } 273 274 /** 275 * Gets the WebView object. 276 * 277 * @return the transported WebView object 278 */ 279 public synchronized WebView getWebView() { 280 return mWebview; 281 } 282 } 283 284 /** 285 * URI scheme for telephone number. 286 */ 287 public static final String SCHEME_TEL = "tel:"; 288 /** 289 * URI scheme for email address. 290 */ 291 public static final String SCHEME_MAILTO = "mailto:"; 292 /** 293 * URI scheme for map address. 294 */ 295 public static final String SCHEME_GEO = "geo:0,0?q="; 296 297 /** 298 * Interface to listen for find results. 299 */ 300 public interface FindListener { 301 /** 302 * Notifies the listener about progress made by a find operation. 303 * 304 * @param activeMatchOrdinal the zero-based ordinal of the currently selected match 305 * @param numberOfMatches how many matches have been found 306 * @param isDoneCounting whether the find operation has actually completed. The listener 307 * may be notified multiple times while the 308 * operation is underway, and the numberOfMatches 309 * value should not be considered final unless 310 * isDoneCounting is true. 311 */ 312 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, 313 boolean isDoneCounting); 314 } 315 316 /** 317 * Interface to listen for new pictures as they change. 318 * 319 * @deprecated This interface is now obsolete. 320 */ 321 @Deprecated 322 public interface PictureListener { 323 /** 324 * Used to provide notification that the WebView's picture has changed. 325 * See {@link WebView#capturePicture} for details of the picture. 326 * 327 * @param view the WebView that owns the picture 328 * @param picture the new picture. Applications targeting 329 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} or above 330 * will always receive a null Picture. 331 * @deprecated Deprecated due to internal changes. 332 */ 333 @Deprecated 334 public void onNewPicture(WebView view, Picture picture); 335 } 336 337 public static class HitTestResult { 338 /** 339 * Default HitTestResult, where the target is unknown. 340 */ 341 public static final int UNKNOWN_TYPE = 0; 342 /** 343 * @deprecated This type is no longer used. 344 */ 345 @Deprecated 346 public static final int ANCHOR_TYPE = 1; 347 /** 348 * HitTestResult for hitting a phone number. 349 */ 350 public static final int PHONE_TYPE = 2; 351 /** 352 * HitTestResult for hitting a map address. 353 */ 354 public static final int GEO_TYPE = 3; 355 /** 356 * HitTestResult for hitting an email address. 357 */ 358 public static final int EMAIL_TYPE = 4; 359 /** 360 * HitTestResult for hitting an HTML::img tag. 361 */ 362 public static final int IMAGE_TYPE = 5; 363 /** 364 * @deprecated This type is no longer used. 365 */ 366 @Deprecated 367 public static final int IMAGE_ANCHOR_TYPE = 6; 368 /** 369 * HitTestResult for hitting a HTML::a tag with src=http. 370 */ 371 public static final int SRC_ANCHOR_TYPE = 7; 372 /** 373 * HitTestResult for hitting a HTML::a tag with src=http + HTML::img. 374 */ 375 public static final int SRC_IMAGE_ANCHOR_TYPE = 8; 376 /** 377 * HitTestResult for hitting an edit text area. 378 */ 379 public static final int EDIT_TEXT_TYPE = 9; 380 381 private int mType; 382 private String mExtra; 383 384 /** 385 * @hide Only for use by WebViewProvider implementations 386 */ 387 public HitTestResult() { 388 mType = UNKNOWN_TYPE; 389 } 390 391 /** 392 * @hide Only for use by WebViewProvider implementations 393 */ 394 public void setType(int type) { 395 mType = type; 396 } 397 398 /** 399 * @hide Only for use by WebViewProvider implementations 400 */ 401 public void setExtra(String extra) { 402 mExtra = extra; 403 } 404 405 /** 406 * Gets the type of the hit test result. See the XXX_TYPE constants 407 * defined in this class. 408 * 409 * @return the type of the hit test result 410 */ 411 public int getType() { 412 return mType; 413 } 414 415 /** 416 * Gets additional type-dependant information about the result. See 417 * {@link WebView#getHitTestResult()} for details. May either be null 418 * or contain extra information about this result. 419 * 420 * @return additional type-dependant information about the result 421 */ 422 public String getExtra() { 423 return mExtra; 424 } 425 } 426 427 /** 428 * Constructs a new WebView with a Context object. 429 * 430 * @param context a Context object used to access application assets 431 */ 432 public WebView(Context context) { 433 this(context, null); 434 } 435 436 /** 437 * Constructs a new WebView with layout parameters. 438 * 439 * @param context a Context object used to access application assets 440 * @param attrs an AttributeSet passed to our parent 441 */ 442 public WebView(Context context, AttributeSet attrs) { 443 this(context, attrs, com.android.internal.R.attr.webViewStyle); 444 } 445 446 /** 447 * Constructs a new WebView with layout parameters and a default style. 448 * 449 * @param context a Context object used to access application assets 450 * @param attrs an AttributeSet passed to our parent 451 * @param defStyleAttr an attribute in the current theme that contains a 452 * reference to a style resource that supplies default values for 453 * the view. Can be 0 to not look for defaults. 454 */ 455 public WebView(Context context, AttributeSet attrs, int defStyleAttr) { 456 this(context, attrs, defStyleAttr, 0); 457 } 458 459 /** 460 * Constructs a new WebView with layout parameters and a default style. 461 * 462 * @param context a Context object used to access application assets 463 * @param attrs an AttributeSet passed to our parent 464 * @param defStyleAttr an attribute in the current theme that contains a 465 * reference to a style resource that supplies default values for 466 * the view. Can be 0 to not look for defaults. 467 * @param defStyleRes a resource identifier of a style resource that 468 * supplies default values for the view, used only if 469 * defStyleAttr is 0 or can not be found in the theme. Can be 0 470 * to not look for defaults. 471 */ 472 public WebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) { 473 this(context, attrs, defStyleAttr, defStyleRes, null, false); 474 } 475 476 /** 477 * Constructs a new WebView with layout parameters and a default style. 478 * 479 * @param context a Context object used to access application assets 480 * @param attrs an AttributeSet passed to our parent 481 * @param defStyleAttr an attribute in the current theme that contains a 482 * reference to a style resource that supplies default values for 483 * the view. Can be 0 to not look for defaults. 484 * @param privateBrowsing whether this WebView will be initialized in 485 * private mode 486 * 487 * @deprecated Private browsing is no longer supported directly via 488 * WebView and will be removed in a future release. Prefer using 489 * {@link WebSettings}, {@link WebViewDatabase}, {@link CookieManager} 490 * and {@link WebStorage} for fine-grained control of privacy data. 491 */ 492 @Deprecated 493 public WebView(Context context, AttributeSet attrs, int defStyleAttr, 494 boolean privateBrowsing) { 495 this(context, attrs, defStyleAttr, 0, null, privateBrowsing); 496 } 497 498 /** 499 * Constructs a new WebView with layout parameters, a default style and a set 500 * of custom Javscript interfaces to be added to this WebView at initialization 501 * time. This guarantees that these interfaces will be available when the JS 502 * context is initialized. 503 * 504 * @param context a Context object used to access application assets 505 * @param attrs an AttributeSet passed to our parent 506 * @param defStyleAttr an attribute in the current theme that contains a 507 * reference to a style resource that supplies default values for 508 * the view. Can be 0 to not look for defaults. 509 * @param javaScriptInterfaces a Map of interface names, as keys, and 510 * object implementing those interfaces, as 511 * values 512 * @param privateBrowsing whether this WebView will be initialized in 513 * private mode 514 * @hide This is used internally by dumprendertree, as it requires the javaScript interfaces to 515 * be added synchronously, before a subsequent loadUrl call takes effect. 516 */ 517 protected WebView(Context context, AttributeSet attrs, int defStyleAttr, 518 Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) { 519 this(context, attrs, defStyleAttr, 0, javaScriptInterfaces, privateBrowsing); 520 } 521 522 /** 523 * @hide 524 */ 525 @SuppressWarnings("deprecation") // for super() call into deprecated base class constructor. 526 protected WebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes, 527 Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) { 528 super(context, attrs, defStyleAttr, defStyleRes); 529 if (context == null) { 530 throw new IllegalArgumentException("Invalid context argument"); 531 } 532 sEnforceThreadChecking = context.getApplicationInfo().targetSdkVersion >= 533 Build.VERSION_CODES.JELLY_BEAN_MR2; 534 checkThread(); 535 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "WebView<init>"); 536 537 ensureProviderCreated(); 538 mProvider.init(javaScriptInterfaces, privateBrowsing); 539 // Post condition of creating a webview is the CookieSyncManager.getInstance() is allowed. 540 CookieSyncManager.setGetInstanceIsAllowed(); 541 } 542 543 /** 544 * Specifies whether the horizontal scrollbar has overlay style. 545 * 546 * @param overlay true if horizontal scrollbar should have overlay style 547 */ 548 public void setHorizontalScrollbarOverlay(boolean overlay) { 549 checkThread(); 550 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setHorizontalScrollbarOverlay=" + overlay); 551 mProvider.setHorizontalScrollbarOverlay(overlay); 552 } 553 554 /** 555 * Specifies whether the vertical scrollbar has overlay style. 556 * 557 * @param overlay true if vertical scrollbar should have overlay style 558 */ 559 public void setVerticalScrollbarOverlay(boolean overlay) { 560 checkThread(); 561 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setVerticalScrollbarOverlay=" + overlay); 562 mProvider.setVerticalScrollbarOverlay(overlay); 563 } 564 565 /** 566 * Gets whether horizontal scrollbar has overlay style. 567 * 568 * @return true if horizontal scrollbar has overlay style 569 */ 570 public boolean overlayHorizontalScrollbar() { 571 checkThread(); 572 return mProvider.overlayHorizontalScrollbar(); 573 } 574 575 /** 576 * Gets whether vertical scrollbar has overlay style. 577 * 578 * @return true if vertical scrollbar has overlay style 579 */ 580 public boolean overlayVerticalScrollbar() { 581 checkThread(); 582 return mProvider.overlayVerticalScrollbar(); 583 } 584 585 /** 586 * Gets the visible height (in pixels) of the embedded title bar (if any). 587 * 588 * @deprecated This method is now obsolete. 589 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 590 */ 591 public int getVisibleTitleHeight() { 592 checkThread(); 593 return mProvider.getVisibleTitleHeight(); 594 } 595 596 /** 597 * Gets the SSL certificate for the main top-level page or null if there is 598 * no certificate (the site is not secure). 599 * 600 * @return the SSL certificate for the main top-level page 601 */ 602 public SslCertificate getCertificate() { 603 checkThread(); 604 return mProvider.getCertificate(); 605 } 606 607 /** 608 * Sets the SSL certificate for the main top-level page. 609 * 610 * @deprecated Calling this function has no useful effect, and will be 611 * ignored in future releases. 612 */ 613 @Deprecated 614 public void setCertificate(SslCertificate certificate) { 615 checkThread(); 616 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setCertificate=" + certificate); 617 mProvider.setCertificate(certificate); 618 } 619 620 //------------------------------------------------------------------------- 621 // Methods called by activity 622 //------------------------------------------------------------------------- 623 624 /** 625 * Sets a username and password pair for the specified host. This data is 626 * used by the Webview to autocomplete username and password fields in web 627 * forms. Note that this is unrelated to the credentials used for HTTP 628 * authentication. 629 * 630 * @param host the host that required the credentials 631 * @param username the username for the given host 632 * @param password the password for the given host 633 * @see WebViewDatabase#clearUsernamePassword 634 * @see WebViewDatabase#hasUsernamePassword 635 * @deprecated Saving passwords in WebView will not be supported in future versions. 636 */ 637 @Deprecated 638 public void savePassword(String host, String username, String password) { 639 checkThread(); 640 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "savePassword=" + host); 641 mProvider.savePassword(host, username, password); 642 } 643 644 /** 645 * Stores HTTP authentication credentials for a given host and realm. This 646 * method is intended to be used with 647 * {@link WebViewClient#onReceivedHttpAuthRequest}. 648 * 649 * @param host the host to which the credentials apply 650 * @param realm the realm to which the credentials apply 651 * @param username the username 652 * @param password the password 653 * @see #getHttpAuthUsernamePassword 654 * @see WebViewDatabase#hasHttpAuthUsernamePassword 655 * @see WebViewDatabase#clearHttpAuthUsernamePassword 656 */ 657 public void setHttpAuthUsernamePassword(String host, String realm, 658 String username, String password) { 659 checkThread(); 660 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setHttpAuthUsernamePassword=" + host); 661 mProvider.setHttpAuthUsernamePassword(host, realm, username, password); 662 } 663 664 /** 665 * Retrieves HTTP authentication credentials for a given host and realm. 666 * This method is intended to be used with 667 * {@link WebViewClient#onReceivedHttpAuthRequest}. 668 * 669 * @param host the host to which the credentials apply 670 * @param realm the realm to which the credentials apply 671 * @return the credentials as a String array, if found. The first element 672 * is the username and the second element is the password. Null if 673 * no credentials are found. 674 * @see #setHttpAuthUsernamePassword 675 * @see WebViewDatabase#hasHttpAuthUsernamePassword 676 * @see WebViewDatabase#clearHttpAuthUsernamePassword 677 */ 678 public String[] getHttpAuthUsernamePassword(String host, String realm) { 679 checkThread(); 680 return mProvider.getHttpAuthUsernamePassword(host, realm); 681 } 682 683 /** 684 * Destroys the internal state of this WebView. This method should be called 685 * after this WebView has been removed from the view system. No other 686 * methods may be called on this WebView after destroy. 687 */ 688 public void destroy() { 689 checkThread(); 690 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "destroy"); 691 mProvider.destroy(); 692 } 693 694 /** 695 * Enables platform notifications of data state and proxy changes. 696 * Notifications are enabled by default. 697 * 698 * @deprecated This method is now obsolete. 699 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 700 */ 701 @Deprecated 702 public static void enablePlatformNotifications() { 703 getFactory().getStatics().setPlatformNotificationsEnabled(true); 704 } 705 706 /** 707 * Disables platform notifications of data state and proxy changes. 708 * Notifications are enabled by default. 709 * 710 * @deprecated This method is now obsolete. 711 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 712 */ 713 @Deprecated 714 public static void disablePlatformNotifications() { 715 getFactory().getStatics().setPlatformNotificationsEnabled(false); 716 } 717 718 /** 719 * Used only by internal tests to free up memory. 720 * 721 * @hide 722 */ 723 public static void freeMemoryForTests() { 724 getFactory().getStatics().freeMemoryForTests(); 725 } 726 727 /** 728 * Informs WebView of the network state. This is used to set 729 * the JavaScript property window.navigator.isOnline and 730 * generates the online/offline event as specified in HTML5, sec. 5.7.7 731 * 732 * @param networkUp a boolean indicating if network is available 733 */ 734 public void setNetworkAvailable(boolean networkUp) { 735 checkThread(); 736 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setNetworkAvailable=" + networkUp); 737 mProvider.setNetworkAvailable(networkUp); 738 } 739 740 /** 741 * Saves the state of this WebView used in 742 * {@link android.app.Activity#onSaveInstanceState}. Please note that this 743 * method no longer stores the display data for this WebView. The previous 744 * behavior could potentially leak files if {@link #restoreState} was never 745 * called. 746 * 747 * @param outState the Bundle to store this WebView's state 748 * @return the same copy of the back/forward list used to save the state. If 749 * saveState fails, the returned list will be null. 750 */ 751 public WebBackForwardList saveState(Bundle outState) { 752 checkThread(); 753 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "saveState"); 754 return mProvider.saveState(outState); 755 } 756 757 /** 758 * Saves the current display data to the Bundle given. Used in conjunction 759 * with {@link #saveState}. 760 * @param b a Bundle to store the display data 761 * @param dest the file to store the serialized picture data. Will be 762 * overwritten with this WebView's picture data. 763 * @return true if the picture was successfully saved 764 * @deprecated This method is now obsolete. 765 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 766 */ 767 @Deprecated 768 public boolean savePicture(Bundle b, final File dest) { 769 checkThread(); 770 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "savePicture=" + dest.getName()); 771 return mProvider.savePicture(b, dest); 772 } 773 774 /** 775 * Restores the display data that was saved in {@link #savePicture}. Used in 776 * conjunction with {@link #restoreState}. Note that this will not work if 777 * this WebView is hardware accelerated. 778 * 779 * @param b a Bundle containing the saved display data 780 * @param src the file where the picture data was stored 781 * @return true if the picture was successfully restored 782 * @deprecated This method is now obsolete. 783 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 784 */ 785 @Deprecated 786 public boolean restorePicture(Bundle b, File src) { 787 checkThread(); 788 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "restorePicture=" + src.getName()); 789 return mProvider.restorePicture(b, src); 790 } 791 792 /** 793 * Restores the state of this WebView from the given Bundle. This method is 794 * intended for use in {@link android.app.Activity#onRestoreInstanceState} 795 * and should be called to restore the state of this WebView. If 796 * it is called after this WebView has had a chance to build state (load 797 * pages, create a back/forward list, etc.) there may be undesirable 798 * side-effects. Please note that this method no longer restores the 799 * display data for this WebView. 800 * 801 * @param inState the incoming Bundle of state 802 * @return the restored back/forward list or null if restoreState failed 803 */ 804 public WebBackForwardList restoreState(Bundle inState) { 805 checkThread(); 806 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "restoreState"); 807 return mProvider.restoreState(inState); 808 } 809 810 /** 811 * Loads the given URL with the specified additional HTTP headers. 812 * 813 * @param url the URL of the resource to load 814 * @param additionalHttpHeaders the additional headers to be used in the 815 * HTTP request for this URL, specified as a map from name to 816 * value. Note that if this map contains any of the headers 817 * that are set by default by this WebView, such as those 818 * controlling caching, accept types or the User-Agent, their 819 * values may be overriden by this WebView's defaults. 820 */ 821 public void loadUrl(String url, Map<String, String> additionalHttpHeaders) { 822 checkThread(); 823 if (DebugFlags.TRACE_API) { 824 StringBuilder headers = new StringBuilder(); 825 if (additionalHttpHeaders != null) { 826 for (Map.Entry<String, String> entry : additionalHttpHeaders.entrySet()) { 827 headers.append(entry.getKey() + ":" + entry.getValue() + "\n"); 828 } 829 } 830 Log.d(LOGTAG, "loadUrl(extra headers)=" + url + "\n" + headers); 831 } 832 mProvider.loadUrl(url, additionalHttpHeaders); 833 } 834 835 /** 836 * Loads the given URL. 837 * 838 * @param url the URL of the resource to load 839 */ 840 public void loadUrl(String url) { 841 checkThread(); 842 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "loadUrl=" + url); 843 mProvider.loadUrl(url); 844 } 845 846 /** 847 * Loads the URL with postData using "POST" method into this WebView. If url 848 * is not a network URL, it will be loaded with {@link #loadUrl(String)} 849 * instead, ignoring the postData param. 850 * 851 * @param url the URL of the resource to load 852 * @param postData the data will be passed to "POST" request, which must be 853 * be "application/x-www-form-urlencoded" encoded. 854 */ 855 public void postUrl(String url, byte[] postData) { 856 checkThread(); 857 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "postUrl=" + url); 858 if (URLUtil.isNetworkUrl(url)) { 859 mProvider.postUrl(url, postData); 860 } else { 861 mProvider.loadUrl(url); 862 } 863 } 864 865 /** 866 * Loads the given data into this WebView using a 'data' scheme URL. 867 * <p> 868 * Note that JavaScript's same origin policy means that script running in a 869 * page loaded using this method will be unable to access content loaded 870 * using any scheme other than 'data', including 'http(s)'. To avoid this 871 * restriction, use {@link 872 * #loadDataWithBaseURL(String,String,String,String,String) 873 * loadDataWithBaseURL()} with an appropriate base URL. 874 * <p> 875 * The encoding parameter specifies whether the data is base64 or URL 876 * encoded. If the data is base64 encoded, the value of the encoding 877 * parameter must be 'base64'. For all other values of the parameter, 878 * including null, it is assumed that the data uses ASCII encoding for 879 * octets inside the range of safe URL characters and use the standard %xx 880 * hex encoding of URLs for octets outside that range. For example, '#', 881 * '%', '\', '?' should be replaced by %23, %25, %27, %3f respectively. 882 * <p> 883 * The 'data' scheme URL formed by this method uses the default US-ASCII 884 * charset. If you need need to set a different charset, you should form a 885 * 'data' scheme URL which explicitly specifies a charset parameter in the 886 * mediatype portion of the URL and call {@link #loadUrl(String)} instead. 887 * Note that the charset obtained from the mediatype portion of a data URL 888 * always overrides that specified in the HTML or XML document itself. 889 * 890 * @param data a String of data in the given encoding 891 * @param mimeType the MIME type of the data, e.g. 'text/html' 892 * @param encoding the encoding of the data 893 */ 894 public void loadData(String data, String mimeType, String encoding) { 895 checkThread(); 896 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "loadData"); 897 mProvider.loadData(data, mimeType, encoding); 898 } 899 900 /** 901 * Loads the given data into this WebView, using baseUrl as the base URL for 902 * the content. The base URL is used both to resolve relative URLs and when 903 * applying JavaScript's same origin policy. The historyUrl is used for the 904 * history entry. 905 * <p> 906 * Note that content specified in this way can access local device files 907 * (via 'file' scheme URLs) only if baseUrl specifies a scheme other than 908 * 'http', 'https', 'ftp', 'ftps', 'about' or 'javascript'. 909 * <p> 910 * If the base URL uses the data scheme, this method is equivalent to 911 * calling {@link #loadData(String,String,String) loadData()} and the 912 * historyUrl is ignored, and the data will be treated as part of a data: URL. 913 * If the base URL uses any other scheme, then the data will be loaded into 914 * the WebView as a plain string (i.e. not part of a data URL) and any URL-encoded 915 * entities in the string will not be decoded. 916 * 917 * @param baseUrl the URL to use as the page's base URL. If null defaults to 918 * 'about:blank'. 919 * @param data a String of data in the given encoding 920 * @param mimeType the MIMEType of the data, e.g. 'text/html'. If null, 921 * defaults to 'text/html'. 922 * @param encoding the encoding of the data 923 * @param historyUrl the URL to use as the history entry. If null defaults 924 * to 'about:blank'. If non-null, this must be a valid URL. 925 */ 926 public void loadDataWithBaseURL(String baseUrl, String data, 927 String mimeType, String encoding, String historyUrl) { 928 checkThread(); 929 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "loadDataWithBaseURL=" + baseUrl); 930 mProvider.loadDataWithBaseURL(baseUrl, data, mimeType, encoding, historyUrl); 931 } 932 933 /** 934 * Asynchronously evaluates JavaScript in the context of the currently displayed page. 935 * If non-null, |resultCallback| will be invoked with any result returned from that 936 * execution. This method must be called on the UI thread and the callback will 937 * be made on the UI thread. 938 * 939 * @param script the JavaScript to execute. 940 * @param resultCallback A callback to be invoked when the script execution 941 * completes with the result of the execution (if any). 942 * May be null if no notificaion of the result is required. 943 */ 944 public void evaluateJavascript(String script, ValueCallback<String> resultCallback) { 945 checkThread(); 946 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "evaluateJavascript=" + script); 947 mProvider.evaluateJavaScript(script, resultCallback); 948 } 949 950 /** 951 * Saves the current view as a web archive. 952 * 953 * @param filename the filename where the archive should be placed 954 */ 955 public void saveWebArchive(String filename) { 956 checkThread(); 957 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "saveWebArchive=" + filename); 958 mProvider.saveWebArchive(filename); 959 } 960 961 /** 962 * Saves the current view as a web archive. 963 * 964 * @param basename the filename where the archive should be placed 965 * @param autoname if false, takes basename to be a file. If true, basename 966 * is assumed to be a directory in which a filename will be 967 * chosen according to the URL of the current page. 968 * @param callback called after the web archive has been saved. The 969 * parameter for onReceiveValue will either be the filename 970 * under which the file was saved, or null if saving the 971 * file failed. 972 */ 973 public void saveWebArchive(String basename, boolean autoname, ValueCallback<String> callback) { 974 checkThread(); 975 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "saveWebArchive(auto)=" + basename); 976 mProvider.saveWebArchive(basename, autoname, callback); 977 } 978 979 /** 980 * Stops the current load. 981 */ 982 public void stopLoading() { 983 checkThread(); 984 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "stopLoading"); 985 mProvider.stopLoading(); 986 } 987 988 /** 989 * Reloads the current URL. 990 */ 991 public void reload() { 992 checkThread(); 993 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "reload"); 994 mProvider.reload(); 995 } 996 997 /** 998 * Gets whether this WebView has a back history item. 999 * 1000 * @return true iff this WebView has a back history item 1001 */ 1002 public boolean canGoBack() { 1003 checkThread(); 1004 return mProvider.canGoBack(); 1005 } 1006 1007 /** 1008 * Goes back in the history of this WebView. 1009 */ 1010 public void goBack() { 1011 checkThread(); 1012 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "goBack"); 1013 mProvider.goBack(); 1014 } 1015 1016 /** 1017 * Gets whether this WebView has a forward history item. 1018 * 1019 * @return true iff this Webview has a forward history item 1020 */ 1021 public boolean canGoForward() { 1022 checkThread(); 1023 return mProvider.canGoForward(); 1024 } 1025 1026 /** 1027 * Goes forward in the history of this WebView. 1028 */ 1029 public void goForward() { 1030 checkThread(); 1031 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "goForward"); 1032 mProvider.goForward(); 1033 } 1034 1035 /** 1036 * Gets whether the page can go back or forward the given 1037 * number of steps. 1038 * 1039 * @param steps the negative or positive number of steps to move the 1040 * history 1041 */ 1042 public boolean canGoBackOrForward(int steps) { 1043 checkThread(); 1044 return mProvider.canGoBackOrForward(steps); 1045 } 1046 1047 /** 1048 * Goes to the history item that is the number of steps away from 1049 * the current item. Steps is negative if backward and positive 1050 * if forward. 1051 * 1052 * @param steps the number of steps to take back or forward in the back 1053 * forward list 1054 */ 1055 public void goBackOrForward(int steps) { 1056 checkThread(); 1057 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "goBackOrForwad=" + steps); 1058 mProvider.goBackOrForward(steps); 1059 } 1060 1061 /** 1062 * Gets whether private browsing is enabled in this WebView. 1063 */ 1064 public boolean isPrivateBrowsingEnabled() { 1065 checkThread(); 1066 return mProvider.isPrivateBrowsingEnabled(); 1067 } 1068 1069 /** 1070 * Scrolls the contents of this WebView up by half the view size. 1071 * 1072 * @param top true to jump to the top of the page 1073 * @return true if the page was scrolled 1074 */ 1075 public boolean pageUp(boolean top) { 1076 checkThread(); 1077 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "pageUp"); 1078 return mProvider.pageUp(top); 1079 } 1080 1081 /** 1082 * Scrolls the contents of this WebView down by half the page size. 1083 * 1084 * @param bottom true to jump to bottom of page 1085 * @return true if the page was scrolled 1086 */ 1087 public boolean pageDown(boolean bottom) { 1088 checkThread(); 1089 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "pageDown"); 1090 return mProvider.pageDown(bottom); 1091 } 1092 1093 /** 1094 * Clears this WebView so that onDraw() will draw nothing but white background, 1095 * and onMeasure() will return 0 if MeasureSpec is not MeasureSpec.EXACTLY. 1096 * @deprecated Use WebView.loadUrl("about:blank") to reliably reset the view state 1097 * and release page resources (including any running JavaScript). 1098 */ 1099 @Deprecated 1100 public void clearView() { 1101 checkThread(); 1102 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "clearView"); 1103 mProvider.clearView(); 1104 } 1105 1106 /** 1107 * Gets a new picture that captures the current contents of this WebView. 1108 * The picture is of the entire document being displayed, and is not 1109 * limited to the area currently displayed by this WebView. Also, the 1110 * picture is a static copy and is unaffected by later changes to the 1111 * content being displayed. 1112 * <p> 1113 * Note that due to internal changes, for API levels between 1114 * {@link android.os.Build.VERSION_CODES#HONEYCOMB} and 1115 * {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH} inclusive, the 1116 * picture does not include fixed position elements or scrollable divs. 1117 * <p> 1118 * Note that from {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} the returned picture 1119 * should only be drawn into bitmap-backed Canvas - using any other type of Canvas will involve 1120 * additional conversion at a cost in memory and performance. Also the 1121 * {@link android.graphics.Picture#createFromStream} and 1122 * {@link android.graphics.Picture#writeToStream} methods are not supported on the 1123 * returned object. 1124 * 1125 * @deprecated Use {@link #onDraw} to obtain a bitmap snapshot of the WebView, or 1126 * {@link #saveWebArchive} to save the content to a file. 1127 * 1128 * @return a picture that captures the current contents of this WebView 1129 */ 1130 @Deprecated 1131 public Picture capturePicture() { 1132 checkThread(); 1133 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "capturePicture"); 1134 return mProvider.capturePicture(); 1135 } 1136 1137 /** 1138 * Creates a PrintDocumentAdapter that provides the content of this Webview for printing. 1139 * Only supported for API levels 1140 * {@link android.os.Build.VERSION_CODES#KITKAT} and above. 1141 * 1142 * The adapter works by converting the Webview contents to a PDF stream. The Webview cannot 1143 * be drawn during the conversion process - any such draws are undefined. It is recommended 1144 * to use a dedicated off screen Webview for the printing. If necessary, an application may 1145 * temporarily hide a visible WebView by using a custom PrintDocumentAdapter instance 1146 * wrapped around the object returned and observing the onStart and onFinish methods. See 1147 * {@link android.print.PrintDocumentAdapter} for more information. 1148 */ 1149 public PrintDocumentAdapter createPrintDocumentAdapter() { 1150 checkThread(); 1151 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "createPrintDocumentAdapter"); 1152 return mProvider.createPrintDocumentAdapter(); 1153 } 1154 1155 /** 1156 * Gets the current scale of this WebView. 1157 * 1158 * @return the current scale 1159 * 1160 * @deprecated This method is prone to inaccuracy due to race conditions 1161 * between the web rendering and UI threads; prefer 1162 * {@link WebViewClient#onScaleChanged}. 1163 */ 1164 @Deprecated 1165 @ViewDebug.ExportedProperty(category = "webview") 1166 public float getScale() { 1167 checkThread(); 1168 return mProvider.getScale(); 1169 } 1170 1171 /** 1172 * Sets the initial scale for this WebView. 0 means default. 1173 * The behavior for the default scale depends on the state of 1174 * {@link WebSettings#getUseWideViewPort()} and 1175 * {@link WebSettings#getLoadWithOverviewMode()}. 1176 * If the content fits into the WebView control by width, then 1177 * the zoom is set to 100%. For wide content, the behavor 1178 * depends on the state of {@link WebSettings#getLoadWithOverviewMode()}. 1179 * If its value is true, the content will be zoomed out to be fit 1180 * by width into the WebView control, otherwise not. 1181 * 1182 * If initial scale is greater than 0, WebView starts with this value 1183 * as initial scale. 1184 * Please note that unlike the scale properties in the viewport meta tag, 1185 * this method doesn't take the screen density into account. 1186 * 1187 * @param scaleInPercent the initial scale in percent 1188 */ 1189 public void setInitialScale(int scaleInPercent) { 1190 checkThread(); 1191 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setInitialScale=" + scaleInPercent); 1192 mProvider.setInitialScale(scaleInPercent); 1193 } 1194 1195 /** 1196 * Invokes the graphical zoom picker widget for this WebView. This will 1197 * result in the zoom widget appearing on the screen to control the zoom 1198 * level of this WebView. 1199 */ 1200 public void invokeZoomPicker() { 1201 checkThread(); 1202 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "invokeZoomPicker"); 1203 mProvider.invokeZoomPicker(); 1204 } 1205 1206 /** 1207 * Gets a HitTestResult based on the current cursor node. If a HTML::a 1208 * tag is found and the anchor has a non-JavaScript URL, the HitTestResult 1209 * type is set to SRC_ANCHOR_TYPE and the URL is set in the "extra" field. 1210 * If the anchor does not have a URL or if it is a JavaScript URL, the type 1211 * will be UNKNOWN_TYPE and the URL has to be retrieved through 1212 * {@link #requestFocusNodeHref} asynchronously. If a HTML::img tag is 1213 * found, the HitTestResult type is set to IMAGE_TYPE and the URL is set in 1214 * the "extra" field. A type of 1215 * SRC_IMAGE_ANCHOR_TYPE indicates an anchor with a URL that has an image as 1216 * a child node. If a phone number is found, the HitTestResult type is set 1217 * to PHONE_TYPE and the phone number is set in the "extra" field of 1218 * HitTestResult. If a map address is found, the HitTestResult type is set 1219 * to GEO_TYPE and the address is set in the "extra" field of HitTestResult. 1220 * If an email address is found, the HitTestResult type is set to EMAIL_TYPE 1221 * and the email is set in the "extra" field of HitTestResult. Otherwise, 1222 * HitTestResult type is set to UNKNOWN_TYPE. 1223 */ 1224 public HitTestResult getHitTestResult() { 1225 checkThread(); 1226 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "getHitTestResult"); 1227 return mProvider.getHitTestResult(); 1228 } 1229 1230 /** 1231 * Requests the anchor or image element URL at the last tapped point. 1232 * If hrefMsg is null, this method returns immediately and does not 1233 * dispatch hrefMsg to its target. If the tapped point hits an image, 1234 * an anchor, or an image in an anchor, the message associates 1235 * strings in named keys in its data. The value paired with the key 1236 * may be an empty string. 1237 * 1238 * @param hrefMsg the message to be dispatched with the result of the 1239 * request. The message data contains three keys. "url" 1240 * returns the anchor's href attribute. "title" returns the 1241 * anchor's text. "src" returns the image's src attribute. 1242 */ 1243 public void requestFocusNodeHref(Message hrefMsg) { 1244 checkThread(); 1245 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "requestFocusNodeHref"); 1246 mProvider.requestFocusNodeHref(hrefMsg); 1247 } 1248 1249 /** 1250 * Requests the URL of the image last touched by the user. msg will be sent 1251 * to its target with a String representing the URL as its object. 1252 * 1253 * @param msg the message to be dispatched with the result of the request 1254 * as the data member with "url" as key. The result can be null. 1255 */ 1256 public void requestImageRef(Message msg) { 1257 checkThread(); 1258 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "requestImageRef"); 1259 mProvider.requestImageRef(msg); 1260 } 1261 1262 /** 1263 * Gets the URL for the current page. This is not always the same as the URL 1264 * passed to WebViewClient.onPageStarted because although the load for 1265 * that URL has begun, the current page may not have changed. 1266 * 1267 * @return the URL for the current page 1268 */ 1269 @ViewDebug.ExportedProperty(category = "webview") 1270 public String getUrl() { 1271 checkThread(); 1272 return mProvider.getUrl(); 1273 } 1274 1275 /** 1276 * Gets the original URL for the current page. This is not always the same 1277 * as the URL passed to WebViewClient.onPageStarted because although the 1278 * load for that URL has begun, the current page may not have changed. 1279 * Also, there may have been redirects resulting in a different URL to that 1280 * originally requested. 1281 * 1282 * @return the URL that was originally requested for the current page 1283 */ 1284 @ViewDebug.ExportedProperty(category = "webview") 1285 public String getOriginalUrl() { 1286 checkThread(); 1287 return mProvider.getOriginalUrl(); 1288 } 1289 1290 /** 1291 * Gets the title for the current page. This is the title of the current page 1292 * until WebViewClient.onReceivedTitle is called. 1293 * 1294 * @return the title for the current page 1295 */ 1296 @ViewDebug.ExportedProperty(category = "webview") 1297 public String getTitle() { 1298 checkThread(); 1299 return mProvider.getTitle(); 1300 } 1301 1302 /** 1303 * Gets the favicon for the current page. This is the favicon of the current 1304 * page until WebViewClient.onReceivedIcon is called. 1305 * 1306 * @return the favicon for the current page 1307 */ 1308 public Bitmap getFavicon() { 1309 checkThread(); 1310 return mProvider.getFavicon(); 1311 } 1312 1313 /** 1314 * Gets the touch icon URL for the apple-touch-icon <link> element, or 1315 * a URL on this site's server pointing to the standard location of a 1316 * touch icon. 1317 * 1318 * @hide 1319 */ 1320 public String getTouchIconUrl() { 1321 return mProvider.getTouchIconUrl(); 1322 } 1323 1324 /** 1325 * Gets the progress for the current page. 1326 * 1327 * @return the progress for the current page between 0 and 100 1328 */ 1329 public int getProgress() { 1330 checkThread(); 1331 return mProvider.getProgress(); 1332 } 1333 1334 /** 1335 * Gets the height of the HTML content. 1336 * 1337 * @return the height of the HTML content 1338 */ 1339 @ViewDebug.ExportedProperty(category = "webview") 1340 public int getContentHeight() { 1341 checkThread(); 1342 return mProvider.getContentHeight(); 1343 } 1344 1345 /** 1346 * Gets the width of the HTML content. 1347 * 1348 * @return the width of the HTML content 1349 * @hide 1350 */ 1351 @ViewDebug.ExportedProperty(category = "webview") 1352 public int getContentWidth() { 1353 return mProvider.getContentWidth(); 1354 } 1355 1356 /** 1357 * Pauses all layout, parsing, and JavaScript timers for all WebViews. This 1358 * is a global requests, not restricted to just this WebView. This can be 1359 * useful if the application has been paused. 1360 */ 1361 public void pauseTimers() { 1362 checkThread(); 1363 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "pauseTimers"); 1364 mProvider.pauseTimers(); 1365 } 1366 1367 /** 1368 * Resumes all layout, parsing, and JavaScript timers for all WebViews. 1369 * This will resume dispatching all timers. 1370 */ 1371 public void resumeTimers() { 1372 checkThread(); 1373 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "resumeTimers"); 1374 mProvider.resumeTimers(); 1375 } 1376 1377 /** 1378 * Pauses any extra processing associated with this WebView and its 1379 * associated DOM, plugins, JavaScript etc. For example, if this WebView is 1380 * taken offscreen, this could be called to reduce unnecessary CPU or 1381 * network traffic. When this WebView is again "active", call onResume(). 1382 * Note that this differs from pauseTimers(), which affects all WebViews. 1383 */ 1384 public void onPause() { 1385 checkThread(); 1386 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "onPause"); 1387 mProvider.onPause(); 1388 } 1389 1390 /** 1391 * Resumes a WebView after a previous call to onPause(). 1392 */ 1393 public void onResume() { 1394 checkThread(); 1395 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "onResume"); 1396 mProvider.onResume(); 1397 } 1398 1399 /** 1400 * Gets whether this WebView is paused, meaning onPause() was called. 1401 * Calling onResume() sets the paused state back to false. 1402 * 1403 * @hide 1404 */ 1405 public boolean isPaused() { 1406 return mProvider.isPaused(); 1407 } 1408 1409 /** 1410 * Informs this WebView that memory is low so that it can free any available 1411 * memory. 1412 * @deprecated Memory caches are automatically dropped when no longer needed, and in response 1413 * to system memory pressure. 1414 */ 1415 @Deprecated 1416 public void freeMemory() { 1417 checkThread(); 1418 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "freeMemory"); 1419 mProvider.freeMemory(); 1420 } 1421 1422 /** 1423 * Clears the resource cache. Note that the cache is per-application, so 1424 * this will clear the cache for all WebViews used. 1425 * 1426 * @param includeDiskFiles if false, only the RAM cache is cleared 1427 */ 1428 public void clearCache(boolean includeDiskFiles) { 1429 checkThread(); 1430 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "clearCache"); 1431 mProvider.clearCache(includeDiskFiles); 1432 } 1433 1434 /** 1435 * Removes the autocomplete popup from the currently focused form field, if 1436 * present. Note this only affects the display of the autocomplete popup, 1437 * it does not remove any saved form data from this WebView's store. To do 1438 * that, use {@link WebViewDatabase#clearFormData}. 1439 */ 1440 public void clearFormData() { 1441 checkThread(); 1442 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "clearFormData"); 1443 mProvider.clearFormData(); 1444 } 1445 1446 /** 1447 * Tells this WebView to clear its internal back/forward list. 1448 */ 1449 public void clearHistory() { 1450 checkThread(); 1451 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "clearHistory"); 1452 mProvider.clearHistory(); 1453 } 1454 1455 /** 1456 * Clears the SSL preferences table stored in response to proceeding with 1457 * SSL certificate errors. 1458 */ 1459 public void clearSslPreferences() { 1460 checkThread(); 1461 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "clearSslPreferences"); 1462 mProvider.clearSslPreferences(); 1463 } 1464 1465 /** 1466 * Gets the WebBackForwardList for this WebView. This contains the 1467 * back/forward list for use in querying each item in the history stack. 1468 * This is a copy of the private WebBackForwardList so it contains only a 1469 * snapshot of the current state. Multiple calls to this method may return 1470 * different objects. The object returned from this method will not be 1471 * updated to reflect any new state. 1472 */ 1473 public WebBackForwardList copyBackForwardList() { 1474 checkThread(); 1475 return mProvider.copyBackForwardList(); 1476 1477 } 1478 1479 /** 1480 * Registers the listener to be notified as find-on-page operations 1481 * progress. This will replace the current listener. 1482 * 1483 * @param listener an implementation of {@link FindListener} 1484 */ 1485 public void setFindListener(FindListener listener) { 1486 checkThread(); 1487 setupFindListenerIfNeeded(); 1488 mFindListener.mUserFindListener = listener; 1489 } 1490 1491 /** 1492 * Highlights and scrolls to the next match found by 1493 * {@link #findAllAsync}, wrapping around page boundaries as necessary. 1494 * Notifies any registered {@link FindListener}. If {@link #findAllAsync(String)} 1495 * has not been called yet, or if {@link #clearMatches} has been called since the 1496 * last find operation, this function does nothing. 1497 * 1498 * @param forward the direction to search 1499 * @see #setFindListener 1500 */ 1501 public void findNext(boolean forward) { 1502 checkThread(); 1503 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "findNext"); 1504 mProvider.findNext(forward); 1505 } 1506 1507 /** 1508 * Finds all instances of find on the page and highlights them. 1509 * Notifies any registered {@link FindListener}. 1510 * 1511 * @param find the string to find 1512 * @return the number of occurances of the String "find" that were found 1513 * @deprecated {@link #findAllAsync} is preferred. 1514 * @see #setFindListener 1515 */ 1516 @Deprecated 1517 public int findAll(String find) { 1518 checkThread(); 1519 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "findAll"); 1520 StrictMode.noteSlowCall("findAll blocks UI: prefer findAllAsync"); 1521 return mProvider.findAll(find); 1522 } 1523 1524 /** 1525 * Finds all instances of find on the page and highlights them, 1526 * asynchronously. Notifies any registered {@link FindListener}. 1527 * Successive calls to this will cancel any pending searches. 1528 * 1529 * @param find the string to find. 1530 * @see #setFindListener 1531 */ 1532 public void findAllAsync(String find) { 1533 checkThread(); 1534 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "findAllAsync"); 1535 mProvider.findAllAsync(find); 1536 } 1537 1538 /** 1539 * Starts an ActionMode for finding text in this WebView. Only works if this 1540 * WebView is attached to the view system. 1541 * 1542 * @param text if non-null, will be the initial text to search for. 1543 * Otherwise, the last String searched for in this WebView will 1544 * be used to start. 1545 * @param showIme if true, show the IME, assuming the user will begin typing. 1546 * If false and text is non-null, perform a find all. 1547 * @return true if the find dialog is shown, false otherwise 1548 * @deprecated This method does not work reliably on all Android versions; 1549 * implementing a custom find dialog using WebView.findAllAsync() 1550 * provides a more robust solution. 1551 */ 1552 @Deprecated 1553 public boolean showFindDialog(String text, boolean showIme) { 1554 checkThread(); 1555 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "showFindDialog"); 1556 return mProvider.showFindDialog(text, showIme); 1557 } 1558 1559 /** 1560 * Gets the first substring consisting of the address of a physical 1561 * location. Currently, only addresses in the United States are detected, 1562 * and consist of: 1563 * <ul> 1564 * <li>a house number</li> 1565 * <li>a street name</li> 1566 * <li>a street type (Road, Circle, etc), either spelled out or 1567 * abbreviated</li> 1568 * <li>a city name</li> 1569 * <li>a state or territory, either spelled out or two-letter abbr</li> 1570 * <li>an optional 5 digit or 9 digit zip code</li> 1571 * </ul> 1572 * All names must be correctly capitalized, and the zip code, if present, 1573 * must be valid for the state. The street type must be a standard USPS 1574 * spelling or abbreviation. The state or territory must also be spelled 1575 * or abbreviated using USPS standards. The house number may not exceed 1576 * five digits. 1577 * 1578 * @param addr the string to search for addresses 1579 * @return the address, or if no address is found, null 1580 */ 1581 public static String findAddress(String addr) { 1582 return getFactory().getStatics().findAddress(addr); 1583 } 1584 1585 /** 1586 * Clears the highlighting surrounding text matches created by 1587 * {@link #findAllAsync}. 1588 */ 1589 public void clearMatches() { 1590 checkThread(); 1591 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "clearMatches"); 1592 mProvider.clearMatches(); 1593 } 1594 1595 /** 1596 * Queries the document to see if it contains any image references. The 1597 * message object will be dispatched with arg1 being set to 1 if images 1598 * were found and 0 if the document does not reference any images. 1599 * 1600 * @param response the message that will be dispatched with the result 1601 */ 1602 public void documentHasImages(Message response) { 1603 checkThread(); 1604 mProvider.documentHasImages(response); 1605 } 1606 1607 /** 1608 * Sets the WebViewClient that will receive various notifications and 1609 * requests. This will replace the current handler. 1610 * 1611 * @param client an implementation of WebViewClient 1612 */ 1613 public void setWebViewClient(WebViewClient client) { 1614 checkThread(); 1615 mProvider.setWebViewClient(client); 1616 } 1617 1618 /** 1619 * Registers the interface to be used when content can not be handled by 1620 * the rendering engine, and should be downloaded instead. This will replace 1621 * the current handler. 1622 * 1623 * @param listener an implementation of DownloadListener 1624 */ 1625 public void setDownloadListener(DownloadListener listener) { 1626 checkThread(); 1627 mProvider.setDownloadListener(listener); 1628 } 1629 1630 /** 1631 * Sets the chrome handler. This is an implementation of WebChromeClient for 1632 * use in handling JavaScript dialogs, favicons, titles, and the progress. 1633 * This will replace the current handler. 1634 * 1635 * @param client an implementation of WebChromeClient 1636 */ 1637 public void setWebChromeClient(WebChromeClient client) { 1638 checkThread(); 1639 mProvider.setWebChromeClient(client); 1640 } 1641 1642 /** 1643 * Sets the Picture listener. This is an interface used to receive 1644 * notifications of a new Picture. 1645 * 1646 * @param listener an implementation of WebView.PictureListener 1647 * @deprecated This method is now obsolete. 1648 */ 1649 @Deprecated 1650 public void setPictureListener(PictureListener listener) { 1651 checkThread(); 1652 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "setPictureListener=" + listener); 1653 mProvider.setPictureListener(listener); 1654 } 1655 1656 /** 1657 * Injects the supplied Java object into this WebView. The object is 1658 * injected into the JavaScript context of the main frame, using the 1659 * supplied name. This allows the Java object's methods to be 1660 * accessed from JavaScript. For applications targeted to API 1661 * level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 1662 * and above, only public methods that are annotated with 1663 * {@link android.webkit.JavascriptInterface} can be accessed from JavaScript. 1664 * For applications targeted to API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN} or below, 1665 * all public methods (including the inherited ones) can be accessed, see the 1666 * important security note below for implications. 1667 * <p> Note that injected objects will not 1668 * appear in JavaScript until the page is next (re)loaded. For example: 1669 * <pre> 1670 * class JsObject { 1671 * {@literal @}JavascriptInterface 1672 * public String toString() { return "injectedObject"; } 1673 * } 1674 * webView.addJavascriptInterface(new JsObject(), "injectedObject"); 1675 * webView.loadData("<!DOCTYPE html><title></title>", "text/html", null); 1676 * webView.loadUrl("javascript:alert(injectedObject.toString())");</pre> 1677 * <p> 1678 * <strong>IMPORTANT:</strong> 1679 * <ul> 1680 * <li> This method can be used to allow JavaScript to control the host 1681 * application. This is a powerful feature, but also presents a security 1682 * risk for applications targeted to API level 1683 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} or below, because 1684 * JavaScript could use reflection to access an 1685 * injected object's public fields. Use of this method in a WebView 1686 * containing untrusted content could allow an attacker to manipulate the 1687 * host application in unintended ways, executing Java code with the 1688 * permissions of the host application. Use extreme care when using this 1689 * method in a WebView which could contain untrusted content.</li> 1690 * <li> JavaScript interacts with Java object on a private, background 1691 * thread of this WebView. Care is therefore required to maintain thread 1692 * safety.</li> 1693 * <li> The Java object's fields are not accessible.</li> 1694 * </ul> 1695 * 1696 * @param object the Java object to inject into this WebView's JavaScript 1697 * context. Null values are ignored. 1698 * @param name the name used to expose the object in JavaScript 1699 */ 1700 public void addJavascriptInterface(Object object, String name) { 1701 checkThread(); 1702 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "addJavascriptInterface=" + name); 1703 mProvider.addJavascriptInterface(object, name); 1704 } 1705 1706 /** 1707 * Removes a previously injected Java object from this WebView. Note that 1708 * the removal will not be reflected in JavaScript until the page is next 1709 * (re)loaded. See {@link #addJavascriptInterface}. 1710 * 1711 * @param name the name used to expose the object in JavaScript 1712 */ 1713 public void removeJavascriptInterface(String name) { 1714 checkThread(); 1715 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "removeJavascriptInterface=" + name); 1716 mProvider.removeJavascriptInterface(name); 1717 } 1718 1719 /** 1720 * Gets the WebSettings object used to control the settings for this 1721 * WebView. 1722 * 1723 * @return a WebSettings object that can be used to control this WebView's 1724 * settings 1725 */ 1726 public WebSettings getSettings() { 1727 checkThread(); 1728 return mProvider.getSettings(); 1729 } 1730 1731 /** 1732 * Enables debugging of web contents (HTML / CSS / JavaScript) 1733 * loaded into any WebViews of this application. This flag can be enabled 1734 * in order to facilitate debugging of web layouts and JavaScript 1735 * code running inside WebViews. Please refer to WebView documentation 1736 * for the debugging guide. 1737 * 1738 * The default is false. 1739 * 1740 * @param enabled whether to enable web contents debugging 1741 */ 1742 public static void setWebContentsDebuggingEnabled(boolean enabled) { 1743 getFactory().getStatics().setWebContentsDebuggingEnabled(enabled); 1744 } 1745 1746 /** 1747 * Gets the list of currently loaded plugins. 1748 * 1749 * @return the list of currently loaded plugins 1750 * @deprecated This was used for Gears, which has been deprecated. 1751 * @hide 1752 */ 1753 @Deprecated 1754 public static synchronized PluginList getPluginList() { 1755 return new PluginList(); 1756 } 1757 1758 /** 1759 * @deprecated This was used for Gears, which has been deprecated. 1760 * @hide 1761 */ 1762 @Deprecated 1763 public void refreshPlugins(boolean reloadOpenPages) { 1764 checkThread(); 1765 } 1766 1767 /** 1768 * Puts this WebView into text selection mode. Do not rely on this 1769 * functionality; it will be deprecated in the future. 1770 * 1771 * @deprecated This method is now obsolete. 1772 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 1773 */ 1774 @Deprecated 1775 public void emulateShiftHeld() { 1776 checkThread(); 1777 } 1778 1779 /** 1780 * @deprecated WebView no longer needs to implement 1781 * ViewGroup.OnHierarchyChangeListener. This method does nothing now. 1782 */ 1783 @Override 1784 // Cannot add @hide as this can always be accessed via the interface. 1785 @Deprecated 1786 public void onChildViewAdded(View parent, View child) {} 1787 1788 /** 1789 * @deprecated WebView no longer needs to implement 1790 * ViewGroup.OnHierarchyChangeListener. This method does nothing now. 1791 */ 1792 @Override 1793 // Cannot add @hide as this can always be accessed via the interface. 1794 @Deprecated 1795 public void onChildViewRemoved(View p, View child) {} 1796 1797 /** 1798 * @deprecated WebView should not have implemented 1799 * ViewTreeObserver.OnGlobalFocusChangeListener. This method does nothing now. 1800 */ 1801 @Override 1802 // Cannot add @hide as this can always be accessed via the interface. 1803 @Deprecated 1804 public void onGlobalFocusChanged(View oldFocus, View newFocus) { 1805 } 1806 1807 /** 1808 * @deprecated Only the default case, true, will be supported in a future version. 1809 */ 1810 @Deprecated 1811 public void setMapTrackballToArrowKeys(boolean setMap) { 1812 checkThread(); 1813 mProvider.setMapTrackballToArrowKeys(setMap); 1814 } 1815 1816 1817 public void flingScroll(int vx, int vy) { 1818 checkThread(); 1819 if (DebugFlags.TRACE_API) Log.d(LOGTAG, "flingScroll"); 1820 mProvider.flingScroll(vx, vy); 1821 } 1822 1823 /** 1824 * Gets the zoom controls for this WebView, as a separate View. The caller 1825 * is responsible for inserting this View into the layout hierarchy. 1826 * <p/> 1827 * API level {@link android.os.Build.VERSION_CODES#CUPCAKE} introduced 1828 * built-in zoom mechanisms for the WebView, as opposed to these separate 1829 * zoom controls. The built-in mechanisms are preferred and can be enabled 1830 * using {@link WebSettings#setBuiltInZoomControls}. 1831 * 1832 * @deprecated the built-in zoom mechanisms are preferred 1833 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN} 1834 */ 1835 @Deprecated 1836 public View getZoomControls() { 1837 checkThread(); 1838 return mProvider.getZoomControls(); 1839 } 1840 1841 /** 1842 * Gets whether this WebView can be zoomed in. 1843 * 1844 * @return true if this WebView can be zoomed in 1845 * 1846 * @deprecated This method is prone to inaccuracy due to race conditions 1847 * between the web rendering and UI threads; prefer 1848 * {@link WebViewClient#onScaleChanged}. 1849 */ 1850 @Deprecated 1851 public boolean canZoomIn() { 1852 checkThread(); 1853 return mProvider.canZoomIn(); 1854 } 1855 1856 /** 1857 * Gets whether this WebView can be zoomed out. 1858 * 1859 * @return true if this WebView can be zoomed out 1860 * 1861 * @deprecated This method is prone to inaccuracy due to race conditions 1862 * between the web rendering and UI threads; prefer 1863 * {@link WebViewClient#onScaleChanged}. 1864 */ 1865 @Deprecated 1866 public boolean canZoomOut() { 1867 checkThread(); 1868 return mProvider.canZoomOut(); 1869 } 1870 1871 /** 1872 * Performs zoom in in this WebView. 1873 * 1874 * @return true if zoom in succeeds, false if no zoom changes 1875 */ 1876 public boolean zoomIn() { 1877 checkThread(); 1878 return mProvider.zoomIn(); 1879 } 1880 1881 /** 1882 * Performs zoom out in this WebView. 1883 * 1884 * @return true if zoom out succeeds, false if no zoom changes 1885 */ 1886 public boolean zoomOut() { 1887 checkThread(); 1888 return mProvider.zoomOut(); 1889 } 1890 1891 /** 1892 * @deprecated This method is now obsolete. 1893 * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 1894 */ 1895 @Deprecated 1896 public void debugDump() { 1897 checkThread(); 1898 } 1899 1900 /** 1901 * See {@link ViewDebug.HierarchyHandler#dumpViewHierarchyWithProperties(BufferedWriter, int)} 1902 * @hide 1903 */ 1904 @Override 1905 public void dumpViewHierarchyWithProperties(BufferedWriter out, int level) { 1906 mProvider.dumpViewHierarchyWithProperties(out, level); 1907 } 1908 1909 /** 1910 * See {@link ViewDebug.HierarchyHandler#findHierarchyView(String, int)} 1911 * @hide 1912 */ 1913 @Override 1914 public View findHierarchyView(String className, int hashCode) { 1915 return mProvider.findHierarchyView(className, hashCode); 1916 } 1917 1918 //------------------------------------------------------------------------- 1919 // Interface for WebView providers 1920 //------------------------------------------------------------------------- 1921 1922 /** 1923 * Gets the WebViewProvider. Used by providers to obtain the underlying 1924 * implementation, e.g. when the appliction responds to 1925 * WebViewClient.onCreateWindow() request. 1926 * 1927 * @hide WebViewProvider is not public API. 1928 */ 1929 public WebViewProvider getWebViewProvider() { 1930 return mProvider; 1931 } 1932 1933 /** 1934 * Callback interface, allows the provider implementation to access non-public methods 1935 * and fields, and make super-class calls in this WebView instance. 1936 * @hide Only for use by WebViewProvider implementations 1937 */ 1938 public class PrivateAccess { 1939 // ---- Access to super-class methods ---- 1940 public int super_getScrollBarStyle() { 1941 return WebView.super.getScrollBarStyle(); 1942 } 1943 1944 public void super_scrollTo(int scrollX, int scrollY) { 1945 WebView.super.scrollTo(scrollX, scrollY); 1946 } 1947 1948 public void super_computeScroll() { 1949 WebView.super.computeScroll(); 1950 } 1951 1952 public boolean super_onHoverEvent(MotionEvent event) { 1953 return WebView.super.onHoverEvent(event); 1954 } 1955 1956 public boolean super_performAccessibilityAction(int action, Bundle arguments) { 1957 return WebView.super.performAccessibilityAction(action, arguments); 1958 } 1959 1960 public boolean super_performLongClick() { 1961 return WebView.super.performLongClick(); 1962 } 1963 1964 public boolean super_setFrame(int left, int top, int right, int bottom) { 1965 return WebView.super.setFrame(left, top, right, bottom); 1966 } 1967 1968 public boolean super_dispatchKeyEvent(KeyEvent event) { 1969 return WebView.super.dispatchKeyEvent(event); 1970 } 1971 1972 public boolean super_onGenericMotionEvent(MotionEvent event) { 1973 return WebView.super.onGenericMotionEvent(event); 1974 } 1975 1976 public boolean super_requestFocus(int direction, Rect previouslyFocusedRect) { 1977 return WebView.super.requestFocus(direction, previouslyFocusedRect); 1978 } 1979 1980 public void super_setLayoutParams(ViewGroup.LayoutParams params) { 1981 WebView.super.setLayoutParams(params); 1982 } 1983 1984 // ---- Access to non-public methods ---- 1985 public void overScrollBy(int deltaX, int deltaY, 1986 int scrollX, int scrollY, 1987 int scrollRangeX, int scrollRangeY, 1988 int maxOverScrollX, int maxOverScrollY, 1989 boolean isTouchEvent) { 1990 WebView.this.overScrollBy(deltaX, deltaY, scrollX, scrollY, scrollRangeX, scrollRangeY, 1991 maxOverScrollX, maxOverScrollY, isTouchEvent); 1992 } 1993 1994 public void awakenScrollBars(int duration) { 1995 WebView.this.awakenScrollBars(duration); 1996 } 1997 1998 public void awakenScrollBars(int duration, boolean invalidate) { 1999 WebView.this.awakenScrollBars(duration, invalidate); 2000 } 2001 2002 public float getVerticalScrollFactor() { 2003 return WebView.this.getVerticalScrollFactor(); 2004 } 2005 2006 public float getHorizontalScrollFactor() { 2007 return WebView.this.getHorizontalScrollFactor(); 2008 } 2009 2010 public void setMeasuredDimension(int measuredWidth, int measuredHeight) { 2011 WebView.this.setMeasuredDimension(measuredWidth, measuredHeight); 2012 } 2013 2014 public void onScrollChanged(int l, int t, int oldl, int oldt) { 2015 WebView.this.onScrollChanged(l, t, oldl, oldt); 2016 } 2017 2018 public int getHorizontalScrollbarHeight() { 2019 return WebView.this.getHorizontalScrollbarHeight(); 2020 } 2021 2022 public void super_onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 2023 int l, int t, int r, int b) { 2024 WebView.super.onDrawVerticalScrollBar(canvas, scrollBar, l, t, r, b); 2025 } 2026 2027 // ---- Access to (non-public) fields ---- 2028 /** Raw setter for the scroll X value, without invoking onScrollChanged handlers etc. */ 2029 public void setScrollXRaw(int scrollX) { 2030 WebView.this.mScrollX = scrollX; 2031 } 2032 2033 /** Raw setter for the scroll Y value, without invoking onScrollChanged handlers etc. */ 2034 public void setScrollYRaw(int scrollY) { 2035 WebView.this.mScrollY = scrollY; 2036 } 2037 2038 } 2039 2040 //------------------------------------------------------------------------- 2041 // Package-private internal stuff 2042 //------------------------------------------------------------------------- 2043 2044 // Only used by android.webkit.FindActionModeCallback. 2045 void setFindDialogFindListener(FindListener listener) { 2046 checkThread(); 2047 setupFindListenerIfNeeded(); 2048 mFindListener.mFindDialogFindListener = listener; 2049 } 2050 2051 // Only used by android.webkit.FindActionModeCallback. 2052 void notifyFindDialogDismissed() { 2053 checkThread(); 2054 mProvider.notifyFindDialogDismissed(); 2055 } 2056 2057 //------------------------------------------------------------------------- 2058 // Private internal stuff 2059 //------------------------------------------------------------------------- 2060 2061 private WebViewProvider mProvider; 2062 2063 /** 2064 * In addition to the FindListener that the user may set via the WebView.setFindListener 2065 * API, FindActionModeCallback will register it's own FindListener. We keep them separate 2066 * via this class so that that the two FindListeners can potentially exist at once. 2067 */ 2068 private class FindListenerDistributor implements FindListener { 2069 private FindListener mFindDialogFindListener; 2070 private FindListener mUserFindListener; 2071 2072 @Override 2073 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, 2074 boolean isDoneCounting) { 2075 if (mFindDialogFindListener != null) { 2076 mFindDialogFindListener.onFindResultReceived(activeMatchOrdinal, numberOfMatches, 2077 isDoneCounting); 2078 } 2079 2080 if (mUserFindListener != null) { 2081 mUserFindListener.onFindResultReceived(activeMatchOrdinal, numberOfMatches, 2082 isDoneCounting); 2083 } 2084 } 2085 } 2086 private FindListenerDistributor mFindListener; 2087 2088 private void setupFindListenerIfNeeded() { 2089 if (mFindListener == null) { 2090 mFindListener = new FindListenerDistributor(); 2091 mProvider.setFindListener(mFindListener); 2092 } 2093 } 2094 2095 private void ensureProviderCreated() { 2096 checkThread(); 2097 if (mProvider == null) { 2098 // As this can get called during the base class constructor chain, pass the minimum 2099 // number of dependencies here; the rest are deferred to init(). 2100 mProvider = getFactory().createWebView(this, new PrivateAccess()); 2101 } 2102 } 2103 2104 private static synchronized WebViewFactoryProvider getFactory() { 2105 return WebViewFactory.getProvider(); 2106 } 2107 2108 private final Looper mWebViewThread = Looper.myLooper(); 2109 2110 private void checkThread() { 2111 // Ignore mWebViewThread == null because this can be called during in the super class 2112 // constructor, before this class's own constructor has even started. 2113 if (mWebViewThread != null && Looper.myLooper() != mWebViewThread) { 2114 Throwable throwable = new Throwable( 2115 "A WebView method was called on thread '" + 2116 Thread.currentThread().getName() + "'. " + 2117 "All WebView methods must be called on the same thread. " + 2118 "(Expected Looper " + mWebViewThread + " called on " + Looper.myLooper() + 2119 ", FYI main Looper is " + Looper.getMainLooper() + ")"); 2120 Log.w(LOGTAG, Log.getStackTraceString(throwable)); 2121 StrictMode.onWebViewMethodCalledOnWrongThread(throwable); 2122 2123 if (sEnforceThreadChecking) { 2124 throw new RuntimeException(throwable); 2125 } 2126 } 2127 } 2128 2129 //------------------------------------------------------------------------- 2130 // Override View methods 2131 //------------------------------------------------------------------------- 2132 2133 // TODO: Add a test that enumerates all methods in ViewDelegte & ScrollDelegate, and ensures 2134 // there's a corresponding override (or better, caller) for each of them in here. 2135 2136 @Override 2137 protected void onAttachedToWindow() { 2138 super.onAttachedToWindow(); 2139 mProvider.getViewDelegate().onAttachedToWindow(); 2140 } 2141 2142 /** @hide */ 2143 @Override 2144 protected void onDetachedFromWindowInternal() { 2145 mProvider.getViewDelegate().onDetachedFromWindow(); 2146 super.onDetachedFromWindowInternal(); 2147 } 2148 2149 @Override 2150 public void setLayoutParams(ViewGroup.LayoutParams params) { 2151 mProvider.getViewDelegate().setLayoutParams(params); 2152 } 2153 2154 @Override 2155 public void setOverScrollMode(int mode) { 2156 super.setOverScrollMode(mode); 2157 // This method may be called in the constructor chain, before the WebView provider is 2158 // created. 2159 ensureProviderCreated(); 2160 mProvider.getViewDelegate().setOverScrollMode(mode); 2161 } 2162 2163 @Override 2164 public void setScrollBarStyle(int style) { 2165 mProvider.getViewDelegate().setScrollBarStyle(style); 2166 super.setScrollBarStyle(style); 2167 } 2168 2169 @Override 2170 protected int computeHorizontalScrollRange() { 2171 return mProvider.getScrollDelegate().computeHorizontalScrollRange(); 2172 } 2173 2174 @Override 2175 protected int computeHorizontalScrollOffset() { 2176 return mProvider.getScrollDelegate().computeHorizontalScrollOffset(); 2177 } 2178 2179 @Override 2180 protected int computeVerticalScrollRange() { 2181 return mProvider.getScrollDelegate().computeVerticalScrollRange(); 2182 } 2183 2184 @Override 2185 protected int computeVerticalScrollOffset() { 2186 return mProvider.getScrollDelegate().computeVerticalScrollOffset(); 2187 } 2188 2189 @Override 2190 protected int computeVerticalScrollExtent() { 2191 return mProvider.getScrollDelegate().computeVerticalScrollExtent(); 2192 } 2193 2194 @Override 2195 public void computeScroll() { 2196 mProvider.getScrollDelegate().computeScroll(); 2197 } 2198 2199 @Override 2200 public boolean onHoverEvent(MotionEvent event) { 2201 return mProvider.getViewDelegate().onHoverEvent(event); 2202 } 2203 2204 @Override 2205 public boolean onTouchEvent(MotionEvent event) { 2206 return mProvider.getViewDelegate().onTouchEvent(event); 2207 } 2208 2209 @Override 2210 public boolean onGenericMotionEvent(MotionEvent event) { 2211 return mProvider.getViewDelegate().onGenericMotionEvent(event); 2212 } 2213 2214 @Override 2215 public boolean onTrackballEvent(MotionEvent event) { 2216 return mProvider.getViewDelegate().onTrackballEvent(event); 2217 } 2218 2219 @Override 2220 public boolean onKeyDown(int keyCode, KeyEvent event) { 2221 return mProvider.getViewDelegate().onKeyDown(keyCode, event); 2222 } 2223 2224 @Override 2225 public boolean onKeyUp(int keyCode, KeyEvent event) { 2226 return mProvider.getViewDelegate().onKeyUp(keyCode, event); 2227 } 2228 2229 @Override 2230 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 2231 return mProvider.getViewDelegate().onKeyMultiple(keyCode, repeatCount, event); 2232 } 2233 2234 /* 2235 TODO: These are not currently implemented in WebViewClassic, but it seems inconsistent not 2236 to be delegating them too. 2237 2238 @Override 2239 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 2240 return mProvider.getViewDelegate().onKeyPreIme(keyCode, event); 2241 } 2242 @Override 2243 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 2244 return mProvider.getViewDelegate().onKeyLongPress(keyCode, event); 2245 } 2246 @Override 2247 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 2248 return mProvider.getViewDelegate().onKeyShortcut(keyCode, event); 2249 } 2250 */ 2251 2252 @Override 2253 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 2254 AccessibilityNodeProvider provider = 2255 mProvider.getViewDelegate().getAccessibilityNodeProvider(); 2256 return provider == null ? super.getAccessibilityNodeProvider() : provider; 2257 } 2258 2259 @Deprecated 2260 @Override 2261 public boolean shouldDelayChildPressedState() { 2262 return mProvider.getViewDelegate().shouldDelayChildPressedState(); 2263 } 2264 2265 @Override 2266 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 2267 super.onInitializeAccessibilityNodeInfo(info); 2268 info.setClassName(WebView.class.getName()); 2269 mProvider.getViewDelegate().onInitializeAccessibilityNodeInfo(info); 2270 } 2271 2272 @Override 2273 public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 2274 super.onInitializeAccessibilityEvent(event); 2275 event.setClassName(WebView.class.getName()); 2276 mProvider.getViewDelegate().onInitializeAccessibilityEvent(event); 2277 } 2278 2279 @Override 2280 public boolean performAccessibilityAction(int action, Bundle arguments) { 2281 return mProvider.getViewDelegate().performAccessibilityAction(action, arguments); 2282 } 2283 2284 /** @hide */ 2285 @Override 2286 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 2287 int l, int t, int r, int b) { 2288 mProvider.getViewDelegate().onDrawVerticalScrollBar(canvas, scrollBar, l, t, r, b); 2289 } 2290 2291 @Override 2292 protected void onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY) { 2293 mProvider.getViewDelegate().onOverScrolled(scrollX, scrollY, clampedX, clampedY); 2294 } 2295 2296 @Override 2297 protected void onWindowVisibilityChanged(int visibility) { 2298 super.onWindowVisibilityChanged(visibility); 2299 mProvider.getViewDelegate().onWindowVisibilityChanged(visibility); 2300 } 2301 2302 @Override 2303 protected void onDraw(Canvas canvas) { 2304 mProvider.getViewDelegate().onDraw(canvas); 2305 } 2306 2307 @Override 2308 public boolean performLongClick() { 2309 return mProvider.getViewDelegate().performLongClick(); 2310 } 2311 2312 @Override 2313 protected void onConfigurationChanged(Configuration newConfig) { 2314 mProvider.getViewDelegate().onConfigurationChanged(newConfig); 2315 } 2316 2317 @Override 2318 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 2319 return mProvider.getViewDelegate().onCreateInputConnection(outAttrs); 2320 } 2321 2322 @Override 2323 protected void onVisibilityChanged(View changedView, int visibility) { 2324 super.onVisibilityChanged(changedView, visibility); 2325 // This method may be called in the constructor chain, before the WebView provider is 2326 // created. 2327 ensureProviderCreated(); 2328 mProvider.getViewDelegate().onVisibilityChanged(changedView, visibility); 2329 } 2330 2331 @Override 2332 public void onWindowFocusChanged(boolean hasWindowFocus) { 2333 mProvider.getViewDelegate().onWindowFocusChanged(hasWindowFocus); 2334 super.onWindowFocusChanged(hasWindowFocus); 2335 } 2336 2337 @Override 2338 protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) { 2339 mProvider.getViewDelegate().onFocusChanged(focused, direction, previouslyFocusedRect); 2340 super.onFocusChanged(focused, direction, previouslyFocusedRect); 2341 } 2342 2343 /** @hide */ 2344 @Override 2345 protected boolean setFrame(int left, int top, int right, int bottom) { 2346 return mProvider.getViewDelegate().setFrame(left, top, right, bottom); 2347 } 2348 2349 @Override 2350 protected void onSizeChanged(int w, int h, int ow, int oh) { 2351 super.onSizeChanged(w, h, ow, oh); 2352 mProvider.getViewDelegate().onSizeChanged(w, h, ow, oh); 2353 } 2354 2355 @Override 2356 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 2357 super.onScrollChanged(l, t, oldl, oldt); 2358 mProvider.getViewDelegate().onScrollChanged(l, t, oldl, oldt); 2359 } 2360 2361 @Override 2362 public boolean dispatchKeyEvent(KeyEvent event) { 2363 return mProvider.getViewDelegate().dispatchKeyEvent(event); 2364 } 2365 2366 @Override 2367 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 2368 return mProvider.getViewDelegate().requestFocus(direction, previouslyFocusedRect); 2369 } 2370 2371 @Override 2372 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 2373 super.onMeasure(widthMeasureSpec, heightMeasureSpec); 2374 mProvider.getViewDelegate().onMeasure(widthMeasureSpec, heightMeasureSpec); 2375 } 2376 2377 @Override 2378 public boolean requestChildRectangleOnScreen(View child, Rect rect, boolean immediate) { 2379 return mProvider.getViewDelegate().requestChildRectangleOnScreen(child, rect, immediate); 2380 } 2381 2382 @Override 2383 public void setBackgroundColor(int color) { 2384 mProvider.getViewDelegate().setBackgroundColor(color); 2385 } 2386 2387 @Override 2388 public void setLayerType(int layerType, Paint paint) { 2389 super.setLayerType(layerType, paint); 2390 mProvider.getViewDelegate().setLayerType(layerType, paint); 2391 } 2392 2393 @Override 2394 protected void dispatchDraw(Canvas canvas) { 2395 mProvider.getViewDelegate().preDispatchDraw(canvas); 2396 super.dispatchDraw(canvas); 2397 } 2398} 2399