WebSettings

LOAD_CACHE_ELSE_NETWORK

int LOAD_CACHE_ELSE_NETWORK

Use cached resources when they are available, even if they have expired. Otherwise load resources from the network. Use with setCacheMode(int).

Constant Value: 1 (0x00000001)

LOAD_CACHE_ONLY

int LOAD_CACHE_ONLY

Don't use the network, load from the cache. Use with setCacheMode(int).

Constant Value: 3 (0x00000003)

LOAD_DEFAULT

int LOAD_DEFAULT

Default cache usage mode. If the navigation type doesn't impose any specific behavior, use cached resources when they are available and not expired, otherwise load resources from the network. Use with setCacheMode(int).

Constant Value: -1 (0xffffffff)

LOAD_NORMAL

int LOAD_NORMAL

This constant was deprecated in API level 17.
This value is obsolete, as from API level HONEYCOMB and onwards it has the same effect as LOAD_DEFAULT.

Normal cache usage mode. Use with setCacheMode(int).

Constant Value: 0 (0x00000000)

LOAD_NO_CACHE

int LOAD_NO_CACHE

Don't use the cache, load from the network. Use with setCacheMode(int).

Constant Value: 2 (0x00000002)

MENU_ITEM_NONE

int MENU_ITEM_NONE

Used with setDisabledActionModeMenuItems(int). No menu items should be disabled.

Constant Value: 0 (0x00000000)

MENU_ITEM_PROCESS_TEXT

int MENU_ITEM_PROCESS_TEXT

Used with setDisabledActionModeMenuItems(int). Disable all the action mode menu items for text processing. By default WebView searches for activities that are able to handle ACTION_PROCESS_TEXT and show them in the action mode menu. If this flag is set via setDisabledActionModeMenuItems(int), these menu items will be disabled.

Constant Value: 4 (0x00000004)

MENU_ITEM_SHARE

int MENU_ITEM_SHARE

Used with setDisabledActionModeMenuItems(int). Disable menu item "Share".

Constant Value: 1 (0x00000001)

MENU_ITEM_WEB_SEARCH

int MENU_ITEM_WEB_SEARCH

Used with setDisabledActionModeMenuItems(int). Disable menu item "Web Search".

Constant Value: 2 (0x00000002)

MIXED_CONTENT_ALWAYS_ALLOW

int MIXED_CONTENT_ALWAYS_ALLOW

Used with setMixedContentMode(int) In this mode, the WebView will allow a secure origin to load content from any other origin, even if that origin is insecure. This is the least secure mode of operation for the WebView, and where possible apps should not set this mode.

Constant Value: 0 (0x00000000)

MIXED_CONTENT_COMPATIBILITY_MODE

int MIXED_CONTENT_COMPATIBILITY_MODE

Used with setMixedContentMode(int) In this mode, the WebView will attempt to be compatible with the approach of a modern web browser with regard to mixed content. Some insecure content may be allowed to be loaded by a secure origin and other types of content will be blocked. The types of content are allowed or blocked may change release to release and are not explicitly defined. This mode is intended to be used by apps that are not in control of the content that they render but desire to operate in a reasonably secure environment. For highest security, apps are recommended to use MIXED_CONTENT_NEVER_ALLOW.

Constant Value: 2 (0x00000002)

MIXED_CONTENT_NEVER_ALLOW

int MIXED_CONTENT_NEVER_ALLOW

Used with setMixedContentMode(int) In this mode, the WebView will not allow a secure origin to load content from an insecure origin. This is the preferred and most secure mode of operation for the WebView and apps are strongly advised to use this mode.

Constant Value: 1 (0x00000001)

WebSettings

WebSettings ()

enableSmoothTransition

boolean enableSmoothTransition ()

This method was deprecated in API level 17.
This method is now obsolete, and will become a no-op in future.

Gets whether the WebView enables smooth transition while panning or zooming.

getAllowContentAccess

boolean getAllowContentAccess ()

Gets whether this WebView supports content URL access.

