The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.webkit; |
| 18 | |
Hui Shu | 539b077 | 2016-04-20 15:21:37 -0700 | [diff] [blame] | 19 | import android.annotation.IntDef; |
Yuncheol Heo | eeba025 | 2014-07-08 19:43:00 +0900 | [diff] [blame] | 20 | import android.annotation.SystemApi; |
George Mount | 9f410c5 | 2012-08-10 15:29:30 -0700 | [diff] [blame] | 21 | import android.content.Context; |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 22 | |
Hui Shu | 539b077 | 2016-04-20 15:21:37 -0700 | [diff] [blame] | 23 | import java.lang.annotation.ElementType; |
| 24 | import java.lang.annotation.Retention; |
| 25 | import java.lang.annotation.RetentionPolicy; |
| 26 | import java.lang.annotation.Target; |
| 27 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 28 | /** |
| 29 | * Manages settings state for a WebView. When a WebView is first created, it |
| 30 | * obtains a set of default settings. These default settings will be returned |
| 31 | * from any getter call. A WebSettings object obtained from |
| 32 | * WebView.getSettings() is tied to the life of the WebView. If a WebView has |
| 33 | * been destroyed, any method call on WebSettings will throw an |
| 34 | * IllegalStateException. |
| 35 | */ |
Jonathan Dixon | d3101b1 | 2012-04-12 20:51:51 +0100 | [diff] [blame] | 36 | // This is an abstract base class: concrete WebViewProviders must |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 37 | // create a class derived from this, and return an instance of it in the |
| 38 | // WebViewProvider.getWebSettingsProvider() method implementation. |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 39 | public abstract class WebSettings { |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 40 | /** |
| 41 | * Enum for controlling the layout of html. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 42 | * <ul> |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 43 | * <li>NORMAL means no rendering changes. This is the recommended choice for maximum |
| 44 | * compatibility across different platforms and Android versions.</li> |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 45 | * <li>SINGLE_COLUMN moves all content into one column that is the width of the |
| 46 | * view.</li> |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 47 | * <li>NARROW_COLUMNS makes all columns no wider than the screen if possible. Only use |
| 48 | * this for API levels prior to {@link android.os.Build.VERSION_CODES#KITKAT}.</li> |
Mikhail Naganov | 94e0bd3 | 2012-12-14 17:01:25 +0000 | [diff] [blame] | 49 | * <li>TEXT_AUTOSIZING boosts font size of paragraphs based on heuristics to make |
| 50 | * the text readable when viewing a wide-viewport layout in the overview mode. |
| 51 | * It is recommended to enable zoom support {@link #setSupportZoom} when |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 52 | * using this mode. Supported from API level |
| 53 | * {@link android.os.Build.VERSION_CODES#KITKAT}</li> |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 54 | * </ul> |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 55 | */ |
| 56 | // XXX: These must match LayoutAlgorithm in Settings.h in WebCore. |
| 57 | public enum LayoutAlgorithm { |
| 58 | NORMAL, |
John Reck | 5a1ef413 | 2011-10-26 10:37:00 -0700 | [diff] [blame] | 59 | /** |
| 60 | * @deprecated This algorithm is now obsolete. |
| 61 | */ |
| 62 | @Deprecated |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 63 | SINGLE_COLUMN, |
Mikhail Naganov | 94e0bd3 | 2012-12-14 17:01:25 +0000 | [diff] [blame] | 64 | /** |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 65 | * @deprecated This algorithm is now obsolete. |
Mikhail Naganov | 94e0bd3 | 2012-12-14 17:01:25 +0000 | [diff] [blame] | 66 | */ |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 67 | @Deprecated |
| 68 | NARROW_COLUMNS, |
Mikhail Naganov | 94e0bd3 | 2012-12-14 17:01:25 +0000 | [diff] [blame] | 69 | TEXT_AUTOSIZING |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Enum for specifying the text size. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 74 | * <ul> |
| 75 | * <li>SMALLEST is 50%</li> |
| 76 | * <li>SMALLER is 75%</li> |
| 77 | * <li>NORMAL is 100%</li> |
| 78 | * <li>LARGER is 150%</li> |
| 79 | * <li>LARGEST is 200%</li> |
| 80 | * </ul> |
| 81 | * |
John Reck | caeb120 | 2011-06-17 11:50:15 -0700 | [diff] [blame] | 82 | * @deprecated Use {@link WebSettings#setTextZoom(int)} and {@link WebSettings#getTextZoom()} instead. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 83 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 84 | @Deprecated |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 85 | public enum TextSize { |
| 86 | SMALLEST(50), |
| 87 | SMALLER(75), |
| 88 | NORMAL(100), |
| 89 | LARGER(150), |
| 90 | LARGEST(200); |
| 91 | TextSize(int size) { |
| 92 | value = size; |
| 93 | } |
| 94 | int value; |
| 95 | } |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 96 | |
| 97 | /** |
| 98 | * Enum for specifying the WebView's desired density. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 99 | * <ul> |
| 100 | * <li>FAR makes 100% looking like in 240dpi</li> |
| 101 | * <li>MEDIUM makes 100% looking like in 160dpi</li> |
| 102 | * <li>CLOSE makes 100% looking like in 120dpi</li> |
| 103 | * </ul> |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 104 | */ |
| 105 | public enum ZoomDensity { |
| 106 | FAR(150), // 240dpi |
| 107 | MEDIUM(100), // 160dpi |
| 108 | CLOSE(75); // 120dpi |
| 109 | ZoomDensity(int size) { |
| 110 | value = size; |
| 111 | } |
Mikhail Naganov | ce76ca5 | 2012-07-27 12:00:05 +0100 | [diff] [blame] | 112 | |
| 113 | /** |
| 114 | * @hide Only for use by WebViewProvider implementations |
| 115 | */ |
| 116 | public int getValue() { |
| 117 | return value; |
| 118 | } |
| 119 | |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 120 | int value; |
| 121 | } |
| 122 | |
Tim Volodine | b90f538 | 2016-04-29 12:44:41 +0100 | [diff] [blame] | 123 | /** @hide */ |
| 124 | @IntDef({LOAD_DEFAULT, LOAD_NORMAL, LOAD_CACHE_ELSE_NETWORK, LOAD_NO_CACHE, LOAD_CACHE_ONLY}) |
| 125 | @Retention(RetentionPolicy.SOURCE) |
| 126 | public @interface CacheMode {} |
| 127 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 128 | /** |
Mikhail Naganov | 500b003 | 2012-07-25 13:06:14 +0100 | [diff] [blame] | 129 | * Default cache usage mode. If the navigation type doesn't impose any |
| 130 | * specific behavior, use cached resources when they are available |
| 131 | * and not expired, otherwise load resources from the network. |
| 132 | * Use with {@link #setCacheMode}. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 133 | */ |
| 134 | public static final int LOAD_DEFAULT = -1; |
| 135 | |
| 136 | /** |
Mikhail Naganov | 500b003 | 2012-07-25 13:06:14 +0100 | [diff] [blame] | 137 | * Normal cache usage mode. Use with {@link #setCacheMode}. |
Mikhail Naganov | 56936a1 | 2012-07-25 13:07:18 +0100 | [diff] [blame] | 138 | * |
| 139 | * @deprecated This value is obsolete, as from API level |
| 140 | * {@link android.os.Build.VERSION_CODES#HONEYCOMB} and onwards it has the |
| 141 | * same effect as {@link #LOAD_DEFAULT}. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 142 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 143 | @Deprecated |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 144 | public static final int LOAD_NORMAL = 0; |
| 145 | |
| 146 | /** |
Mikhail Naganov | 500b003 | 2012-07-25 13:06:14 +0100 | [diff] [blame] | 147 | * Use cached resources when they are available, even if they have expired. |
| 148 | * Otherwise load resources from the network. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 149 | * Use with {@link #setCacheMode}. |
| 150 | */ |
| 151 | public static final int LOAD_CACHE_ELSE_NETWORK = 1; |
| 152 | |
| 153 | /** |
Mikhail Naganov | 500b003 | 2012-07-25 13:06:14 +0100 | [diff] [blame] | 154 | * Don't use the cache, load from the network. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 155 | * Use with {@link #setCacheMode}. |
| 156 | */ |
| 157 | public static final int LOAD_NO_CACHE = 2; |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 158 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 159 | /** |
Mikhail Naganov | 500b003 | 2012-07-25 13:06:14 +0100 | [diff] [blame] | 160 | * Don't use the network, load from the cache. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 161 | * Use with {@link #setCacheMode}. |
| 162 | */ |
| 163 | public static final int LOAD_CACHE_ONLY = 3; |
| 164 | |
| 165 | public enum RenderPriority { |
| 166 | NORMAL, |
| 167 | HIGH, |
| 168 | LOW |
| 169 | } |
| 170 | |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 171 | /** |
| 172 | * The plugin state effects how plugins are treated on a page. ON means |
| 173 | * that any object will be loaded even if a plugin does not exist to handle |
| 174 | * the content. ON_DEMAND means that if there is a plugin installed that |
| 175 | * can handle the content, a placeholder is shown until the user clicks on |
| 176 | * the placeholder. Once clicked, the plugin will be enabled on the page. |
| 177 | * OFF means that all plugins will be turned off and any fallback content |
| 178 | * will be used. |
| 179 | */ |
| 180 | public enum PluginState { |
| 181 | ON, |
| 182 | ON_DEMAND, |
| 183 | OFF |
| 184 | } |
| 185 | |
Ben Murdoch | e9e3ccd | 2010-10-06 14:33:02 +0100 | [diff] [blame] | 186 | /** |
Ben Murdoch | fe9fc3d | 2014-04-10 15:31:06 +0100 | [diff] [blame] | 187 | * Used with {@link #setMixedContentMode} |
| 188 | * |
| 189 | * In this mode, the WebView will allow a secure origin to load content from any other origin, |
| 190 | * even if that origin is insecure. This is the least secure mode of operation for the WebView, |
| 191 | * and where possible apps should not set this mode. |
| 192 | */ |
| 193 | public static final int MIXED_CONTENT_ALWAYS_ALLOW = 0; |
| 194 | |
| 195 | /** |
| 196 | * Used with {@link #setMixedContentMode} |
| 197 | * |
| 198 | * In this mode, the WebView will not allow a secure origin to load content from an insecure |
| 199 | * origin. This is the preferred and most secure mode of operation for the WebView and apps are |
| 200 | * strongly advised to use this mode. |
| 201 | */ |
| 202 | public static final int MIXED_CONTENT_NEVER_ALLOW = 1; |
| 203 | |
| 204 | /** |
| 205 | * Used with {@link #setMixedContentMode} |
| 206 | * |
| 207 | * In this mode, the WebView will attempt to be compatible with the approach of a modern web |
| 208 | * browser with regard to mixed content. Some insecure content may be allowed to be loaded by |
| 209 | * a secure origin and other types of content will be blocked. The types of content are allowed |
| 210 | * or blocked may change release to release and are not explicitly defined. |
| 211 | * |
| 212 | * This mode is intended to be used by apps that are not in control of the content that they |
| 213 | * render but desire to operate in a reasonably secure environment. For highest security, apps |
| 214 | * are recommended to use {@link #MIXED_CONTENT_NEVER_ALLOW}. |
| 215 | */ |
| 216 | public static final int MIXED_CONTENT_COMPATIBILITY_MODE = 2; |
| 217 | |
| 218 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 219 | * Enables dumping the pages navigation cache to a text file. The default |
| 220 | * is false. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 221 | * |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 222 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 223 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 224 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 225 | @SystemApi |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 226 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 227 | public abstract void setNavDump(boolean enabled); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 228 | |
| 229 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 230 | * Gets whether dumping the navigation cache is enabled. |
| 231 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 232 | * @return whether dumping the navigation cache is enabled |
| 233 | * @see #setNavDump |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 234 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 235 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 236 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 237 | @SystemApi |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 238 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 239 | public abstract boolean getNavDump(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 240 | |
| 241 | /** |
Mikhail Naganov | b533fb4 | 2012-04-05 14:50:02 +0100 | [diff] [blame] | 242 | * Sets whether the WebView should support zooming using its on-screen zoom |
| 243 | * controls and gestures. The particular zoom mechanisms that should be used |
| 244 | * can be set with {@link #setBuiltInZoomControls}. This setting does not |
| 245 | * affect zooming performed using the {@link WebView#zoomIn()} and |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 246 | * {@link WebView#zoomOut()} methods. The default is true. |
| 247 | * |
| 248 | * @param support whether the WebView should support zoom |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 249 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 250 | public abstract void setSupportZoom(boolean support); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 251 | |
| 252 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 253 | * Gets whether the WebView supports zoom. |
| 254 | * |
| 255 | * @return true if the WebView supports zoom |
| 256 | * @see #setSupportZoom |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 257 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 258 | public abstract boolean supportZoom(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 259 | |
| 260 | /** |
Teng-Hui Zhu | 0e5b160 | 2012-07-17 17:19:13 -0700 | [diff] [blame] | 261 | * Sets whether the WebView requires a user gesture to play media. |
| 262 | * The default is true. |
| 263 | * |
| 264 | * @param require whether the WebView requires a user gesture to play media |
| 265 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 266 | public abstract void setMediaPlaybackRequiresUserGesture(boolean require); |
Teng-Hui Zhu | 0e5b160 | 2012-07-17 17:19:13 -0700 | [diff] [blame] | 267 | |
| 268 | /** |
| 269 | * Gets whether the WebView requires a user gesture to play media. |
| 270 | * |
| 271 | * @return true if the WebView requires a user gesture to play media |
| 272 | * @see #setMediaPlaybackRequiresUserGesture |
| 273 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 274 | public abstract boolean getMediaPlaybackRequiresUserGesture(); |
Teng-Hui Zhu | 0e5b160 | 2012-07-17 17:19:13 -0700 | [diff] [blame] | 275 | |
| 276 | /** |
Steve Block | 06d268e | 2012-04-16 14:10:54 +0100 | [diff] [blame] | 277 | * Sets whether the WebView should use its built-in zoom mechanisms. The |
| 278 | * built-in zoom mechanisms comprise on-screen zoom controls, which are |
| 279 | * displayed over the WebView's content, and the use of a pinch gesture to |
| 280 | * control zooming. Whether or not these on-screen controls are displayed |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 281 | * can be set with {@link #setDisplayZoomControls}. The default is false. |
Steve Block | 06d268e | 2012-04-16 14:10:54 +0100 | [diff] [blame] | 282 | * <p> |
| 283 | * The built-in mechanisms are the only currently supported zoom |
| 284 | * mechanisms, so it is recommended that this setting is always enabled. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 285 | * |
| 286 | * @param enabled whether the WebView should use its built-in zoom mechanisms |
The Android Open Source Project | 1059253 | 2009-03-18 17:39:46 -0700 | [diff] [blame] | 287 | */ |
Steve Block | 06d268e | 2012-04-16 14:10:54 +0100 | [diff] [blame] | 288 | // This method was intended to select between the built-in zoom mechanisms |
| 289 | // and the separate zoom controls. The latter were obtained using |
| 290 | // {@link WebView#getZoomControls}, which is now hidden. |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 291 | public abstract void setBuiltInZoomControls(boolean enabled); |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 292 | |
The Android Open Source Project | 1059253 | 2009-03-18 17:39:46 -0700 | [diff] [blame] | 293 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 294 | * Gets whether the zoom mechanisms built into WebView are being used. |
| 295 | * |
| 296 | * @return true if the zoom mechanisms built into WebView are being used |
| 297 | * @see #setBuiltInZoomControls |
The Android Open Source Project | 1059253 | 2009-03-18 17:39:46 -0700 | [diff] [blame] | 298 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 299 | public abstract boolean getBuiltInZoomControls(); |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 300 | |
The Android Open Source Project | 1059253 | 2009-03-18 17:39:46 -0700 | [diff] [blame] | 301 | /** |
Mikhail Naganov | b533fb4 | 2012-04-05 14:50:02 +0100 | [diff] [blame] | 302 | * Sets whether the WebView should display on-screen zoom controls when |
| 303 | * using the built-in zoom mechanisms. See {@link #setBuiltInZoomControls}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 304 | * The default is true. |
| 305 | * |
| 306 | * @param enabled whether the WebView should display on-screen zoom controls |
Michael Kolb | 6fe3b42 | 2010-08-19 12:41:24 -0700 | [diff] [blame] | 307 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 308 | public abstract void setDisplayZoomControls(boolean enabled); |
Michael Kolb | 6fe3b42 | 2010-08-19 12:41:24 -0700 | [diff] [blame] | 309 | |
| 310 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 311 | * Gets whether the WebView displays on-screen zoom controls when using |
Mikhail Naganov | b533fb4 | 2012-04-05 14:50:02 +0100 | [diff] [blame] | 312 | * the built-in zoom mechanisms. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 313 | * |
| 314 | * @return true if the WebView displays on-screen zoom controls when using |
| 315 | * the built-in zoom mechanisms |
| 316 | * @see #setDisplayZoomControls |
Michael Kolb | 6fe3b42 | 2010-08-19 12:41:24 -0700 | [diff] [blame] | 317 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 318 | public abstract boolean getDisplayZoomControls(); |
Michael Kolb | 6fe3b42 | 2010-08-19 12:41:24 -0700 | [diff] [blame] | 319 | |
| 320 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 321 | * Enables or disables file access within WebView. File access is enabled by |
Patrick Scott | d1737ed | 2011-01-05 11:36:48 -0500 | [diff] [blame] | 322 | * default. Note that this enables or disables file system access only. |
| 323 | * Assets and resources are still accessible using file:///android_asset and |
| 324 | * file:///android_res. |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 325 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 326 | public abstract void setAllowFileAccess(boolean allow); |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 327 | |
| 328 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 329 | * Gets whether this WebView supports file access. |
| 330 | * |
| 331 | * @see #setAllowFileAccess |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 332 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 333 | public abstract boolean getAllowFileAccess(); |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 334 | |
| 335 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 336 | * Enables or disables content URL access within WebView. Content URL |
| 337 | * access allows WebView to load content from a content provider installed |
| 338 | * in the system. The default is enabled. |
Patrick Scott | d1737ed | 2011-01-05 11:36:48 -0500 | [diff] [blame] | 339 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 340 | public abstract void setAllowContentAccess(boolean allow); |
Patrick Scott | d1737ed | 2011-01-05 11:36:48 -0500 | [diff] [blame] | 341 | |
| 342 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 343 | * Gets whether this WebView supports content URL access. |
| 344 | * |
| 345 | * @see #setAllowContentAccess |
Patrick Scott | d1737ed | 2011-01-05 11:36:48 -0500 | [diff] [blame] | 346 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 347 | public abstract boolean getAllowContentAccess(); |
Patrick Scott | d1737ed | 2011-01-05 11:36:48 -0500 | [diff] [blame] | 348 | |
| 349 | /** |
Mikhail Naganov | 0030336 | 2013-09-02 10:57:04 +0100 | [diff] [blame] | 350 | * Sets whether the WebView loads pages in overview mode, that is, |
| 351 | * zooms out the content to fit on screen by width. This setting is |
| 352 | * taken into account when the content width is greater than the width |
| 353 | * of the WebView control, for example, when {@link #getUseWideViewPort} |
| 354 | * is enabled. The default is false. |
Grace Kloba | e397a88 | 2009-08-06 12:04:14 -0700 | [diff] [blame] | 355 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 356 | public abstract void setLoadWithOverviewMode(boolean overview); |
Grace Kloba | e397a88 | 2009-08-06 12:04:14 -0700 | [diff] [blame] | 357 | |
| 358 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 359 | * Gets whether this WebView loads pages in overview mode. |
| 360 | * |
| 361 | * @return whether this WebView loads pages in overview mode |
| 362 | * @see #setLoadWithOverviewMode |
Grace Kloba | e397a88 | 2009-08-06 12:04:14 -0700 | [diff] [blame] | 363 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 364 | public abstract boolean getLoadWithOverviewMode(); |
Grace Kloba | e397a88 | 2009-08-06 12:04:14 -0700 | [diff] [blame] | 365 | |
| 366 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 367 | * Sets whether the WebView will enable smooth transition while panning or |
Adam Powell | e00e8a78 | 2011-09-11 17:48:42 -0700 | [diff] [blame] | 368 | * zooming or while the window hosting the WebView does not have focus. |
| 369 | * If it is true, WebView will choose a solution to maximize the performance. |
| 370 | * e.g. the WebView's content may not be updated during the transition. |
| 371 | * If it is false, WebView will keep its fidelity. The default value is false. |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 372 | * |
| 373 | * @deprecated This method is now obsolete, and will become a no-op in future. |
Grace Kloba | f9b731d | 2010-06-21 19:23:57 -0700 | [diff] [blame] | 374 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 375 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 376 | public abstract void setEnableSmoothTransition(boolean enable); |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 377 | |
Grace Kloba | f9b731d | 2010-06-21 19:23:57 -0700 | [diff] [blame] | 378 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 379 | * Gets whether the WebView enables smooth transition while panning or |
Grace Kloba | f9b731d | 2010-06-21 19:23:57 -0700 | [diff] [blame] | 380 | * zooming. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 381 | * |
| 382 | * @see #setEnableSmoothTransition |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 383 | * |
| 384 | * @deprecated This method is now obsolete, and will become a no-op in future. |
Grace Kloba | f9b731d | 2010-06-21 19:23:57 -0700 | [diff] [blame] | 385 | */ |
Kristian Monsen | 5cc2351 | 2012-08-09 15:33:08 -0400 | [diff] [blame] | 386 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 387 | public abstract boolean enableSmoothTransition(); |
Grace Kloba | f9b731d | 2010-06-21 19:23:57 -0700 | [diff] [blame] | 388 | |
| 389 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 390 | * Sets whether the WebView uses its background for over scroll background. |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 391 | * If true, it will use the WebView's background. If false, it will use an |
| 392 | * internal pattern. Default is true. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 393 | * |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 394 | * @deprecated This method is now obsolete. |
Kristian Monsen | d0b90d3 | 2012-09-24 12:30:45 -0400 | [diff] [blame] | 395 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 396 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 397 | @SystemApi |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 398 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 399 | public abstract void setUseWebViewBackgroundForOverscrollBackground(boolean view); |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 400 | |
| 401 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 402 | * Gets whether this WebView uses WebView's background instead of |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 403 | * internal pattern for over scroll background. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 404 | * |
| 405 | * @see #setUseWebViewBackgroundForOverscrollBackground |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 406 | * @deprecated This method is now obsolete. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 407 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 408 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 409 | @SystemApi |
Kristian Monsen | fc77165 | 2011-05-10 16:44:05 +0100 | [diff] [blame] | 410 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 411 | public abstract boolean getUseWebViewBackgroundForOverscrollBackground(); |
Adam Powell | 637d337 | 2010-08-25 14:37:03 -0700 | [diff] [blame] | 412 | |
| 413 | /** |
Selim Gurun | 13e5b0b | 2017-04-03 14:29:14 -0700 | [diff] [blame] | 414 | * Sets whether the WebView should save form data. In Android O, the |
| 415 | * platform has implemented a fully functional Autofill feature to store |
| 416 | * form data. Therefore, the Webview form data save feature is disabled. |
| 417 | * |
| 418 | * Note that the feature will continue to be supported on older versions of |
| 419 | * Android as before. |
| 420 | * |
| 421 | * This function does not have any effect. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 422 | */ |
Selim Gurun | 13e5b0b | 2017-04-03 14:29:14 -0700 | [diff] [blame] | 423 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 424 | public abstract void setSaveFormData(boolean save); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 425 | |
| 426 | /** |
Selim Gurun | 5c11ef1 | 2013-01-04 14:58:36 -0800 | [diff] [blame] | 427 | * Gets whether the WebView saves form data. |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 428 | * |
| 429 | * @return whether the WebView saves form data |
| 430 | * @see #setSaveFormData |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 431 | */ |
Selim Gurun | 13e5b0b | 2017-04-03 14:29:14 -0700 | [diff] [blame] | 432 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 433 | public abstract boolean getSaveFormData(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 434 | |
| 435 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 436 | * Sets whether the WebView should save passwords. The default is true. |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 437 | * @deprecated Saving passwords in WebView will not be supported in future versions. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 438 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 439 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 440 | public abstract void setSavePassword(boolean save); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 441 | |
| 442 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 443 | * Gets whether the WebView saves passwords. |
| 444 | * |
| 445 | * @return whether the WebView saves passwords |
| 446 | * @see #setSavePassword |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 447 | * @deprecated Saving passwords in WebView will not be supported in future versions. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 448 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 449 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 450 | public abstract boolean getSavePassword(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 451 | |
| 452 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 453 | * Sets the text zoom of the page in percent. The default is 100. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 454 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 455 | * @param textZoom the text zoom in percent |
John Reck | ff56bcd | 2011-06-16 17:12:08 -0700 | [diff] [blame] | 456 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 457 | public abstract void setTextZoom(int textZoom); |
John Reck | ff56bcd | 2011-06-16 17:12:08 -0700 | [diff] [blame] | 458 | |
| 459 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 460 | * Gets the text zoom of the page in percent. |
| 461 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 462 | * @return the text zoom of the page in percent |
Mikhail Naganov | 1202d66 | 2012-08-07 18:26:52 +0100 | [diff] [blame] | 463 | * @see #setTextZoom |
John Reck | ff56bcd | 2011-06-16 17:12:08 -0700 | [diff] [blame] | 464 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 465 | public abstract int getTextZoom(); |
John Reck | ff56bcd | 2011-06-16 17:12:08 -0700 | [diff] [blame] | 466 | |
| 467 | /** |
Hector Dearman | fc9a27a | 2014-06-05 13:45:28 +0100 | [diff] [blame] | 468 | * Sets policy for third party cookies. |
| 469 | * Developers should access this via {@link CookieManager#setShouldAcceptThirdPartyCookies}. |
| 470 | * @hide Internal API. |
| 471 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 472 | @SystemApi |
| 473 | public abstract void setAcceptThirdPartyCookies(boolean accept); |
Hector Dearman | fc9a27a | 2014-06-05 13:45:28 +0100 | [diff] [blame] | 474 | |
| 475 | /** |
| 476 | * Gets policy for third party cookies. |
| 477 | * Developers should access this via {@link CookieManager#getShouldAcceptThirdPartyCookies}. |
| 478 | * @hide Internal API |
| 479 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 480 | @SystemApi |
| 481 | public abstract boolean getAcceptThirdPartyCookies(); |
Hector Dearman | fc9a27a | 2014-06-05 13:45:28 +0100 | [diff] [blame] | 482 | |
| 483 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 484 | * Sets the text size of the page. The default is {@link TextSize#NORMAL}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 485 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 486 | * @param t the text size as a {@link TextSize} value |
| 487 | * @deprecated Use {@link #setTextZoom} instead. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 488 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 489 | @Deprecated |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 490 | public synchronized void setTextSize(TextSize t) { |
Mikhail Naganov | 1202d66 | 2012-08-07 18:26:52 +0100 | [diff] [blame] | 491 | setTextZoom(t.value); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 492 | } |
| 493 | |
| 494 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 495 | * Gets the text size of the page. If the text size was previously specified |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 496 | * in percent using {@link #setTextZoom}, this will return the closest |
| 497 | * matching {@link TextSize}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 498 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 499 | * @return the text size as a {@link TextSize} value |
| 500 | * @see #setTextSize |
| 501 | * @deprecated Use {@link #getTextZoom} instead. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 502 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 503 | @Deprecated |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 504 | public synchronized TextSize getTextSize() { |
Mikhail Naganov | 1202d66 | 2012-08-07 18:26:52 +0100 | [diff] [blame] | 505 | TextSize closestSize = null; |
| 506 | int smallestDelta = Integer.MAX_VALUE; |
| 507 | int textSize = getTextZoom(); |
| 508 | for (TextSize size : TextSize.values()) { |
| 509 | int delta = Math.abs(textSize - size.value); |
| 510 | if (delta == 0) { |
| 511 | return size; |
| 512 | } |
| 513 | if (delta < smallestDelta) { |
| 514 | smallestDelta = delta; |
| 515 | closestSize = size; |
| 516 | } |
| 517 | } |
| 518 | return closestSize != null ? closestSize : TextSize.NORMAL; |
Mangesh Ghiware | edb528e | 2011-10-12 14:25:41 -0700 | [diff] [blame] | 519 | } |
| 520 | |
| 521 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 522 | * Sets the default zoom density of the page. This must be called from the UI |
| 523 | * thread. The default is {@link ZoomDensity#MEDIUM}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 524 | * |
Mikhail Naganov | 8887b2b | 2013-05-28 10:34:43 +0100 | [diff] [blame] | 525 | * This setting is not recommended for use in new applications. If the WebView |
| 526 | * is utilized to display mobile-oriented pages, the desired effect can be achieved by |
| 527 | * adjusting 'width' and 'initial-scale' attributes of page's 'meta viewport' |
| 528 | * tag. For pages lacking the tag, {@link android.webkit.WebView#setInitialScale} |
| 529 | * and {@link #setUseWideViewPort} can be used. |
| 530 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 531 | * @param zoom the zoom density |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 532 | * @deprecated This method is no longer supported, see the function documentation for |
| 533 | * recommended alternatives. |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 534 | */ |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 535 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 536 | public abstract void setDefaultZoom(ZoomDensity zoom); |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 537 | |
| 538 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 539 | * Gets the default zoom density of the page. This should be called from |
| 540 | * the UI thread. |
| 541 | * |
Mikhail Naganov | 8887b2b | 2013-05-28 10:34:43 +0100 | [diff] [blame] | 542 | * This setting is not recommended for use in new applications. |
| 543 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 544 | * @return the zoom density |
| 545 | * @see #setDefaultZoom |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 546 | * @deprecated Will only return the default value. |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 547 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 548 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 549 | public abstract ZoomDensity getDefaultZoom(); |
Grace Kloba | 0d8b77c | 2009-06-25 11:20:51 -0700 | [diff] [blame] | 550 | |
| 551 | /** |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 552 | * Enables using light touches to make a selection and activate mouseovers. |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 553 | * @deprecated From {@link android.os.Build.VERSION_CODES#JELLY_BEAN} this |
| 554 | * setting is obsolete and has no effect. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 555 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 556 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 557 | public abstract void setLightTouchEnabled(boolean enabled); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 558 | |
| 559 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 560 | * Gets whether light touches are enabled. |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 561 | * @see #setLightTouchEnabled |
Jonathan Dixon | 98fac17 | 2013-02-28 15:32:10 -0800 | [diff] [blame] | 562 | * @deprecated This setting is obsolete. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 563 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 564 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 565 | public abstract boolean getLightTouchEnabled(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 566 | |
| 567 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 568 | * Controlled a rendering optimization that is no longer present. Setting |
| 569 | * it now has no effect. |
| 570 | * |
| 571 | * @deprecated This setting now has no effect. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 572 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 573 | */ |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 574 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 575 | public void setUseDoubleTree(boolean use) { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 576 | // Specified to do nothing, so no need for derived classes to override. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 577 | } |
| 578 | |
| 579 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 580 | * Controlled a rendering optimization that is no longer present. Setting |
| 581 | * it now has no effect. |
| 582 | * |
| 583 | * @deprecated This setting now has no effect. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 584 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 585 | */ |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 586 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 587 | public boolean getUseDoubleTree() { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 588 | // Returns false unconditionally, so no need for derived classes to override. |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 589 | return false; |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 590 | } |
| 591 | |
| 592 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 593 | * Sets the user-agent string using an integer code. |
| 594 | * <ul> |
| 595 | * <li>0 means the WebView should use an Android user-agent string</li> |
| 596 | * <li>1 means the WebView should use a desktop user-agent string</li> |
| 597 | * </ul> |
| 598 | * Other values are ignored. The default is an Android user-agent string, |
| 599 | * i.e. code value 0. |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 600 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 601 | * @param ua the integer code for the user-agent string |
| 602 | * @deprecated Please use {@link #setUserAgentString} instead. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 603 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 604 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 605 | @SystemApi |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 606 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 607 | public abstract void setUserAgent(int ua); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 608 | |
| 609 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 610 | * Gets the user-agent as an integer code. |
| 611 | * <ul> |
| 612 | * <li>-1 means the WebView is using a custom user-agent string set with |
| 613 | * {@link #setUserAgentString}</li> |
| 614 | * <li>0 means the WebView should use an Android user-agent string</li> |
| 615 | * <li>1 means the WebView should use a desktop user-agent string</li> |
| 616 | * </ul> |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 617 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 618 | * @return the integer code for the user-agent string |
| 619 | * @see #setUserAgent |
| 620 | * @deprecated Please use {@link #getUserAgentString} instead. |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 621 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 622 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 623 | @SystemApi |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 624 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 625 | public abstract int getUserAgent(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 626 | |
| 627 | /** |
Mikhail Naganov | cb000a6 | 2013-01-04 18:02:54 +0000 | [diff] [blame] | 628 | * Sets whether the WebView should enable support for the "viewport" |
| 629 | * HTML meta tag or should use a wide viewport. |
| 630 | * When the value of the setting is false, the layout width is always set to the |
| 631 | * width of the WebView control in device-independent (CSS) pixels. |
| 632 | * When the value is true and the page contains the viewport meta tag, the value |
| 633 | * of the width specified in the tag is used. If the page does not contain the tag or |
| 634 | * does not provide a width, then a wide viewport will be used. |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 635 | * |
Mikhail Naganov | cb000a6 | 2013-01-04 18:02:54 +0000 | [diff] [blame] | 636 | * @param use whether to enable support for the viewport meta tag |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 637 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 638 | public abstract void setUseWideViewPort(boolean use); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 639 | |
| 640 | /** |
Mikhail Naganov | cb000a6 | 2013-01-04 18:02:54 +0000 | [diff] [blame] | 641 | * Gets whether the WebView supports the "viewport" |
| 642 | * HTML meta tag or will use a wide viewport. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 643 | * |
Mikhail Naganov | cb000a6 | 2013-01-04 18:02:54 +0000 | [diff] [blame] | 644 | * @return true if the WebView supports the viewport meta tag |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 645 | * @see #setUseWideViewPort |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 646 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 647 | public abstract boolean getUseWideViewPort(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 648 | |
| 649 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 650 | * Sets whether the WebView whether supports multiple windows. If set to |
| 651 | * true, {@link WebChromeClient#onCreateWindow} must be implemented by the |
| 652 | * host application. The default is false. |
| 653 | * |
| 654 | * @param support whether to suport multiple windows |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 655 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 656 | public abstract void setSupportMultipleWindows(boolean support); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 657 | |
| 658 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 659 | * Gets whether the WebView supports multiple windows. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 660 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 661 | * @return true if the WebView supports multiple windows |
| 662 | * @see #setSupportMultipleWindows |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 663 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 664 | public abstract boolean supportMultipleWindows(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 665 | |
| 666 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 667 | * Sets the underlying layout algorithm. This will cause a relayout of the |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 668 | * WebView. The default is {@link LayoutAlgorithm#NARROW_COLUMNS}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 669 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 670 | * @param l the layout algorithm to use, as a {@link LayoutAlgorithm} value |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 671 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 672 | public abstract void setLayoutAlgorithm(LayoutAlgorithm l); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 673 | |
| 674 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 675 | * Gets the current layout algorithm. |
| 676 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 677 | * @return the layout algorithm in use, as a {@link LayoutAlgorithm} value |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 678 | * @see #setLayoutAlgorithm |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 679 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 680 | public abstract LayoutAlgorithm getLayoutAlgorithm(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 681 | |
| 682 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 683 | * Sets the standard font family name. The default is "sans-serif". |
| 684 | * |
| 685 | * @param font a font family name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 686 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 687 | public abstract void setStandardFontFamily(String font); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 688 | |
| 689 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 690 | * Gets the standard font family name. |
| 691 | * |
| 692 | * @return the standard font family name as a string |
| 693 | * @see #setStandardFontFamily |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 694 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 695 | public abstract String getStandardFontFamily(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 696 | |
| 697 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 698 | * Sets the fixed font family name. The default is "monospace". |
| 699 | * |
| 700 | * @param font a font family name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 701 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 702 | public abstract void setFixedFontFamily(String font); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 703 | |
| 704 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 705 | * Gets the fixed font family name. |
| 706 | * |
| 707 | * @return the fixed font family name as a string |
| 708 | * @see #setFixedFontFamily |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 709 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 710 | public abstract String getFixedFontFamily(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 711 | |
| 712 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 713 | * Sets the sans-serif font family name. The default is "sans-serif". |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 714 | * |
| 715 | * @param font a font family name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 716 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 717 | public abstract void setSansSerifFontFamily(String font); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 718 | |
| 719 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 720 | * Gets the sans-serif font family name. |
| 721 | * |
| 722 | * @return the sans-serif font family name as a string |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 723 | * @see #setSansSerifFontFamily |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 724 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 725 | public abstract String getSansSerifFontFamily(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 726 | |
| 727 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 728 | * Sets the serif font family name. The default is "sans-serif". |
| 729 | * |
| 730 | * @param font a font family name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 731 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 732 | public abstract void setSerifFontFamily(String font); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 733 | |
| 734 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 735 | * Gets the serif font family name. The default is "serif". |
| 736 | * |
| 737 | * @return the serif font family name as a string |
| 738 | * @see #setSerifFontFamily |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 739 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 740 | public abstract String getSerifFontFamily(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 741 | |
| 742 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 743 | * Sets the cursive font family name. The default is "cursive". |
| 744 | * |
| 745 | * @param font a font family name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 746 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 747 | public abstract void setCursiveFontFamily(String font); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 748 | |
| 749 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 750 | * Gets the cursive font family name. |
| 751 | * |
| 752 | * @return the cursive font family name as a string |
| 753 | * @see #setCursiveFontFamily |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 754 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 755 | public abstract String getCursiveFontFamily(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 756 | |
| 757 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 758 | * Sets the fantasy font family name. The default is "fantasy". |
| 759 | * |
| 760 | * @param font a font family name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 761 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 762 | public abstract void setFantasyFontFamily(String font); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 763 | |
| 764 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 765 | * Gets the fantasy font family name. |
| 766 | * |
| 767 | * @return the fantasy font family name as a string |
| 768 | * @see #setFantasyFontFamily |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 769 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 770 | public abstract String getFantasyFontFamily(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 771 | |
| 772 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 773 | * Sets the minimum font size. The default is 8. |
| 774 | * |
| 775 | * @param size a non-negative integer between 1 and 72. Any number outside |
| 776 | * the specified range will be pinned. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 777 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 778 | public abstract void setMinimumFontSize(int size); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 779 | |
| 780 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 781 | * Gets the minimum font size. |
| 782 | * |
| 783 | * @return a non-negative integer between 1 and 72 |
| 784 | * @see #setMinimumFontSize |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 785 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 786 | public abstract int getMinimumFontSize(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 787 | |
| 788 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 789 | * Sets the minimum logical font size. The default is 8. |
| 790 | * |
| 791 | * @param size a non-negative integer between 1 and 72. Any number outside |
| 792 | * the specified range will be pinned. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 793 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 794 | public abstract void setMinimumLogicalFontSize(int size); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 795 | |
| 796 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 797 | * Gets the minimum logical font size. |
| 798 | * |
| 799 | * @return a non-negative integer between 1 and 72 |
| 800 | * @see #setMinimumLogicalFontSize |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 801 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 802 | public abstract int getMinimumLogicalFontSize(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 803 | |
| 804 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 805 | * Sets the default font size. The default is 16. |
| 806 | * |
| 807 | * @param size a non-negative integer between 1 and 72. Any number outside |
| 808 | * the specified range will be pinned. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 809 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 810 | public abstract void setDefaultFontSize(int size); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 811 | |
| 812 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 813 | * Gets the default font size. |
| 814 | * |
| 815 | * @return a non-negative integer between 1 and 72 |
| 816 | * @see #setDefaultFontSize |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 817 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 818 | public abstract int getDefaultFontSize(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 819 | |
| 820 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 821 | * Sets the default fixed font size. The default is 16. |
| 822 | * |
| 823 | * @param size a non-negative integer between 1 and 72. Any number outside |
| 824 | * the specified range will be pinned. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 825 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 826 | public abstract void setDefaultFixedFontSize(int size); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 827 | |
| 828 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 829 | * Gets the default fixed font size. |
| 830 | * |
| 831 | * @return a non-negative integer between 1 and 72 |
| 832 | * @see #setDefaultFixedFontSize |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 833 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 834 | public abstract int getDefaultFixedFontSize(); |
Grace Kloba | 097b1e77 | 2009-11-24 14:23:18 -0800 | [diff] [blame] | 835 | |
| 836 | /** |
Mikhail Naganov | 605a491 | 2012-02-03 16:53:10 +0000 | [diff] [blame] | 837 | * Sets whether the WebView should load image resources. Note that this method |
| 838 | * controls loading of all images, including those embedded using the data |
| 839 | * URI scheme. Use {@link #setBlockNetworkImage} to control loading only |
| 840 | * of images specified using network URI schemes. Note that if the value of this |
| 841 | * setting is changed from false to true, all images resources referenced |
| 842 | * by content currently displayed by the WebView are loaded automatically. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 843 | * The default is true. |
| 844 | * |
| 845 | * @param flag whether the WebView should load image resources |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 846 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 847 | public abstract void setLoadsImagesAutomatically(boolean flag); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 848 | |
| 849 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 850 | * Gets whether the WebView loads image resources. This includes |
| 851 | * images embedded using the data URI scheme. |
| 852 | * |
| 853 | * @return true if the WebView loads image resources |
| 854 | * @see #setLoadsImagesAutomatically |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 855 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 856 | public abstract boolean getLoadsImagesAutomatically(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 857 | |
| 858 | /** |
Mikhail Naganov | 605a491 | 2012-02-03 16:53:10 +0000 | [diff] [blame] | 859 | * Sets whether the WebView should not load image resources from the |
| 860 | * network (resources accessed via http and https URI schemes). Note |
| 861 | * that this method has no effect unless |
| 862 | * {@link #getLoadsImagesAutomatically} returns true. Also note that |
| 863 | * disabling all network loads using {@link #setBlockNetworkLoads} |
| 864 | * will also prevent network images from loading, even if this flag is set |
| 865 | * to false. When the value of this setting is changed from true to false, |
| 866 | * network images resources referenced by content currently displayed by |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 867 | * the WebView are fetched automatically. The default is false. |
| 868 | * |
| 869 | * @param flag whether the WebView should not load image resources from the |
| 870 | * network |
Patrick Scott | f43113f | 2010-02-18 09:13:12 -0500 | [diff] [blame] | 871 | * @see #setBlockNetworkLoads |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 872 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 873 | public abstract void setBlockNetworkImage(boolean flag); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 874 | |
| 875 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 876 | * Gets whether the WebView does not load image resources from the network. |
| 877 | * |
| 878 | * @return true if the WebView does not load image resources from the network |
| 879 | * @see #setBlockNetworkImage |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 880 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 881 | public abstract boolean getBlockNetworkImage(); |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 882 | |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 883 | /** |
Mikhail Naganov | 605a491 | 2012-02-03 16:53:10 +0000 | [diff] [blame] | 884 | * Sets whether the WebView should not load resources from the network. |
| 885 | * Use {@link #setBlockNetworkImage} to only avoid loading |
| 886 | * image resources. Note that if the value of this setting is |
| 887 | * changed from true to false, network resources referenced by content |
| 888 | * currently displayed by the WebView are not fetched until |
| 889 | * {@link android.webkit.WebView#reload} is called. |
| 890 | * If the application does not have the |
| 891 | * {@link android.Manifest.permission#INTERNET} permission, attempts to set |
| 892 | * a value of false will cause a {@link java.lang.SecurityException} |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 893 | * to be thrown. The default value is false if the application has the |
| 894 | * {@link android.Manifest.permission#INTERNET} permission, otherwise it is |
| 895 | * true. |
| 896 | * |
Tim Volodine | b90f538 | 2016-04-29 12:44:41 +0100 | [diff] [blame] | 897 | * @param flag true means block network loads by the WebView |
Patrick Scott | f43113f | 2010-02-18 09:13:12 -0500 | [diff] [blame] | 898 | * @see android.webkit.WebView#reload |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 899 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 900 | public abstract void setBlockNetworkLoads(boolean flag); |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 901 | |
| 902 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 903 | * Gets whether the WebView does not load any resources from the network. |
| 904 | * |
| 905 | * @return true if the WebView does not load any resources from the network |
| 906 | * @see #setBlockNetworkLoads |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 907 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 908 | public abstract boolean getBlockNetworkLoads(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 909 | |
| 910 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 911 | * Tells the WebView to enable JavaScript execution. |
| 912 | * <b>The default is false.</b> |
| 913 | * |
| 914 | * @param flag true if the WebView should execute JavaScript |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 915 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 916 | public abstract void setJavaScriptEnabled(boolean flag); |
Teng-Hui Zhu | da7378e | 2011-02-16 11:25:03 -0800 | [diff] [blame] | 917 | |
| 918 | /** |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 919 | * Sets whether JavaScript running in the context of a file scheme URL |
| 920 | * should be allowed to access content from any origin. This includes |
| 921 | * access to content from other file scheme URLs. See |
| 922 | * {@link #setAllowFileAccessFromFileURLs}. To enable the most restrictive, |
| 923 | * and therefore secure policy, this setting should be disabled. |
Mikhail Naganov | 65e7ace | 2012-08-07 13:57:42 +0100 | [diff] [blame] | 924 | * Note that this setting affects only JavaScript access to file scheme |
| 925 | * resources. Other access to such resources, for example, from image HTML |
Joe Fernandez | 22b5ba8 | 2015-04-22 17:29:12 -0700 | [diff] [blame] | 926 | * elements, is unaffected. To prevent possible violation of same domain policy |
| 927 | * on {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH} and earlier |
| 928 | * devices, you should explicitly set this value to {@code false}. |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 929 | * <p> |
| 930 | * The default value is true for API level |
| 931 | * {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1} and below, |
| 932 | * and false for API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN} |
| 933 | * and above. |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 934 | * |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 935 | * @param flag whether JavaScript running in the context of a file scheme |
| 936 | * URL should be allowed to access content from any origin |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 937 | */ |
| 938 | public abstract void setAllowUniversalAccessFromFileURLs(boolean flag); |
| 939 | |
| 940 | /** |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 941 | * Sets whether JavaScript running in the context of a file scheme URL |
| 942 | * should be allowed to access content from other file scheme URLs. To |
| 943 | * enable the most restrictive, and therefore secure policy, this setting |
| 944 | * should be disabled. Note that the value of this setting is ignored if |
| 945 | * the value of {@link #getAllowUniversalAccessFromFileURLs} is true. |
Mikhail Naganov | 65e7ace | 2012-08-07 13:57:42 +0100 | [diff] [blame] | 946 | * Note too, that this setting affects only JavaScript access to file scheme |
| 947 | * resources. Other access to such resources, for example, from image HTML |
Joe Fernandez | 22b5ba8 | 2015-04-22 17:29:12 -0700 | [diff] [blame] | 948 | * elements, is unaffected. To prevent possible violation of same domain policy |
| 949 | * on {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH} and earlier |
| 950 | * devices, you should explicitly set this value to {@code false}. |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 951 | * <p> |
| 952 | * The default value is true for API level |
| 953 | * {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1} and below, |
| 954 | * and false for API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN} |
| 955 | * and above. |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 956 | * |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 957 | * @param flag whether JavaScript running in the context of a file scheme |
| 958 | * URL should be allowed to access content from other file |
| 959 | * scheme URLs |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 960 | */ |
| 961 | public abstract void setAllowFileAccessFromFileURLs(boolean flag); |
| 962 | |
| 963 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 964 | * Sets whether the WebView should enable plugins. The default is false. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 965 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 966 | * @param flag true if plugins should be enabled |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 967 | * @deprecated This method has been deprecated in favor of |
| 968 | * {@link #setPluginState} |
Jonathan Dixon | 0bf4781 | 2013-03-07 17:20:08 -0800 | [diff] [blame] | 969 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 970 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 971 | @SystemApi |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 972 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 973 | public abstract void setPluginsEnabled(boolean flag); |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 974 | |
| 975 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 976 | * Tells the WebView to enable, disable, or have plugins on demand. On |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 977 | * demand mode means that if a plugin exists that can handle the embedded |
| 978 | * content, a placeholder icon will be shown instead of the plugin. When |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 979 | * the placeholder is clicked, the plugin will be enabled. The default is |
| 980 | * {@link PluginState#OFF}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 981 | * |
| 982 | * @param state a PluginState value |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 983 | * @deprecated Plugins will not be supported in future, and should not be used. |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 984 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 985 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 986 | public abstract void setPluginState(PluginState state); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 987 | |
| 988 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 989 | * Sets a custom path to plugins used by the WebView. This method is |
Derek Sollenberger | fdbdeb3 | 2010-08-12 11:20:13 -0400 | [diff] [blame] | 990 | * obsolete since each plugin is now loaded from its own package. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 991 | * |
| 992 | * @param pluginsPath a String path to the directory containing plugins |
Derek Sollenberger | fdbdeb3 | 2010-08-12 11:20:13 -0400 | [diff] [blame] | 993 | * @deprecated This method is no longer used as plugins are loaded from |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 994 | * their own APK via the system's package manager. |
Jonathan Dixon | 0bf4781 | 2013-03-07 17:20:08 -0800 | [diff] [blame] | 995 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 996 | */ |
Jason Chen | 9dc2e75 | 2010-09-01 19:11:14 -0700 | [diff] [blame] | 997 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 998 | public void setPluginsPath(String pluginsPath) { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 999 | // Specified to do nothing, so no need for derived classes to override. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1000 | } |
| 1001 | |
| 1002 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1003 | * Sets the path to where database storage API databases should be saved. |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1004 | * In order for the database storage API to function correctly, this method |
| 1005 | * must be called with a path to which the application can write. This |
| 1006 | * method should only be called once: repeated calls are ignored. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1007 | * |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1008 | * @param databasePath a path to the directory where databases should be |
| 1009 | * saved. |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1010 | * @deprecated Database paths are managed by the implementation and calling this method |
| 1011 | * will have no effect. |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1012 | */ |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1013 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1014 | public abstract void setDatabasePath(String databasePath); |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1015 | |
| 1016 | /** |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1017 | * Sets the path where the Geolocation databases should be saved. In order |
| 1018 | * for Geolocation permissions and cached positions to be persisted, this |
| 1019 | * method must be called with a path to which the application can write. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1020 | * |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1021 | * @param databasePath a path to the directory where databases should be |
| 1022 | * saved. |
Hui Shu | 89eb9b4 | 2016-01-07 11:32:23 -0800 | [diff] [blame] | 1023 | * @deprecated Geolocation database are managed by the implementation and calling this method |
| 1024 | * will have no effect. |
Steve Block | 9d3273f | 2009-08-21 13:16:27 +0100 | [diff] [blame] | 1025 | */ |
Hui Shu | 89eb9b4 | 2016-01-07 11:32:23 -0800 | [diff] [blame] | 1026 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1027 | public abstract void setGeolocationDatabasePath(String databasePath); |
Steve Block | 9d3273f | 2009-08-21 13:16:27 +0100 | [diff] [blame] | 1028 | |
| 1029 | /** |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1030 | * Sets whether the Application Caches API should be enabled. The default |
| 1031 | * is false. Note that in order for the Application Caches API to be |
| 1032 | * enabled, a valid database path must also be supplied to |
| 1033 | * {@link #setAppCachePath}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1034 | * |
| 1035 | * @param flag true if the WebView should enable Application Caches |
Andrei Popescu | 60a9a7d | 2009-04-17 10:43:42 +0100 | [diff] [blame] | 1036 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1037 | public abstract void setAppCacheEnabled(boolean flag); |
Andrei Popescu | 60a9a7d | 2009-04-17 10:43:42 +0100 | [diff] [blame] | 1038 | |
| 1039 | /** |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1040 | * Sets the path to the Application Caches files. In order for the |
| 1041 | * Application Caches API to be enabled, this method must be called with a |
| 1042 | * path to which the application can write. This method should only be |
| 1043 | * called once: repeated calls are ignored. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1044 | * |
| 1045 | * @param appCachePath a String path to the directory containing |
Steve Block | 72ca7a4 | 2012-06-13 22:00:30 +0100 | [diff] [blame] | 1046 | * Application Caches files. |
Jonathan Dixon | 47aaba3 | 2012-11-30 16:32:17 -0800 | [diff] [blame] | 1047 | * @see #setAppCacheEnabled |
Andrei Popescu | 60a9a7d | 2009-04-17 10:43:42 +0100 | [diff] [blame] | 1048 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1049 | public abstract void setAppCachePath(String appCachePath); |
Andrei Popescu | 60a9a7d | 2009-04-17 10:43:42 +0100 | [diff] [blame] | 1050 | |
| 1051 | /** |
Selim Gurun | b632adf | 2012-06-28 11:21:05 -0700 | [diff] [blame] | 1052 | * Sets the maximum size for the Application Cache content. The passed size |
| 1053 | * will be rounded to the nearest value that the database can support, so |
| 1054 | * this should be viewed as a guide, not a hard limit. Setting the |
| 1055 | * size to a value less than current database size does not cause the |
Selim Gurun | f27ac09 | 2012-06-28 11:21:05 -0700 | [diff] [blame] | 1056 | * database to be trimmed. The default size is {@link Long#MAX_VALUE}. |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1057 | * It is recommended to leave the maximum size set to the default value. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1058 | * |
| 1059 | * @param appCacheMaxSize the maximum size in bytes |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1060 | * @deprecated In future quota will be managed automatically. |
Andrei Popescu | 1c82920 | 2009-07-22 16:47:52 +0100 | [diff] [blame] | 1061 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1062 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1063 | public abstract void setAppCacheMaxSize(long appCacheMaxSize); |
Andrei Popescu | 1c82920 | 2009-07-22 16:47:52 +0100 | [diff] [blame] | 1064 | |
| 1065 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1066 | * Sets whether the database storage API is enabled. The default value is |
| 1067 | * false. See also {@link #setDatabasePath} for how to correctly set up the |
| 1068 | * database storage API. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1069 | * |
Selim Gurun | 2bca22b | 2013-02-28 17:47:21 -0800 | [diff] [blame] | 1070 | * This setting is global in effect, across all WebView instances in a process. |
| 1071 | * Note you should only modify this setting prior to making <b>any</b> WebView |
| 1072 | * page load within a given process, as the WebView implementation may ignore |
| 1073 | * changes to this setting after that point. |
| 1074 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1075 | * @param flag true if the WebView should use the database storage API |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1076 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1077 | public abstract void setDatabaseEnabled(boolean flag); |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1078 | |
| 1079 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1080 | * Sets whether the DOM storage API is enabled. The default value is false. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1081 | * |
| 1082 | * @param flag true if the WebView should use the DOM storage API |
Ben Murdoch | 274680d | 2009-05-28 13:44:44 +0100 | [diff] [blame] | 1083 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1084 | public abstract void setDomStorageEnabled(boolean flag); |
Ben Murdoch | 274680d | 2009-05-28 13:44:44 +0100 | [diff] [blame] | 1085 | |
| 1086 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1087 | * Gets whether the DOM Storage APIs are enabled. |
| 1088 | * |
| 1089 | * @return true if the DOM Storage APIs are enabled |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1090 | * @see #setDomStorageEnabled |
Ben Murdoch | 274680d | 2009-05-28 13:44:44 +0100 | [diff] [blame] | 1091 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1092 | public abstract boolean getDomStorageEnabled(); |
| 1093 | |
Ben Murdoch | 274680d | 2009-05-28 13:44:44 +0100 | [diff] [blame] | 1094 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1095 | * Gets the path to where database storage API databases are saved. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1096 | * |
| 1097 | * @return the String path to the database storage API databases |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1098 | * @see #setDatabasePath |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1099 | * @deprecated Database paths are managed by the implementation this method is obsolete. |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1100 | */ |
Jonathan Dixon | 5545d08 | 2013-08-31 22:43:11 -0700 | [diff] [blame] | 1101 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1102 | public abstract String getDatabasePath(); |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1103 | |
| 1104 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1105 | * Gets whether the database storage API is enabled. |
| 1106 | * |
| 1107 | * @return true if the database storage API is enabled |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1108 | * @see #setDatabaseEnabled |
Ben Murdoch | 7df1985 | 2009-04-22 13:07:58 +0100 | [diff] [blame] | 1109 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1110 | public abstract boolean getDatabaseEnabled(); |
Andrei Popescu | c27a9ac | 2009-08-03 15:59:24 +0100 | [diff] [blame] | 1111 | |
| 1112 | /** |
Mikhail Naganov | 6cb296a | 2012-08-28 16:57:24 +0100 | [diff] [blame] | 1113 | * Sets whether Geolocation is enabled. The default is true. |
| 1114 | * <p> |
| 1115 | * Please note that in order for the Geolocation API to be usable |
| 1116 | * by a page in the WebView, the following requirements must be met: |
| 1117 | * <ul> |
| 1118 | * <li>an application must have permission to access the device location, |
| 1119 | * see {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}, |
| 1120 | * {@link android.Manifest.permission#ACCESS_FINE_LOCATION}; |
| 1121 | * <li>an application must provide an implementation of the |
| 1122 | * {@link WebChromeClient#onGeolocationPermissionsShowPrompt} callback |
| 1123 | * to receive notifications that a page is requesting access to location |
| 1124 | * via the JavaScript Geolocation API. |
| 1125 | * </ul> |
| 1126 | * <p> |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1127 | * |
| 1128 | * @param flag whether Geolocation should be enabled |
Steve Block | 06cd751 | 2009-08-21 10:26:37 +0100 | [diff] [blame] | 1129 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1130 | public abstract void setGeolocationEnabled(boolean flag); |
Elliott Slaughter | 5dc0c82 | 2010-06-22 11:31:54 -0700 | [diff] [blame] | 1131 | |
| 1132 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1133 | * Gets whether JavaScript is enabled. |
| 1134 | * |
| 1135 | * @return true if JavaScript is enabled |
| 1136 | * @see #setJavaScriptEnabled |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1137 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1138 | public abstract boolean getJavaScriptEnabled(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1139 | |
| 1140 | /** |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 1141 | * Gets whether JavaScript running in the context of a file scheme URL can |
| 1142 | * access content from any origin. This includes access to content from |
| 1143 | * other file scheme URLs. |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 1144 | * |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 1145 | * @return whether JavaScript running in the context of a file scheme URL |
| 1146 | * can access content from any origin |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1147 | * @see #setAllowUniversalAccessFromFileURLs |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 1148 | */ |
| 1149 | public abstract boolean getAllowUniversalAccessFromFileURLs(); |
| 1150 | |
| 1151 | /** |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 1152 | * Gets whether JavaScript running in the context of a file scheme URL can |
| 1153 | * access content from other file scheme URLs. |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 1154 | * |
Steve Block | ef16315 | 2012-04-23 18:08:06 +0100 | [diff] [blame] | 1155 | * @return whether JavaScript running in the context of a file scheme URL |
| 1156 | * can access content from other file scheme URLs |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1157 | * @see #setAllowFileAccessFromFileURLs |
Selim Gurun | 0ea6dad | 2012-03-29 18:19:01 -0700 | [diff] [blame] | 1158 | */ |
| 1159 | public abstract boolean getAllowFileAccessFromFileURLs(); |
| 1160 | |
| 1161 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1162 | * Gets whether plugins are enabled. |
| 1163 | * |
| 1164 | * @return true if plugins are enabled |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1165 | * @see #setPluginsEnabled |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 1166 | * @deprecated This method has been replaced by {@link #getPluginState} |
Jonathan Dixon | 0bf4781 | 2013-03-07 17:20:08 -0800 | [diff] [blame] | 1167 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1168 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1169 | @SystemApi |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 1170 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1171 | public abstract boolean getPluginsEnabled(); |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 1172 | |
| 1173 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1174 | * Gets the current state regarding whether plugins are enabled. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1175 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1176 | * @return the plugin state as a {@link PluginState} value |
| 1177 | * @see #setPluginState |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1178 | * @deprecated Plugins will not be supported in future, and should not be used. |
Patrick Scott | 300f2e9 | 2010-03-22 10:20:45 -0400 | [diff] [blame] | 1179 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1180 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1181 | public abstract PluginState getPluginState(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1182 | |
| 1183 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1184 | * Gets the directory that contains the plugin libraries. This method is |
Derek Sollenberger | fdbdeb3 | 2010-08-12 11:20:13 -0400 | [diff] [blame] | 1185 | * obsolete since each plugin is now loaded from its own package. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1186 | * |
| 1187 | * @return an empty string |
Derek Sollenberger | fdbdeb3 | 2010-08-12 11:20:13 -0400 | [diff] [blame] | 1188 | * @deprecated This method is no longer used as plugins are loaded from |
| 1189 | * their own APK via the system's package manager. |
Jonathan Dixon | 0bf4781 | 2013-03-07 17:20:08 -0800 | [diff] [blame] | 1190 | * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2} |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1191 | */ |
Jason Chen | 9dc2e75 | 2010-09-01 19:11:14 -0700 | [diff] [blame] | 1192 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1193 | public String getPluginsPath() { |
Jonathan Dixon | 3c90952 | 2012-02-28 18:45:06 +0000 | [diff] [blame] | 1194 | // Unconditionally returns empty string, so no need for derived classes to override. |
Grace Kloba | 658ab7d | 2009-05-14 14:45:26 -0700 | [diff] [blame] | 1195 | return ""; |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1196 | } |
| 1197 | |
| 1198 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1199 | * Tells JavaScript to open windows automatically. This applies to the |
| 1200 | * JavaScript function window.open(). The default is false. |
| 1201 | * |
| 1202 | * @param flag true if JavaScript can open windows automatically |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1203 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1204 | public abstract void setJavaScriptCanOpenWindowsAutomatically(boolean flag); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1205 | |
| 1206 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1207 | * Gets whether JavaScript can open windows automatically. |
| 1208 | * |
| 1209 | * @return true if JavaScript can open windows automatically during |
| 1210 | * window.open() |
| 1211 | * @see #setJavaScriptCanOpenWindowsAutomatically |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1212 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1213 | public abstract boolean getJavaScriptCanOpenWindowsAutomatically(); |
Marcin Kosiba | fd1ac83 | 2014-10-10 17:12:49 +0100 | [diff] [blame] | 1214 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1215 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1216 | * Sets the default text encoding name to use when decoding html pages. |
Marcin Kosiba | fd1ac83 | 2014-10-10 17:12:49 +0100 | [diff] [blame] | 1217 | * The default is "UTF-8". |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1218 | * |
| 1219 | * @param encoding the text encoding name |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1220 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1221 | public abstract void setDefaultTextEncodingName(String encoding); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1222 | |
| 1223 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1224 | * Gets the default text encoding name. |
| 1225 | * |
| 1226 | * @return the default text encoding name as a string |
| 1227 | * @see #setDefaultTextEncodingName |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1228 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1229 | public abstract String getDefaultTextEncodingName(); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1230 | |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 1231 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1232 | * Sets the WebView's user-agent string. If the string is null or empty, |
| 1233 | * the system default value will be used. |
Mikhail Naganov | 550f621 | 2015-07-07 13:39:31 -0700 | [diff] [blame] | 1234 | * |
| 1235 | * Note that starting from {@link android.os.Build.VERSION_CODES#KITKAT} Android |
| 1236 | * version, changing the user-agent while loading a web page causes WebView |
| 1237 | * to initiate loading once again. |
| 1238 | * |
| 1239 | * @param ua new user-agent string |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 1240 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1241 | public abstract void setUserAgentString(String ua); |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 1242 | |
| 1243 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1244 | * Gets the WebView's user-agent string. |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1245 | * |
| 1246 | * @return the WebView's user-agent string |
| 1247 | * @see #setUserAgentString |
The Android Open Source Project | f013e1a | 2008-12-17 18:05:43 -0800 | [diff] [blame] | 1248 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1249 | public abstract String getUserAgentString(); |
Shimeng (Simon) Wang | c55886a | 2010-10-28 13:46:02 -0700 | [diff] [blame] | 1250 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1251 | /** |
George Mount | 9f410c5 | 2012-08-10 15:29:30 -0700 | [diff] [blame] | 1252 | * Returns the default User-Agent used by a WebView. |
| 1253 | * An instance of WebView could use a different User-Agent if a call |
Kristian Monsen | f491258 | 2012-08-16 15:26:24 -0400 | [diff] [blame] | 1254 | * is made to {@link WebSettings#setUserAgentString(String)}. |
George Mount | 9f410c5 | 2012-08-10 15:29:30 -0700 | [diff] [blame] | 1255 | * |
| 1256 | * @param context a Context object used to access application assets |
| 1257 | */ |
| 1258 | public static String getDefaultUserAgent(Context context) { |
Jonathan Dixon | d1c4faa | 2012-08-20 16:37:15 -0700 | [diff] [blame] | 1259 | return WebViewFactory.getProvider().getStatics().getDefaultUserAgent(context); |
George Mount | 9f410c5 | 2012-08-10 15:29:30 -0700 | [diff] [blame] | 1260 | } |
| 1261 | |
| 1262 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1263 | * Tells the WebView whether it needs to set a node to have focus when |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1264 | * {@link WebView#requestFocus(int, android.graphics.Rect)} is called. The |
| 1265 | * default value is true. |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 1266 | * |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1267 | * @param flag whether the WebView needs to set a node |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1268 | */ |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1269 | public abstract void setNeedInitialFocus(boolean flag); |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1270 | |
| 1271 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1272 | * Sets the priority of the Render thread. Unlike the other settings, this |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1273 | * one only needs to be called once per process. The default value is |
| 1274 | * {@link RenderPriority#NORMAL}. |
Mike Hearn | adcd2ed | 2009-01-21 16:44:36 +0100 | [diff] [blame] | 1275 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1276 | * @param priority the priority |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1277 | * @deprecated It is not recommended to adjust thread priorities, and this will |
| 1278 | * not be supported in future versions. |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1279 | */ |
Jonathan Dixon | 835b1fc | 2013-02-25 12:29:33 -0800 | [diff] [blame] | 1280 | @Deprecated |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1281 | public abstract void setRenderPriority(RenderPriority priority); |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 1282 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1283 | /** |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1284 | * Overrides the way the cache is used. The way the cache is used is based |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1285 | * on the navigation type. For a normal page load, the cache is checked |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1286 | * and content is re-validated as needed. When navigating back, content is |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1287 | * not revalidated, instead the content is just retrieved from the cache. |
| 1288 | * This method allows the client to override this behavior by specifying |
Mikhail Naganov | 56936a1 | 2012-07-25 13:07:18 +0100 | [diff] [blame] | 1289 | * one of {@link #LOAD_DEFAULT}, |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1290 | * {@link #LOAD_CACHE_ELSE_NETWORK}, {@link #LOAD_NO_CACHE} or |
| 1291 | * {@link #LOAD_CACHE_ONLY}. The default value is {@link #LOAD_DEFAULT}. |
Steve Block | 4e584df | 2012-04-24 23:12:47 +0100 | [diff] [blame] | 1292 | * |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1293 | * @param mode the mode to use |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1294 | */ |
Tim Volodine | b90f538 | 2016-04-29 12:44:41 +0100 | [diff] [blame] | 1295 | public abstract void setCacheMode(@CacheMode int mode); |
Michael Kolb | a172e7d | 2010-06-30 12:35:26 -0700 | [diff] [blame] | 1296 | |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1297 | /** |
Steve Block | b0e0f33 | 2012-06-13 22:01:11 +0100 | [diff] [blame] | 1298 | * Gets the current setting for overriding the cache mode. |
| 1299 | * |
| 1300 | * @return the current setting for overriding the cache mode |
| 1301 | * @see #setCacheMode |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1302 | */ |
Tim Volodine | b90f538 | 2016-04-29 12:44:41 +0100 | [diff] [blame] | 1303 | @CacheMode |
Ignacio Solla | 451e338 | 2014-11-10 10:35:54 +0000 | [diff] [blame] | 1304 | public abstract int getCacheMode(); |
Ben Murdoch | fe9fc3d | 2014-04-10 15:31:06 +0100 | [diff] [blame] | 1305 | |
| 1306 | /** |
| 1307 | * Configures the WebView's behavior when a secure origin attempts to load a resource from an |
| 1308 | * insecure origin. |
| 1309 | * |
| 1310 | * By default, apps that target {@link android.os.Build.VERSION_CODES#KITKAT} or below default |
| 1311 | * to {@link #MIXED_CONTENT_ALWAYS_ALLOW}. Apps targeting |
Dianne Hackborn | 955d8d6 | 2014-10-07 20:17:19 -0700 | [diff] [blame] | 1312 | * {@link android.os.Build.VERSION_CODES#LOLLIPOP} default to {@link #MIXED_CONTENT_NEVER_ALLOW}. |
Ben Murdoch | fe9fc3d | 2014-04-10 15:31:06 +0100 | [diff] [blame] | 1313 | * |
| 1314 | * The preferred and most secure mode of operation for the WebView is |
| 1315 | * {@link #MIXED_CONTENT_NEVER_ALLOW} and use of {@link #MIXED_CONTENT_ALWAYS_ALLOW} is |
| 1316 | * strongly discouraged. |
| 1317 | * |
| 1318 | * @param mode The mixed content mode to use. One of {@link #MIXED_CONTENT_NEVER_ALLOW}, |
Torne (Richard Coles) | 2b666c9 | 2015-03-06 14:20:00 +0000 | [diff] [blame] | 1319 | * {@link #MIXED_CONTENT_ALWAYS_ALLOW} or {@link #MIXED_CONTENT_COMPATIBILITY_MODE}. |
Ben Murdoch | fe9fc3d | 2014-04-10 15:31:06 +0100 | [diff] [blame] | 1320 | */ |
| 1321 | public abstract void setMixedContentMode(int mode); |
| 1322 | |
| 1323 | /** |
| 1324 | * Gets the current behavior of the WebView with regard to loading insecure content from a |
| 1325 | * secure origin. |
| 1326 | * @return The current setting, one of {@link #MIXED_CONTENT_NEVER_ALLOW}, |
Torne (Richard Coles) | 2b666c9 | 2015-03-06 14:20:00 +0000 | [diff] [blame] | 1327 | * {@link #MIXED_CONTENT_ALWAYS_ALLOW} or {@link #MIXED_CONTENT_COMPATIBILITY_MODE}. |
Ben Murdoch | fe9fc3d | 2014-04-10 15:31:06 +0100 | [diff] [blame] | 1328 | */ |
| 1329 | public abstract int getMixedContentMode(); |
Yuncheol Heo | 4d07c48 | 2014-05-07 17:29:35 +0900 | [diff] [blame] | 1330 | |
| 1331 | /** |
| 1332 | * Sets whether to use a video overlay for embedded encrypted video. |
Dianne Hackborn | 955d8d6 | 2014-10-07 20:17:19 -0700 | [diff] [blame] | 1333 | * In API levels prior to {@link android.os.Build.VERSION_CODES#LOLLIPOP}, encrypted video can |
Yuncheol Heo | 4d07c48 | 2014-05-07 17:29:35 +0900 | [diff] [blame] | 1334 | * only be rendered directly on a secure video surface, so it had been a hard problem to play |
| 1335 | * encrypted video in HTML. When this flag is on, WebView can play encrypted video (MSE/EME) |
| 1336 | * by using a video overlay (aka hole-punching) for videos embedded using HTML <video> |
| 1337 | * tag.<br> |
| 1338 | * Caution: This setting is intended for use only in a narrow set of circumstances and apps |
| 1339 | * should only enable it if they require playback of encrypted video content. It will impose |
| 1340 | * the following limitations on the WebView: |
| 1341 | * <ul> |
| 1342 | * <li> Only one video overlay can be played at a time. |
| 1343 | * <li> Changes made to position or dimensions of a video element may be propagated to the |
| 1344 | * corresponding video overlay with a noticeable delay. |
| 1345 | * <li> The video overlay is not visible to web APIs and as such may not interact with |
| 1346 | * script or styling. For example, CSS styles applied to the <video> tag may be ignored. |
| 1347 | * </ul> |
| 1348 | * This is not an exhaustive set of constraints and it may vary with new versions of the |
| 1349 | * WebView. |
| 1350 | * @hide |
| 1351 | */ |
Yuncheol Heo | eeba025 | 2014-07-08 19:43:00 +0900 | [diff] [blame] | 1352 | @SystemApi |
Yuncheol Heo | 4d07c48 | 2014-05-07 17:29:35 +0900 | [diff] [blame] | 1353 | public abstract void setVideoOverlayForEmbeddedEncryptedVideoEnabled(boolean flag); |
| 1354 | |
| 1355 | /** |
| 1356 | * Gets whether a video overlay will be used for embedded encrypted video. |
| 1357 | * |
| 1358 | * @return true if WebView uses a video overlay for embedded encrypted video. |
| 1359 | * @see #setVideoOverlayForEmbeddedEncryptedVideoEnabled |
| 1360 | * @hide |
| 1361 | */ |
Yuncheol Heo | eeba025 | 2014-07-08 19:43:00 +0900 | [diff] [blame] | 1362 | @SystemApi |
Yuncheol Heo | 4d07c48 | 2014-05-07 17:29:35 +0900 | [diff] [blame] | 1363 | public abstract boolean getVideoOverlayForEmbeddedEncryptedVideoEnabled(); |
Hui Shu | b1ee70b | 2015-03-03 11:38:41 -0800 | [diff] [blame] | 1364 | |
| 1365 | /** |
| 1366 | * Sets whether this WebView should raster tiles when it is |
| 1367 | * offscreen but attached to a window. Turning this on can avoid |
| 1368 | * rendering artifacts when animating an offscreen WebView on-screen. |
| 1369 | * Offscreen WebViews in this mode use more memory. The default value is |
Hui Shu | d377c0f | 2015-05-13 12:01:42 -0700 | [diff] [blame] | 1370 | * false.<br> |
Hui Shu | b1ee70b | 2015-03-03 11:38:41 -0800 | [diff] [blame] | 1371 | * Please follow these guidelines to limit memory usage: |
Hui Shu | d377c0f | 2015-05-13 12:01:42 -0700 | [diff] [blame] | 1372 | * <ul> |
| 1373 | * <li> WebView size should be not be larger than the device screen size. |
| 1374 | * <li> Limit use of this mode to a small number of WebViews. Use it for |
Hui Shu | b1ee70b | 2015-03-03 11:38:41 -0800 | [diff] [blame] | 1375 | * visible WebViews and WebViews about to be animated to visible. |
Hui Shu | d377c0f | 2015-05-13 12:01:42 -0700 | [diff] [blame] | 1376 | * </ul> |
Hui Shu | b1ee70b | 2015-03-03 11:38:41 -0800 | [diff] [blame] | 1377 | */ |
| 1378 | public abstract void setOffscreenPreRaster(boolean enabled); |
| 1379 | |
| 1380 | /** |
| 1381 | * Gets whether this WebView should raster tiles when it is |
| 1382 | * offscreen but attached to a window. |
| 1383 | * @return true if this WebView will raster tiles when it is |
| 1384 | * offscreen but attached to a window. |
| 1385 | */ |
| 1386 | public abstract boolean getOffscreenPreRaster(); |
Hui Shu | 227a8c1 | 2015-10-22 14:57:51 -0700 | [diff] [blame] | 1387 | |
Selim Gurun | ec0a1f2 | 2017-04-07 18:21:46 -0700 | [diff] [blame] | 1388 | |
| 1389 | /** |
| 1390 | * Sets whether Safe Browsing is enabled. Safe browsing allows WebView to |
| 1391 | * protect against malware and phishing attacks by verifying the links. |
| 1392 | * |
Selim Gurun | ec0a1f2 | 2017-04-07 18:21:46 -0700 | [diff] [blame] | 1393 | * <p> |
Nate Fischer | 471891d | 2017-07-18 19:15:52 -0700 | [diff] [blame] | 1394 | * Safe browsing is disabled by default. The recommended way to enable Safe browsing is using a |
| 1395 | * manifest tag to change the default value to enabled for all WebViews (read <a |
| 1396 | * href="{@docRoot}reference/android/webkit/WebView.html">general Safe Browsing info</a>). |
Selim Gurun | ec0a1f2 | 2017-04-07 18:21:46 -0700 | [diff] [blame] | 1397 | * |
Nate Fischer | 471891d | 2017-07-18 19:15:52 -0700 | [diff] [blame] | 1398 | * <p> |
Selim Gurun | ec0a1f2 | 2017-04-07 18:21:46 -0700 | [diff] [blame] | 1399 | * This API overrides the manifest tag value for this WebView. |
| 1400 | * |
| 1401 | * @param enabled Whether Safe browsing is enabled. |
| 1402 | */ |
| 1403 | public abstract void setSafeBrowsingEnabled(boolean enabled); |
| 1404 | |
| 1405 | /** |
| 1406 | * Gets whether Safe browsing is enabled. |
| 1407 | * See {@link #setSafeBrowsingEnabled}. |
| 1408 | * |
| 1409 | * @return true if Safe browsing is enabled and false otherwise. |
| 1410 | */ |
| 1411 | public abstract boolean getSafeBrowsingEnabled(); |
| 1412 | |
| 1413 | |
Hui Shu | 227a8c1 | 2015-10-22 14:57:51 -0700 | [diff] [blame] | 1414 | /** |
Hui Shu | 539b077 | 2016-04-20 15:21:37 -0700 | [diff] [blame] | 1415 | * @hide |
| 1416 | */ |
| 1417 | @IntDef(flag = true, |
| 1418 | value = { |
| 1419 | MENU_ITEM_NONE, |
| 1420 | MENU_ITEM_SHARE, |
| 1421 | MENU_ITEM_WEB_SEARCH, |
| 1422 | MENU_ITEM_PROCESS_TEXT |
| 1423 | }) |
| 1424 | @Retention(RetentionPolicy.SOURCE) |
| 1425 | @Target({ElementType.PARAMETER, ElementType.METHOD}) |
| 1426 | private @interface MenuItemFlags {} |
| 1427 | |
| 1428 | /** |
Hui Shu | 227a8c1 | 2015-10-22 14:57:51 -0700 | [diff] [blame] | 1429 | * Disables the action mode menu items according to {@code menuItems} flag. |
| 1430 | * @param menuItems an integer field flag for the menu items to be disabled. |
| 1431 | */ |
Hui Shu | 539b077 | 2016-04-20 15:21:37 -0700 | [diff] [blame] | 1432 | public abstract void setDisabledActionModeMenuItems(@MenuItemFlags int menuItems); |
Hui Shu | 227a8c1 | 2015-10-22 14:57:51 -0700 | [diff] [blame] | 1433 | |
| 1434 | /** |
| 1435 | * Gets the action mode menu items that are disabled, expressed in an integer field flag. |
| 1436 | * The default value is {@link #MENU_ITEM_NONE} |
| 1437 | * |
Hui Shu | 539b077 | 2016-04-20 15:21:37 -0700 | [diff] [blame] | 1438 | * @return all the disabled menu item flags combined with bitwise OR. |
Hui Shu | 227a8c1 | 2015-10-22 14:57:51 -0700 | [diff] [blame] | 1439 | */ |
Hui Shu | 539b077 | 2016-04-20 15:21:37 -0700 | [diff] [blame] | 1440 | public abstract @MenuItemFlags int getDisabledActionModeMenuItems(); |
Hui Shu | 227a8c1 | 2015-10-22 14:57:51 -0700 | [diff] [blame] | 1441 | |
| 1442 | /** |
| 1443 | * Used with {@link #setDisabledActionModeMenuItems}. |
| 1444 | * |
| 1445 | * No menu items should be disabled. |
| 1446 | */ |
| 1447 | public static final int MENU_ITEM_NONE = 0; |
| 1448 | |
| 1449 | /** |
| 1450 | * Used with {@link #setDisabledActionModeMenuItems}. |
| 1451 | * |
| 1452 | * Disable menu item "Share". |
| 1453 | */ |
| 1454 | public static final int MENU_ITEM_SHARE = 1 << 0; |
| 1455 | |
| 1456 | /** |
| 1457 | * Used with {@link #setDisabledActionModeMenuItems}. |
| 1458 | * |
| 1459 | * Disable menu item "Web Search". |
| 1460 | */ |
| 1461 | public static final int MENU_ITEM_WEB_SEARCH = 1 << 1; |
| 1462 | |
| 1463 | /** |
| 1464 | * Used with {@link #setDisabledActionModeMenuItems}. |
| 1465 | * |
| 1466 | * Disable all the action mode menu items for text processing. |
| 1467 | * By default WebView searches for activities that are able to handle |
| 1468 | * {@link android.content.Intent#ACTION_PROCESS_TEXT} and show them in the |
| 1469 | * action mode menu. If this flag is set via {@link |
| 1470 | * #setDisabledActionModeMenuItems}, these menu items will be disabled. |
| 1471 | */ |
| 1472 | public static final int MENU_ITEM_PROCESS_TEXT = 1 << 2; |
The Android Open Source Project | 54b6cfa | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1473 | } |