Android APIs
public abstract class

WebSettings

extends Object
java.lang.Object
   ↳ android.webkit.WebSettings

Class Overview

Manages settings state for a WebView. When a WebView is first created, it obtains a set of default settings. These default settings will be returned from any getter call. A WebSettings object obtained from WebView.getSettings() is tied to the life of the WebView. If a WebView has been destroyed, any method call on WebSettings will throw an IllegalStateException.

Summary

Nested Classes
enum WebSettings.LayoutAlgorithm Enum for controlling the layout of html. 
enum WebSettings.PluginState The plugin state effects how plugins are treated on a page. 
enum WebSettings.RenderPriority  
enum WebSettings.TextSize This enum was deprecated in API level 14. Use setTextZoom(int) and getTextZoom() instead.  
enum WebSettings.ZoomDensity Enum for specifying the WebView's desired density. 
Constants
int LOAD_CACHE_ELSE_NETWORK Use cached resources when they are available, even if they have expired.
int LOAD_CACHE_ONLY Don't use the network, load from the cache.
int LOAD_DEFAULT Default cache usage mode.
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.
int LOAD_NO_CACHE Don't use the cache, load from the network.
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.
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.
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.
Public Constructors
WebSettings()
Public Methods
abstract boolean enableSmoothTransition()
This method was deprecated in API level 17. This method is now obsolete, and will become a no-op in future.
abstract boolean getAllowContentAccess()
Gets whether this WebView supports content URL access.
abstract boolean getAllowFileAccess()
Gets whether this WebView supports file access.
abstract boolean getAllowFileAccessFromFileURLs()
Gets whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs.
abstract boolean getAllowUniversalAccessFromFileURLs()
Gets whether JavaScript running in the context of a file scheme URL can access content from any origin.
abstract boolean getBlockNetworkImage()
Gets whether the WebView does not load image resources from the network.
abstract boolean getBlockNetworkLoads()
Gets whether the WebView does not load any resources from the network.
abstract boolean getBuiltInZoomControls()
Gets whether the zoom mechanisms built into WebView are being used.
abstract int getCacheMode()
Gets the current setting for overriding the cache mode.
abstract String getCursiveFontFamily()
Gets the cursive font family name.
abstract boolean getDatabaseEnabled()
Gets whether the database storage API is enabled.
abstract String getDatabasePath()
This method was deprecated in API level 19. Database paths are managed by the implementation this method is obsolete.
abstract int getDefaultFixedFontSize()
Gets the default fixed font size.
abstract int getDefaultFontSize()
Gets the default font size.
abstract String getDefaultTextEncodingName()
Gets the default text encoding name.
static String getDefaultUserAgent(Context context)
Returns the default User-Agent used by a WebView.
abstract WebSettings.ZoomDensity getDefaultZoom()
This method was deprecated in API level 19. Will only return the default value.
abstract boolean getDisplayZoomControls()
Gets whether the WebView displays on-screen zoom controls when using the built-in zoom mechanisms.
abstract boolean getDomStorageEnabled()
Gets whether the DOM Storage APIs are enabled.
abstract String getFantasyFontFamily()
Gets the fantasy font family name.
abstract String getFixedFontFamily()
Gets the fixed font family name.
abstract boolean getJavaScriptCanOpenWindowsAutomatically()
Gets whether JavaScript can open windows automatically.
abstract boolean getJavaScriptEnabled()
Gets whether JavaScript is enabled.
abstract WebSettings.LayoutAlgorithm getLayoutAlgorithm()
Gets the current layout algorithm.
abstract boolean getLightTouchEnabled()
This method was deprecated in API level 18. This setting is obsolete.
abstract boolean getLoadWithOverviewMode()
Gets whether this WebView loads pages in overview mode.
abstract boolean getLoadsImagesAutomatically()
Gets whether the WebView loads image resources.
abstract boolean getMediaPlaybackRequiresUserGesture()
Gets whether the WebView requires a user gesture to play media.
abstract int getMinimumFontSize()
Gets the minimum font size.
abstract int getMinimumLogicalFontSize()
Gets the minimum logical font size.
abstract int getMixedContentMode()
Gets the current behavior of the WebView with regard to loading insecure content from a secure origin.
abstract WebSettings.PluginState getPluginState()
This method was deprecated in API level 18. Plugins will not be supported in future, and should not be used.
abstract String getSansSerifFontFamily()
Gets the sans-serif font family name.
abstract boolean getSaveFormData()
Gets whether the WebView saves form data.
abstract boolean getSavePassword()
This method was deprecated in API level 18. Saving passwords in WebView will not be supported in future versions.
abstract String getSerifFontFamily()
Gets the serif font family name.
abstract String getStandardFontFamily()
Gets the standard font family name.
synchronized WebSettings.TextSize getTextSize()
This method was deprecated in API level 14. Use getTextZoom() instead.
abstract int getTextZoom()
Gets the text zoom of the page in percent.
abstract boolean getUseWideViewPort()
Gets whether the WebView supports the "viewport" HTML meta tag or will use a wide viewport.
abstract String getUserAgentString()
Gets the WebView's user-agent string.
abstract void setAllowContentAccess(boolean allow)
Enables or disables content URL access within WebView.
abstract void setAllowFileAccess(boolean allow)
Enables or disables file access within WebView.
abstract 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.
abstract 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.
abstract void setAppCacheEnabled(boolean flag)
Sets whether the Application Caches API should be enabled.
abstract void setAppCacheMaxSize(long appCacheMaxSize)
This method was deprecated in API level 18. In future quota will be managed automatically.
abstract void setAppCachePath(String appCachePath)
Sets the path to the Application Caches files.
abstract void setBlockNetworkImage(boolean flag)
Sets whether the WebView should not load image resources from the network (resources accessed via http and https URI schemes).
abstract void setBlockNetworkLoads(boolean flag)
Sets whether the WebView should not load resources from the network.
abstract void setBuiltInZoomControls(boolean enabled)
Sets whether the WebView should use its built-in zoom mechanisms.
abstract void setCacheMode(int mode)
Overrides the way the cache is used.
abstract void setCursiveFontFamily(String font)
Sets the cursive font family name.
abstract void setDatabaseEnabled(boolean flag)
Sets whether the database storage API is enabled.
abstract 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.
abstract void setDefaultFixedFontSize(int size)
Sets the default fixed font size.
abstract void setDefaultFontSize(int size)
Sets the default font size.
abstract void setDefaultTextEncodingName(String encoding)
Sets the default text encoding name to use when decoding html pages.
abstract 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.
abstract void setDisplayZoomControls(boolean enabled)
Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms.
abstract void setDomStorageEnabled(boolean flag)
Sets whether the DOM storage API is enabled.
abstract 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.
abstract void setFantasyFontFamily(String font)
Sets the fantasy font family name.
abstract void setFixedFontFamily(String font)
Sets the fixed font family name.
abstract void setGeolocationDatabasePath(String databasePath)
Sets the path where the Geolocation databases should be saved.
abstract void setGeolocationEnabled(boolean flag)
Sets whether Geolocation is enabled.
abstract void setJavaScriptCanOpenWindowsAutomatically(boolean flag)
Tells JavaScript to open windows automatically.
abstract void setJavaScriptEnabled(boolean flag)
Tells the WebView to enable JavaScript execution.
abstract void setLayoutAlgorithm(WebSettings.LayoutAlgorithm l)
Sets the underlying layout algorithm.
abstract void setLightTouchEnabled(boolean enabled)
This method was deprecated in API level 18. From JELLY_BEAN this setting is obsolete and has no effect.
abstract 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.
abstract void setLoadsImagesAutomatically(boolean flag)
Sets whether the WebView should load image resources.
abstract void setMediaPlaybackRequiresUserGesture(boolean require)
Sets whether the WebView requires a user gesture to play media.
abstract void setMinimumFontSize(int size)
Sets the minimum font size.
abstract void setMinimumLogicalFontSize(int size)
Sets the minimum logical font size.
abstract void setMixedContentMode(int mode)
Configures the WebView's behavior when a secure origin attempts to load a resource from an insecure origin.
abstract 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.
abstract 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.
abstract 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.
abstract void setSansSerifFontFamily(String font)
Sets the sans-serif font family name.
abstract void setSaveFormData(boolean save)
Sets whether the WebView should save form data.
abstract void setSavePassword(boolean save)
This method was deprecated in API level 18. Saving passwords in WebView will not be supported in future versions.
abstract void setSerifFontFamily(String font)
Sets the serif font family name.
abstract void setStandardFontFamily(String font)
Sets the standard font family name.
abstract void setSupportMultipleWindows(boolean support)
Sets whether the WebView whether supports multiple windows.
abstract void setSupportZoom(boolean support)
Sets whether the WebView should support zooming using its on-screen zoom controls and gestures.
synchronized void setTextSize(WebSettings.TextSize t)
This method was deprecated in API level 14. Use setTextZoom(int) instead.
abstract void setTextZoom(int textZoom)
Sets the text zoom of the page in percent.
abstract void setUseWideViewPort(boolean use)
Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport.
abstract void setUserAgentString(String ua)
Sets the WebView's user-agent string.
abstract boolean supportMultipleWindows()
Gets whether the WebView supports multiple windows.
abstract boolean supportZoom()
Gets whether the WebView supports zoom.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int LOAD_CACHE_ELSE_NETWORK