getAllowFileAccess

boolean getAllowFileAccess ()

Gets whether this WebView supports file access.

getAllowFileAccessFromFileURLs

boolean getAllowFileAccessFromFileURLs ()

Gets whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs.

getAllowUniversalAccessFromFileURLs

boolean getAllowUniversalAccessFromFileURLs ()

Gets whether JavaScript running in the context of a file scheme URL can access content from any origin. This includes access to content from other file scheme URLs.

getBlockNetworkImage

boolean getBlockNetworkImage ()

Gets whether the WebView does not load image resources from the network.

getBlockNetworkLoads

boolean getBlockNetworkLoads ()

Gets whether the WebView does not load any resources from the network.

getBuiltInZoomControls

boolean getBuiltInZoomControls ()

Gets whether the zoom mechanisms built into WebView are being used.

getCacheMode

int getCacheMode ()

Gets the current setting for overriding the cache mode.

getCursiveFontFamily

String getCursiveFontFamily ()

Gets the cursive font family name.

getDatabaseEnabled

boolean getDatabaseEnabled ()

Gets whether the database storage API is enabled.

getDatabasePath

String getDatabasePath ()

This method was deprecated in API level 19.
Database paths are managed by the implementation this method is obsolete.

Gets the path to where database storage API databases are saved.

getDefaultFixedFontSize

int getDefaultFixedFontSize ()

Gets the default fixed font size.

getDefaultFontSize

int getDefaultFontSize ()

Gets the default font size.

getDefaultTextEncodingName

String getDefaultTextEncodingName ()

Gets the default text encoding name.

getDefaultUserAgent

String getDefaultUserAgent (Context context)

Returns the default User-Agent used by a WebView. An instance of WebView could use a different User-Agent if a call is made to setUserAgentString(String).

getDefaultZoom

WebSettings.ZoomDensity getDefaultZoom ()

This method was deprecated in API level 19.
Will only return the default value.

Gets the default zoom density of the page. This should be called from the UI thread. This setting is not recommended for use in new applications.

getDisabledActionModeMenuItems

int getDisabledActionModeMenuItems ()

Gets the action mode menu items that are disabled, expressed in an integer field flag. The default value is MENU_ITEM_NONE

getDisplayZoomControls

boolean getDisplayZoomControls ()

Gets whether the WebView displays on-screen zoom controls when using the built-in zoom mechanisms.

getDomStorageEnabled

boolean getDomStorageEnabled ()

Gets whether the DOM Storage APIs are enabled.

getFantasyFontFamily

String getFantasyFontFamily ()

Gets the fantasy font family name.

getFixedFontFamily

String getFixedFontFamily ()

Gets the fixed font family name.

getJavaScriptCanOpenWindowsAutomatically

boolean getJavaScriptCanOpenWindowsAutomatically ()

Gets whether JavaScript can open windows automatically.

getJavaScriptEnabled

boolean getJavaScriptEnabled ()

Gets whether JavaScript is enabled.

getLayoutAlgorithm

WebSettings.LayoutAlgorithm getLayoutAlgorithm ()

Gets the current layout algorithm.

getLightTouchEnabled

boolean getLightTouchEnabled ()

This method was deprecated in API level 18.
This setting is obsolete.

Gets whether light touches are enabled.

getLoadWithOverviewMode

boolean getLoadWithOverviewMode ()

Gets whether this WebView loads pages in overview mode.

getLoadsImagesAutomatically

boolean getLoadsImagesAutomatically ()

Gets whether the WebView loads image resources. This includes images embedded using the data URI scheme.

getMediaPlaybackRequiresUserGesture

boolean getMediaPlaybackRequiresUserGesture ()

Gets whether the WebView requires a user gesture to play media.

getMinimumFontSize

int getMinimumFontSize ()

Gets the minimum font size.

getMinimumLogicalFontSize

int getMinimumLogicalFontSize ()

Gets the minimum logical font size.

getMixedContentMode

int getMixedContentMode ()

