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