Added in API level 1

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)

public static final int LOAD_CACHE_ONLY

Added in API level 1

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

Constant Value: 3 (0x00000003)

public static final int LOAD_DEFAULT

Added in API level 1

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)

public static final int LOAD_NORMAL

Added in API level 1

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)

public static final int LOAD_NO_CACHE

Added in API level 1

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

Constant Value: 2 (0x00000002)

public static final int MIXED_CONTENT_ALWAYS_ALLOW

Added in API level 21

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)

public static final int MIXED_CONTENT_COMPATIBILITY_MODE

Added in API level 21

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)

public static final int MIXED_CONTENT_NEVER_ALLOW

Added in API level 21

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)

Public Constructors

public WebSettings ()

Added in API level 22

Public Methods

public abstract boolean enableSmoothTransition ()

Added in API level 11

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.

public abstract boolean getAllowContentAccess ()

Added in API level 11

Gets whether this WebView supports content URL access.

public abstract boolean getAllowFileAccess ()

Added in API level 3

Gets whether this WebView supports file access.

public abstract boolean getAllowFileAccessFromFileURLs ()

Added in API level 16

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

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

public abstract boolean getAllowUniversalAccessFromFileURLs ()

Added in API level 16

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.

Returns
  • whether JavaScript running in the context of a file scheme URL can access content from any origin