Gets the current behavior of the WebView with regard to loading insecure content from a secure origin.

getOffscreenPreRaster

boolean getOffscreenPreRaster ()

Gets whether this WebView should raster tiles when it is offscreen but attached to a window.

getPluginState

WebSettings.PluginState getPluginState ()

This method was deprecated in API level 18.
Plugins will not be supported in future, and should not be used.

Gets the current state regarding whether plugins are enabled.

getSansSerifFontFamily

String getSansSerifFontFamily ()

Gets the sans-serif font family name.

getSaveFormData

boolean getSaveFormData ()

Gets whether the WebView saves form data.

getSavePassword

boolean getSavePassword ()

This method was deprecated in API level 18.
Saving passwords in WebView will not be supported in future versions.

Gets whether the WebView saves passwords.

getSerifFontFamily

String getSerifFontFamily ()

Gets the serif font family name. The default is "serif".

getStandardFontFamily

String getStandardFontFamily ()

Gets the standard font family name.

getTextSize

WebSettings.TextSize getTextSize ()

This method was deprecated in API level 14.
Use getTextZoom() instead.

Gets the text size of the page. If the text size was previously specified in percent using setTextZoom(int), this will return the closest matching WebSettings.TextSize.

getTextZoom

int getTextZoom ()

Gets the text zoom of the page in percent.

getUseWideViewPort

boolean getUseWideViewPort ()

Gets whether the WebView supports the "viewport" HTML meta tag or will use a wide viewport.

getUserAgentString

String getUserAgentString ()

Gets the WebView's user-agent string.

setAllowContentAccess

void setAllowContentAccess (boolean allow)

Enables or disables content URL access within WebView. Content URL access allows WebView to load content from a content provider installed in the system. The default is enabled.

setAllowFileAccess

void setAllowFileAccess (boolean allow)

Enables or disables file access within WebView. File access is enabled by default. Note that this enables or disables file system access only. Assets and resources are still accessible using file:///android_asset and file:///android_res.

setAllowFileAccessFromFileURLs

void setAllowFileAccessFromFileURLs (boolean flag)

Sets whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs. To enable the most restrictive, and therefore secure policy, this setting should be disabled. Note that the value of this setting is ignored if the value of getAllowUniversalAccessFromFileURLs() is true. Note too, that this setting affects only JavaScript access to file scheme resources. Other access to such resources, for example, from image HTML elements, is unaffected. To prevent possible violation of same domain policy on ICE_CREAM_SANDWICH and earlier devices, you should explicitly set this value to false.

The default value is true for API level ICE_CREAM_SANDWICH_MR1 and below, and false for API level JELLY_BEAN and above.

setAllowUniversalAccessFromFileURLs

void setAllowUniversalAccessFromFileURLs (boolean flag)

Sets whether JavaScript running in the context of a file scheme URL should be allowed to access content from any origin. This includes access to content from other file scheme URLs. See setAllowFileAccessFromFileURLs(boolean). To enable the most restrictive, and therefore secure policy, this setting should be disabled. Note that this setting affects only JavaScript access to file scheme resources. Other access to such resources, for example, from image HTML elements, is unaffected. To prevent possible violation of same domain policy on ICE_CREAM_SANDWICH and earlier devices, you should explicitly set this value to false.

The default value is true for API level ICE_CREAM_SANDWICH_MR1 and below, and false for API level JELLY_BEAN and above.

setAppCacheEnabled

void setAppCacheEnabled (boolean flag)

Sets whether the Application Caches API should be enabled. The default is false. Note that in order for the Application Caches API to be enabled, a valid database path must also be supplied to setAppCachePath(String).

setAppCacheMaxSize

void setAppCacheMaxSize (long appCacheMaxSize)

This method was deprecated in API level 18.
In future quota will be managed automatically.

Sets the maximum size for the Application Cache content. The passed size will be rounded to the nearest value that the database can support, so this should be viewed as a guide, not a hard limit. Setting the size to a value less than current database size does not cause the database to be trimmed. The default size is MAX_VALUE. It is recommended to leave the maximum size set to the default value.