public abstract boolean getBlockNetworkImage ()

Added in API level 1

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

Returns
  • true if the WebView does not load image resources from the network

public abstract boolean getBlockNetworkLoads ()

Added in API level 8

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

Returns
  • true if the WebView does not load any resources from the network

public abstract boolean getBuiltInZoomControls ()

Added in API level 3

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

Returns
  • true if the zoom mechanisms built into WebView are being used

public abstract int getCacheMode ()

Added in API level 1

Gets the current setting for overriding the cache mode.

Returns
  • the current setting for overriding the cache mode

public abstract String getCursiveFontFamily ()

Added in API level 1

Gets the cursive font family name.

Returns
  • the cursive font family name as a string

public abstract boolean getDatabaseEnabled ()

Added in API level 5

Gets whether the database storage API is enabled.

Returns
  • true if the database storage API is enabled

public abstract String getDatabasePath ()

Added in API level 5

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.

Returns
  • the String path to the database storage API databases

public abstract int getDefaultFixedFontSize ()

Added in API level 1

Gets the default fixed font size.

Returns
  • a non-negative integer between 1 and 72

public abstract int getDefaultFontSize ()

Added in API level 1

Gets the default font size.

Returns
  • a non-negative integer between 1 and 72

public abstract String getDefaultTextEncodingName ()

Added in API level 1

Gets the default text encoding name.

Returns
  • the default text encoding name as a string

public static String getDefaultUserAgent (Context context)

Added in API level 17

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).

Parameters
context a Context object used to access application assets

public abstract WebSettings.ZoomDensity getDefaultZoom ()

Added in API level 7

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.

Returns
  • the zoom density

public abstract boolean getDisplayZoomControls ()

Added in API level 11

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

Returns
  • true if the WebView displays on-screen zoom controls when using the built-in zoom mechanisms

public abstract boolean getDomStorageEnabled ()

Added in API level 7

Gets whether the DOM Storage APIs are enabled.

Returns
  • true if the DOM Storage APIs are enabled

public abstract String getFantasyFontFamily ()

Added in API level 1

Gets the fantasy font family name.

Returns
  • the fantasy font family name as a string

public abstract String getFixedFontFamily ()

Added in API level 1

Gets the fixed font family name.

Returns
  • the fixed font family name as a string

public abstract boolean getJavaScriptCanOpenWindowsAutomatically ()

Added in API level 1

Gets whether JavaScript can open windows automatically.

Returns
  • true if JavaScript can open windows automatically during window.open()

public abstract boolean getJavaScriptEnabled ()

Added in API level 1

Gets whether JavaScript is enabled.

Returns
  • true if JavaScript is enabled

public abstract WebSettings.LayoutAlgorithm getLayoutAlgorithm ()

Added in API level 1

Gets the current layout algorithm.

Returns

public abstract boolean getLightTouchEnabled ()

Added in API level 1

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

Gets whether light touches are enabled.

public abstract boolean getLoadWithOverviewMode ()