setAppCachePath

void setAppCachePath (String appCachePath)

Sets the path to the Application Caches files. In order for the Application Caches API to be enabled, this method must be called with a path to which the application can write. This method should only be called once: repeated calls are ignored.

setBlockNetworkImage

void setBlockNetworkImage (boolean flag)

Sets whether the WebView should not load image resources from the network (resources accessed via http and https URI schemes). Note that this method has no effect unless getLoadsImagesAutomatically() returns true. Also note that disabling all network loads using setBlockNetworkLoads(boolean) will also prevent network images from loading, even if this flag is set to false. When the value of this setting is changed from true to false, network images resources referenced by content currently displayed by the WebView are fetched automatically. The default is false.

setBlockNetworkLoads

void setBlockNetworkLoads (boolean flag)

Sets whether the WebView should not load resources from the network. Use setBlockNetworkImage(boolean) to only avoid loading image resources. Note that if the value of this setting is changed from true to false, network resources referenced by content currently displayed by the WebView are not fetched until reload() is called. If the application does not have the INTERNET permission, attempts to set a value of false will cause a SecurityException to be thrown. The default value is false if the application has the INTERNET permission, otherwise it is true.

setBuiltInZoomControls

void setBuiltInZoomControls (boolean enabled)

Sets whether the WebView should use its built-in zoom mechanisms. The built-in zoom mechanisms comprise on-screen zoom controls, which are displayed over the WebView's content, and the use of a pinch gesture to control zooming. Whether or not these on-screen controls are displayed can be set with setDisplayZoomControls(boolean). The default is false.

The built-in mechanisms are the only currently supported zoom mechanisms, so it is recommended that this setting is always enabled.

setCacheMode

void setCacheMode (int mode)

Overrides the way the cache is used. The way the cache is used is based on the navigation type. For a normal page load, the cache is checked and content is re-validated as needed. When navigating back, content is not revalidated, instead the content is just retrieved from the cache. This method allows the client to override this behavior by specifying one of LOAD_DEFAULT, LOAD_CACHE_ELSE_NETWORK, LOAD_NO_CACHE or LOAD_CACHE_ONLY. The default value is LOAD_DEFAULT.

setCursiveFontFamily

void setCursiveFontFamily (String font)

Sets the cursive font family name. The default is "cursive".

setDatabaseEnabled

void setDatabaseEnabled (boolean flag)

Sets whether the database storage API is enabled. The default value is false. See also setDatabasePath(String) for how to correctly set up the database storage API. This setting is global in effect, across all WebView instances in a process. Note you should only modify this setting prior to making any WebView page load within a given process, as the WebView implementation may ignore changes to this setting after that point.

setDatabasePath

void setDatabasePath (String databasePath)

This method was deprecated in API level 19.
Database paths are managed by the implementation and calling this method will have no effect.

Sets the path to where database storage API databases should be saved. In order for the database storage API to function correctly, this method must be called with a path to which the application can write. This method should only be called once: repeated calls are ignored.

setDefaultFixedFontSize

void setDefaultFixedFontSize (int size)

Sets the default fixed font size. The default is 16.

setDefaultFontSize

void setDefaultFontSize (int size)

Sets the default font size. The default is 16.

setDefaultTextEncodingName

void setDefaultTextEncodingName (String encoding)

Sets the default text encoding name to use when decoding html pages. The default is "UTF-8".

setDefaultZoom

void setDefaultZoom (WebSettings.ZoomDensity zoom)

This method was deprecated in API level 19.
This method is no longer supported, see the function documentation for recommended alternatives.

Sets the default zoom density of the page. This must be called from the UI thread. The default is MEDIUM. This setting is not recommended for use in new applications. If the WebView is utilized to display mobile-oriented pages, the desired effect can be achieved by adjusting 'width' and 'initial-scale' attributes of page's 'meta viewport' tag. For pages lacking the tag, setInitialScale(int) and setUseWideViewPort(boolean) can be used.

setDisabledActionModeMenuItems

void setDisabledActionModeMenuItems (int menuItems)

Disables the action mode menu items according to menuItems flag.

setDisplayZoomControls

void setDisplayZoomControls (boolean enabled)

Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms. See setBuiltInZoomControls(boolean). The default is true.

setDomStorageEnabled

void setDomStorageEnabled (boolean flag)

Sets whether the DOM storage API is enabled. The default value is false.

setEnableSmoothTransition

void setEnableSmoothTransition (boolean enable)

This method was deprecated in API level 17.
This method is now obsolete, and will become a no-op in future.

Sets whether the WebView will enable smooth transition while panning or zooming or while the window hosting the WebView does not have focus. If it is true, WebView will choose a solution to maximize the performance. e.g. the WebView's content may not be updated during the transition. If it is false, WebView will keep its fidelity. The default value is false.

setFantasyFontFamily

void setFantasyFontFamily (String font)

Sets the fantasy font family name. The default is "fantasy".

setFixedFontFamily

void setFixedFontFamily (String font)

Sets the fixed font family name. The default is "monospace".

setGeolocationDatabasePath

void setGeolocationDatabasePath (String databasePath)

This method was deprecated in API level 24.
Geolocation database are managed by the implementation and calling this method will have no effect.

Sets the path where the Geolocation databases should be saved. In order for Geolocation permissions and cached positions to be persisted, this method must be called with a path to which the application can write.

setGeolocationEnabled

void setGeolocationEnabled (boolean flag)

Sets whether Geolocation is enabled. The default is true.

Please note that in order for the Geolocation API to be usable by a page in the WebView, the following requirements must be met:

• an application must have permission to access the device location, see ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION;
• an application must provide an implementation of the onGeolocationPermissionsShowPrompt(String, GeolocationPermissions.Callback) callback to receive notifications that a page is requesting access to location via the JavaScript Geolocation API.

setJavaScriptCanOpenWindowsAutomatically

void setJavaScriptCanOpenWindowsAutomatically (boolean flag)

Tells JavaScript to open windows automatically. This applies to the JavaScript function window.open(). The default is false.

setJavaScriptEnabled

void setJavaScriptEnabled (boolean flag)

Tells the WebView to enable JavaScript execution. The default is false.

setLayoutAlgorithm

void setLayoutAlgorithm (WebSettings.LayoutAlgorithm l)

Sets the underlying layout algorithm. This will cause a relayout of the WebView. The default is NARROW_COLUMNS.

setLightTouchEnabled

void setLightTouchEnabled (boolean enabled)

This method was deprecated in API level 18.
From JELLY_BEAN this setting is obsolete and has no effect.

Enables using light touches to make a selection and activate mouseovers.

setLoadWithOverviewMode

void setLoadWithOverviewMode (boolean overview)

Sets whether the WebView loads pages in overview mode, that is, zooms out the content to fit on screen by width. This setting is taken into account when the content width is greater than the width of the WebView control, for example, when getUseWideViewPort() is enabled. The default is false.

setLoadsImagesAutomatically

void setLoadsImagesAutomatically (boolean flag)

Sets whether the WebView should load image resources. Note that this method controls loading of all images, including those embedded using the data URI scheme. Use setBlockNetworkImage(boolean) to control loading only of images specified using network URI schemes. Note that if the value of this setting is changed from false to true, all images resources referenced by content currently displayed by the WebView are loaded automatically. The default is true.

setMediaPlaybackRequiresUserGesture

void setMediaPlaybackRequiresUserGesture (boolean require)

Sets whether the WebView requires a user gesture to play media. The default is true.

setMinimumFontSize

void setMinimumFontSize (int size)

Sets the minimum font size. The default is 8.

setMinimumLogicalFontSize

void setMinimumLogicalFontSize (int size)

Sets the minimum logical font size. The default is 8.

setMixedContentMode

void setMixedContentMode (int mode)