Added in API level 7

Gets whether this WebView loads pages in overview mode.

Returns
  • whether this WebView loads pages in overview mode

public abstract boolean getLoadsImagesAutomatically ()

Added in API level 1

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

Returns
  • true if the WebView loads image resources

public abstract boolean getMediaPlaybackRequiresUserGesture ()

Added in API level 17

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

Returns
  • true if the WebView requires a user gesture to play media

public abstract int getMinimumFontSize ()

Added in API level 1

Gets the minimum font size.

Returns
  • a non-negative integer between 1 and 72

public abstract int getMinimumLogicalFontSize ()

Added in API level 1

Gets the minimum logical font size.

Returns
  • a non-negative integer between 1 and 72

public abstract int getMixedContentMode ()

Added in API level 21

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

public abstract WebSettings.PluginState getPluginState ()

Added in API level 8

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.

Returns

public abstract String getSansSerifFontFamily ()

Added in API level 1

Gets the sans-serif font family name.

Returns
  • the sans-serif font family name as a string

public abstract boolean getSaveFormData ()

Added in API level 1

Gets whether the WebView saves form data.

Returns
  • whether the WebView saves form data

public abstract boolean getSavePassword ()

Added in API level 1

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.

Returns
  • whether the WebView saves passwords

public abstract String getSerifFontFamily ()

Added in API level 1

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

Returns
  • the serif font family name as a string

public abstract String getStandardFontFamily ()

Added in API level 1

Gets the standard font family name.

Returns
  • the standard font family name as a string

public synchronized WebSettings.TextSize getTextSize ()

Added in API level 1

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.

Returns

public abstract int getTextZoom ()

Added in API level 14

Gets the text zoom of the page in percent.

Returns
  • the text zoom of the page in percent
See Also

public abstract boolean getUseWideViewPort ()

Added in API level 1

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

Returns
  • true if the WebView supports the viewport meta tag

public abstract String getUserAgentString ()

Added in API level 3

Gets the WebView's user-agent string.

Returns
  • the WebView's user-agent string

public abstract void setAllowContentAccess (boolean allow)

Added in API level 11

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.

public abstract void setAllowFileAccess (boolean allow)

Added in API level 3

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.

public abstract void setAllowFileAccessFromFileURLs (boolean flag)

Added in API level 16

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.

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

Parameters
flag whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs

public abstract void setAllowUniversalAccessFromFileURLs (boolean flag)

Added in API level 16

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.

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

Parameters
flag whether JavaScript running in the context of a file scheme URL should be allowed to access content from any origin

public abstract void setAppCacheEnabled (boolean flag)

Added in API level 7

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).

Parameters
flag true if the WebView should enable Application Caches

public abstract void setAppCacheMaxSize (long appCacheMaxSize)

Added in API level 7

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.

Parameters
appCacheMaxSize the maximum size in bytes

public abstract void setAppCachePath (String appCachePath)

Added in API level 7

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.

Parameters
appCachePath a String path to the directory containing Application Caches files.

public abstract void setBlockNetworkImage (boolean flag)

Added in API level 1

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.

Parameters
flag whether the WebView should not load image resources from the network

public abstract void setBlockNetworkLoads (boolean flag)

Added in API level 8

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.

Parameters
flag whether the WebView should not load any resources from the network
See Also

public abstract void setBuiltInZoomControls (boolean enabled)

Added in API level 3

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.

Parameters
enabled whether the WebView should use its built-in zoom mechanisms

public abstract void setCacheMode (int mode)

Added in API level 1

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.

Parameters
mode the mode to use

public abstract void setCursiveFontFamily (String font)

Added in API level 1

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

Parameters
font a font family name

public abstract void setDatabaseEnabled (boolean flag)

Added in API level 5

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.

Parameters
flag true if the WebView should use the database storage API

public abstract void setDatabasePath (String databasePath)

Added in API level 5

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.

Parameters
databasePath a path to the directory where databases should be saved.

public abstract void setDefaultFixedFontSize (int size)

Added in API level 1

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

Parameters
size a non-negative integer between 1 and 72. Any number outside the specified range will be pinned.

public abstract void setDefaultFontSize (int size)

Added in API level 1

Sets the default font size. The default is 16.

Parameters
size a non-negative integer between 1 and 72. Any number outside the specified range will be pinned.

public abstract void setDefaultTextEncodingName (String encoding)

Added in API level 1

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

Parameters
encoding the text encoding name

public abstract void setDefaultZoom (WebSettings.ZoomDensity zoom)

Added in API level 7

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.

Parameters
zoom the zoom density