Configures the WebView's behavior when a secure origin attempts to load a resource from an insecure origin. By default, apps that target KITKAT or below default to MIXED_CONTENT_ALWAYS_ALLOW. Apps targeting LOLLIPOP default to MIXED_CONTENT_NEVER_ALLOW. The preferred and most secure mode of operation for the WebView is MIXED_CONTENT_NEVER_ALLOW and use of MIXED_CONTENT_ALWAYS_ALLOW is strongly discouraged.

setNeedInitialFocus

void setNeedInitialFocus (boolean flag)

Tells the WebView whether it needs to set a node to have focus when requestFocus(int, android.graphics.Rect) is called. The default value is true.

setOffscreenPreRaster

void setOffscreenPreRaster (boolean enabled)

Sets whether this WebView should raster tiles when it is offscreen but attached to a window. Turning this on can avoid rendering artifacts when animating an offscreen WebView on-screen. Offscreen WebViews in this mode use more memory. The default value is false.
Please follow these guidelines to limit memory usage:

• WebView size should be not be larger than the device screen size.
• Limit use of this mode to a small number of WebViews. Use it for visible WebViews and WebViews about to be animated to visible.

setPluginState

void setPluginState (WebSettings.PluginState state)

This method was deprecated in API level 18.
Plugins will not be supported in future, and should not be used.

Tells the WebView to enable, disable, or have plugins on demand. On demand mode means that if a plugin exists that can handle the embedded content, a placeholder icon will be shown instead of the plugin. When the placeholder is clicked, the plugin will be enabled. The default is OFF.

setRenderPriority

void setRenderPriority (WebSettings.RenderPriority priority)

This method was deprecated in API level 18.
It is not recommended to adjust thread priorities, and this will not be supported in future versions.

Sets the priority of the Render thread. Unlike the other settings, this one only needs to be called once per process. The default value is NORMAL.

setSansSerifFontFamily

void setSansSerifFontFamily (String font)

Sets the sans-serif font family name. The default is "sans-serif".

setSaveFormData

void setSaveFormData (boolean save)

Sets whether the WebView should save form data. The default is true.

setSavePassword

void setSavePassword (boolean save)

This method was deprecated in API level 18.
Saving passwords in WebView will not be supported in future versions.

Sets whether the WebView should save passwords. The default is true.

setSerifFontFamily

void setSerifFontFamily (String font)

Sets the serif font family name. The default is "sans-serif".

setStandardFontFamily

void setStandardFontFamily (String font)

Sets the standard font family name. The default is "sans-serif".

setSupportMultipleWindows

void setSupportMultipleWindows (boolean support)

Sets whether the WebView whether supports multiple windows. If set to true, onCreateWindow(WebView, boolean, boolean, Message) must be implemented by the host application. The default is false.

setSupportZoom

void setSupportZoom (boolean support)

Sets whether the WebView should support zooming using its on-screen zoom controls and gestures. The particular zoom mechanisms that should be used can be set with setBuiltInZoomControls(boolean). This setting does not affect zooming performed using the zoomIn() and zoomOut() methods. The default is true.

setTextSize

void setTextSize (WebSettings.TextSize t)

This method was deprecated in API level 14.
Use setTextZoom(int) instead.

Sets the text size of the page. The default is NORMAL.

setTextZoom

void setTextZoom (int textZoom)

Sets the text zoom of the page in percent. The default is 100.

setUseWideViewPort

void setUseWideViewPort (boolean use)

Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. When the value of the setting is false, the layout width is always set to the width of the WebView control in device-independent (CSS) pixels. When the value is true and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used.

setUserAgentString

void setUserAgentString (String ua)

Sets the WebView's user-agent string. If the string is null or empty, the system default value will be used. Note that starting from KITKAT Android version, changing the user-agent while loading a web page causes WebView to initiate loading once again.

supportMultipleWindows

boolean supportMultipleWindows ()

Gets whether the WebView supports multiple windows.

supportZoom

boolean supportZoom ()

Gets whether the WebView supports zoom.