public abstract void setDisplayZoomControls (boolean enabled)

Added in API level 11

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

Parameters
enabled whether the WebView should display on-screen zoom controls

public abstract void setDomStorageEnabled (boolean flag)

Added in API level 7

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

Parameters
flag true if the WebView should use the DOM storage API

public abstract void setEnableSmoothTransition (boolean enable)

Added in API level 11

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.

public abstract void setFantasyFontFamily (String font)

Added in API level 1

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

Parameters
font a font family name

public abstract void setFixedFontFamily (String font)

Added in API level 1

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

Parameters
font a font family name

public abstract void setGeolocationDatabasePath (String databasePath)

Added in API level 5

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.

Parameters
databasePath a path to the directory where databases should be saved.

public abstract void setGeolocationEnabled (boolean flag)

Added in API level 5

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:

As an option, it is possible to store previous locations and web origin permissions in a database. See setGeolocationDatabasePath(String).

Parameters
flag whether Geolocation should be enabled

public abstract void setJavaScriptCanOpenWindowsAutomatically (boolean flag)

Added in API level 1

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

Parameters
flag true if JavaScript can open windows automatically

public abstract void setJavaScriptEnabled (boolean flag)

Added in API level 1

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

Parameters
flag true if the WebView should execute JavaScript

public abstract void setLayoutAlgorithm (WebSettings.LayoutAlgorithm l)

Added in API level 1

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

Parameters
l the layout algorithm to use, as a WebSettings.LayoutAlgorithm value

public abstract void setLightTouchEnabled (boolean enabled)

Added in API level 1

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.

public abstract void setLoadWithOverviewMode (boolean overview)

Added in API level 7

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.

public abstract void setLoadsImagesAutomatically (boolean flag)

Added in API level 1

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.

Parameters
flag whether the WebView should load image resources

public abstract void setMediaPlaybackRequiresUserGesture (boolean require)

Added in API level 17

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

Parameters
require whether the WebView requires a user gesture to play media

public abstract void setMinimumFontSize (int size)

Added in API level 1

Sets the minimum font size. The default is 8.

Parameters
size a non-negative integer between 1 and 72. Any number outside the specified range will be pinned.

public abstract void setMinimumLogicalFontSize (int size)

Added in API level 1

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

Parameters
size a non-negative integer between 1 and 72. Any number outside the specified range will be pinned.

public abstract void setMixedContentMode (int mode)

Added in API level 21

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.

Parameters
mode The mixed content mode to use. One of MIXED_CONTENT_NEVER_ALLOW, MIXED_CONTENT_NEVER_ALLOW or MIXED_CONTENT_COMPATIBILITY_MODE.

public abstract void setNeedInitialFocus (boolean flag)

Added in API level 1

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.

Parameters
flag whether the WebView needs to set a node

public abstract void setPluginState (WebSettings.PluginState state)

Added in API level 8

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.

Parameters
state a PluginState value

public abstract void setRenderPriority (WebSettings.RenderPriority priority)

Added in API level 1

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.

Parameters
priority the priority

public abstract void setSansSerifFontFamily (String font)

Added in API level 1

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

Parameters
font a font family name

public abstract void setSaveFormData (boolean save)

Added in API level 1

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

public abstract void setSavePassword (boolean save)

Added in API level 1

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.

public abstract void setSerifFontFamily (String font)

Added in API level 1

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

Parameters
font a font family name

public abstract void setStandardFontFamily (String font)

Added in API level 1

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

Parameters
font a font family name

public abstract void setSupportMultipleWindows (boolean support)

Added in API level 1

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.

Parameters
support whether to suport multiple windows

public abstract void setSupportZoom (boolean support)

Added in API level 1

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.

Parameters
support whether the WebView should support zoom

public synchronized void setTextSize (WebSettings.TextSize t)

Added in API level 1

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

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

Parameters
t the text size as a WebSettings.TextSize value

public abstract void setTextZoom (int textZoom)

Added in API level 14

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

Parameters
textZoom the text zoom in percent

public abstract void setUseWideViewPort (boolean use)

Added in API level 1

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.

Parameters
use whether to enable support for the viewport meta tag

public abstract void setUserAgentString (String ua)

Added in API level 3

Sets the WebView's user-agent string. If the string is null or empty, the system default value will be used.

public abstract boolean supportMultipleWindows ()

Added in API level 1

Gets whether the WebView supports multiple windows.

Returns
  • true if the WebView supports multiple windows

public abstract boolean supportZoom ()

Added in API level 1

Gets whether the WebView supports zoom.

Returns
  • true if the WebView supports zoom