to top
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.
Public Methods

? Examples 		boolean enableSmoothTransition()
This method was deprecated in API level 17. This method is now obsolete, and will become a no-op in future.

? Examples 		boolean getAllowContentAccess()
Gets whether this WebView supports content URL access.

? Examples 		boolean getAllowFileAccess()
Gets whether this WebView supports file access.

? Examples 		abstract boolean getAllowFileAccessFromFileURLs()
Gets whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs.

? Examples 		abstract boolean getAllowUniversalAccessFromFileURLs()
Gets whether JavaScript running in the context of a file scheme URL can access content from any origin.

? Examples 		synchronized boolean getBlockNetworkImage()
Gets whether the WebView does not load image resources from the network.

? Examples 		synchronized boolean getBlockNetworkLoads()
Gets whether the WebView does not load any resources from the network.

? Examples 		boolean getBuiltInZoomControls()
Gets whether the zoom mechanisms built into WebView are being used.

? Examples 		int getCacheMode()
Gets the current setting for overriding the cache mode.

? Examples 		synchronized String getCursiveFontFamily()
Gets the cursive font family name.

? Examples 		synchronized boolean getDatabaseEnabled()
Gets whether the database storage API is enabled.

? Examples 		synchronized String getDatabasePath()
Gets the path to where database storage API databases are saved.

? Examples 		synchronized int getDefaultFixedFontSize()
Gets the default fixed font size.

? Examples 		synchronized int getDefaultFontSize()
Gets the default font size.

? Examples 		synchronized String getDefaultTextEncodingName()
Gets the default text encoding name.

? Examples 		static String getDefaultUserAgent( Context context)
Returns the default User-Agent used by a WebView.

? Examples 		WebSettings.ZoomDensity getDefaultZoom()
Gets the default zoom density of the page.

? Examples 		boolean getDisplayZoomControls()
Gets whether the WebView displays on-screen zoom controls when using the built-in zoom mechanisms.

? Examples 		synchronized boolean getDomStorageEnabled()
Gets whether the DOM Storage APIs are enabled.

? Examples 		synchronized String getFantasyFontFamily()
Gets the fantasy font family name.

? Examples 		synchronized String getFixedFontFamily()
Gets the fixed font family name.

? Examples 		synchronized boolean getJavaScriptCanOpenWindowsAutomatically()
Gets whether JavaScript can open windows automatically.

? Examples 		synchronized boolean getJavaScriptEnabled()
Gets whether JavaScript is enabled.

? Examples 		synchronized WebSettings.LayoutAlgorithm getLayoutAlgorithm()
Gets the current layout algorithm.

? Examples 		boolean getLightTouchEnabled()
Gets whether light touches are enabled.

? Examples 		boolean getLoadWithOverviewMode()
Gets whether this WebView loads pages in overview mode.

? Examples 		synchronized boolean getLoadsImagesAutomatically()
Gets whether the WebView loads image resources.

? Examples 		boolean getMediaPlaybackRequiresUserGesture()
Gets whether the WebView requires a user gesture to play media.

? Examples 		synchronized int getMinimumFontSize()
Gets the minimum font size.

? Examples 		synchronized int getMinimumLogicalFontSize()
Gets the minimum logical font size.

? Examples 		synchronized WebSettings.PluginState getPluginState()
Gets the current state regarding whether plugins are enabled.

? Examples 		synchronized boolean getPluginsEnabled()
This method was deprecated in API level 8. This method has been replaced by getPluginState()

? Examples 		synchronized String getPluginsPath()
This method was deprecated in API level 9. This method is no longer used as plugins are loaded from their own APK via the system's package manager.

? Examples 		synchronized String getSansSerifFontFamily()
Gets the sans-serif font family name.

? Examples 		boolean getSaveFormData()
Gets whether the WebView saves form data.

? Examples 		boolean getSavePassword()
Gets whether the WebView saves passwords.

? Examples 		synchronized String getSerifFontFamily()
Gets the serif font family name.

? Examples 		synchronized String getStandardFontFamily()
Gets the standard font family name.

? Examples 		synchronized WebSettings.TextSize getTextSize()
This method was deprecated in API level 14. Use getTextZoom() instead.

? Examples 		synchronized int getTextZoom()
Gets the text zoom of the page in percent.

? Examples 		synchronized boolean getUseWideViewPort()
Gets whether the WebView is using a wide viewport.

? Examples 		synchronized String getUserAgentString()
Gets the WebView's user-agent string.

? Examples 		void setAllowContentAccess(boolean allow)
Enables or disables content URL access within WebView.

? Examples 		void setAllowFileAccess(boolean allow)
Enables or disables file access within WebView.

? Examples 		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.

? Examples 		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.

? Examples 		synchronized void setAppCacheEnabled(boolean flag)
Sets whether the Application Caches API should be enabled.

? Examples 		synchronized void setAppCacheMaxSize(long appCacheMaxSize)
Sets the maximum size for the Application Cache content.

? Examples 		synchronized void setAppCachePath( String appCachePath)
Sets the path to the Application Caches files.

? Examples 		synchronized void setBlockNetworkImage(boolean flag)
Sets whether the WebView should not load image resources from the network (resources accessed via http and https URI schemes).

? Examples 		synchronized void setBlockNetworkLoads(boolean flag)
Sets whether the WebView should not load resources from the network.

? Examples 		void setBuiltInZoomControls(boolean enabled)
Sets whether the WebView should use its built-in zoom mechanisms.

? Examples 		void setCacheMode(int mode)
Overrides the way the cache is used.

? Examples 		synchronized void setCursiveFontFamily( String font)
Sets the cursive font family name.

? Examples 		synchronized void setDatabaseEnabled(boolean flag)
Sets whether the database storage API is enabled.

? Examples 		synchronized void setDatabasePath( String databasePath)
Sets the path to where database storage API databases should be saved.

? Examples 		synchronized void setDefaultFixedFontSize(int size)
Sets the default fixed font size.

? Examples 		synchronized void setDefaultFontSize(int size)
Sets the default font size.

? Examples 		synchronized void setDefaultTextEncodingName( String encoding)
Sets the default text encoding name to use when decoding html pages.

? Examples 		void setDefaultZoom( WebSettings.ZoomDensity zoom)
Sets the default zoom density of the page.

? Examples 		void setDisplayZoomControls(boolean enabled)
Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms.

? Examples 		synchronized void setDomStorageEnabled(boolean flag)
Sets whether the DOM storage API is enabled.

? Examples 		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.

? Examples 		synchronized void setFantasyFontFamily( String font)
Sets the fantasy font family name.

? Examples 		synchronized void setFixedFontFamily( String font)
Sets the fixed font family name.

? Examples 		synchronized void setGeolocationDatabasePath( String databasePath)
Sets the path where the Geolocation databases should be saved.

? Examples 		synchronized void setGeolocationEnabled(boolean flag)
Sets whether Geolocation is enabled.

? Examples 		synchronized void setJavaScriptCanOpenWindowsAutomatically(boolean flag)
Tells JavaScript to open windows automatically.

? Examples 		synchronized void setJavaScriptEnabled(boolean flag)
Tells the WebView to enable JavaScript execution.

? Examples 		synchronized void setLayoutAlgorithm( WebSettings.LayoutAlgorithm l)
Sets the underlying layout algorithm.

? Examples 		void setLightTouchEnabled(boolean enabled)
Enables using light touches to make a selection and activate mouseovers.

? Examples 		void setLoadWithOverviewMode(boolean overview)
Sets whether the WebView loads pages in overview mode.

? Examples 		synchronized void setLoadsImagesAutomatically(boolean flag)
Sets whether the WebView should load image resources.

? Examples 		void setMediaPlaybackRequiresUserGesture(boolean require)
Sets whether the WebView requires a user gesture to play media.

? Examples 		synchronized void setMinimumFontSize(int size)
Sets the minimum font size.

? Examples 		synchronized void setMinimumLogicalFontSize(int size)
Sets the minimum logical font size.

? Examples 		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.

? Examples 		synchronized void setPluginState( WebSettings.PluginState state)
Tells the WebView to enable, disable, or have plugins on demand.

? Examples 		synchronized void setPluginsEnabled(boolean flag)
This method was deprecated in API level 8. This method has been deprecated in favor of setPluginState(WebSettings.PluginState)

? Examples 		synchronized void setPluginsPath( String pluginsPath)
This method was deprecated in API level 9. This method is no longer used as plugins are loaded from their own APK via the system's package manager.

? Examples 		synchronized void setRenderPriority( WebSettings.RenderPriority priority)
Sets the priority of the Render thread.

? Examples 		synchronized void setSansSerifFontFamily( String font)
Sets the sans-serif font family name.

? Examples 		void setSaveFormData(boolean save)
Sets whether the WebView should save form data.

? Examples 		void setSavePassword(boolean save)
Sets whether the WebView should save passwords.

? Examples 		synchronized void setSerifFontFamily( String font)
Sets the serif font family name.

? Examples 		synchronized void setStandardFontFamily( String font)
Sets the standard font family name.

? Examples 		synchronized void setSupportMultipleWindows(boolean support)
Sets whether the WebView whether supports multiple windows.

? Examples 		void setSupportZoom(boolean support)
Sets whether the WebView should support zooming using its on-screen zoom controls and gestures.

? Examples 		synchronized void setTextSize( WebSettings.TextSize t)
This method was deprecated in API level 14. Use setTextZoom(int) instead.

? Examples 		synchronized void setTextZoom(int textZoom)
Sets the text zoom of the page in percent.

? Examples 		synchronized void setUseWideViewPort(boolean use)
Tells the WebView to use a wide viewport.

? Examples 		synchronized void setUserAgentString( String ua)
Sets the WebView's user-agent string.

? Examples 		synchronized boolean supportMultipleWindows()
Gets whether the WebView supports multiple windows.

? Examples 		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 Methods

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

See Also

public boolean getAllowContentAccess ()

Added in API level 11

Gets whether this WebView supports content URL access.

See Also

public boolean getAllowFileAccess ()

Added in API level 3

Gets whether this WebView supports file access.

See Also

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
See Also

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
See Also

public synchronized 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
See Also

public synchronized 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
See Also

public 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
See Also

public 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
See Also

public synchronized String getCursiveFontFamily ()

Added in API level 1

Gets the cursive font family name.

Returns
  • the cursive font family name as a string
See Also

public synchronized boolean getDatabaseEnabled ()

Added in API level 5

Gets whether the database storage API is enabled.

Returns
  • true if the database storage API is enabled
See Also

public synchronized String getDatabasePath ()

Added in API level 5

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

Returns
  • the String path to the database storage API databases
See Also

public synchronized int getDefaultFixedFontSize ()

Added in API level 1

Gets the default fixed font size.

Returns
  • a non-negative integer between 1 and 72
See Also

public synchronized int getDefaultFontSize ()

Added in API level 1

Gets the default font size.

Returns
  • a non-negative integer between 1 and 72
See Also

public synchronized String getDefaultTextEncodingName ()

Added in API level 1

Gets the default text encoding name.

Returns
  • the default text encoding name as a string
See Also

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 WebSettings.ZoomDensity getDefaultZoom ()

Added in API level 7

Gets the default zoom density of the page. This should be called from the UI thread.

Returns
  • the zoom density
See Also

public 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
See Also

public synchronized boolean getDomStorageEnabled ()

Added in API level 7

Gets whether the DOM Storage APIs are enabled.

Returns
  • true if the DOM Storage APIs are enabled
See Also

public synchronized String getFantasyFontFamily ()

Added in API level 1

Gets the fantasy font family name.

Returns
  • the fantasy font family name as a string
See Also

public synchronized String getFixedFontFamily ()

Added in API level 1

Gets the fixed font family name.

Returns
  • the fixed font family name as a string
See Also

public synchronized 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()
See Also

public synchronized boolean getJavaScriptEnabled ()

Added in API level 1

Gets whether JavaScript is enabled.

Returns
  • true if JavaScript is enabled
See Also

public synchronized WebSettings.LayoutAlgorithm getLayoutAlgorithm ()

Added in API level 1

Gets the current layout algorithm.

Returns
See Also

public boolean getLightTouchEnabled ()

Added in API level 1

Gets whether light touches are enabled.

Returns
  • whether light touches are enabled
See Also

public 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
See Also

public synchronized 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
See Also

public 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
See Also

public synchronized int getMinimumFontSize ()

Added in API level 1

Gets the minimum font size.

Returns
  • a non-negative integer between 1 and 72
See Also

public synchronized int getMinimumLogicalFontSize ()

Added in API level 1

Gets the minimum logical font size.

Returns
  • a non-negative integer between 1 and 72
See Also

public synchronized WebSettings.PluginState getPluginState ()

Added in API level 8

Gets the current state regarding whether plugins are enabled.

Returns
See Also

public synchronized boolean getPluginsEnabled ()

Added in API level 1

This method was deprecated in API level 8.
This method has been replaced by getPluginState()

Gets whether plugins are enabled.

Returns
  • true if plugins are enabled
See Also

public synchronized String getPluginsPath ()

Added in API level 1

This method was deprecated in API level 9.
This method is no longer used as plugins are loaded from their own APK via the system's package manager.

Gets the directory that contains the plugin libraries. This method is obsolete since each plugin is now loaded from its own package.

Returns
  • an empty string

public synchronized String getSansSerifFontFamily ()

Added in API level 1

Gets the sans-serif font family name.

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

public boolean getSaveFormData ()

Added in API level 1

Gets whether the WebView saves form data. Always false in private browsing mode.

Returns
  • whether the WebView saves form data
See Also

public boolean getSavePassword ()

Added in API level 1

Gets whether the WebView saves passwords.

Returns
  • whether the WebView saves passwords
See Also

public synchronized 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
See Also

public synchronized String getStandardFontFamily ()

Added in API level 1

Gets the standard font family name.

Returns
  • the standard font family name as a string
See Also

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
See Also

public synchronized 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 synchronized boolean getUseWideViewPort ()

Added in API level 1

Gets whether the WebView is using a wide viewport.

Returns
  • true if the WebView is using a wide viewport
See Also

public synchronized String getUserAgentString ()

Added in API level 3

Gets the WebView's user-agent string.

Returns
  • the WebView's user-agent string
See Also

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

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.

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 synchronized 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 synchronized void setAppCacheMaxSize (long appCacheMaxSize)

Added in API level 7

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.

Parameters
appCacheMaxSize the maximum size in bytes

public synchronized 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.
See Also

public synchronized 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
See Also

public synchronized 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 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 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_NORMAL, LOAD_CACHE_ELSE_NETWORK, LOAD_NO_CACHE or LOAD_CACHE_ONLY. The default value is LOAD_DEFAULT.

Parameters
mode the mode to use

public synchronized 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 synchronized 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.

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

public synchronized void setDatabasePath (String databasePath)

Added in API level 5

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 synchronized 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 synchronized 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 synchronized void setDefaultTextEncodingName (String encoding)

Added in API level 1

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

Parameters
encoding the text encoding name

public void setDefaultZoom (WebSettings.ZoomDensity zoom)

Added in API level 7

Sets the default zoom density of the page. This must be called from the UI thread. The default is MEDIUM.

Parameters
zoom the zoom density

public 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 synchronized 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 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 synchronized 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 synchronized 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 synchronized 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 synchronized void setGeolocationEnabled (boolean flag)

Added in API level 5

Sets whether Geolocation is enabled. The default is true. See also setGeolocationDatabasePath(String) for how to correctly set up Geolocation.

Parameters
flag whether Geolocation should be enabled

public synchronized 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 synchronized 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 synchronized 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 void setLightTouchEnabled (boolean enabled)

Added in API level 1

Enables using light touches to make a selection and activate mouseovers. The default is false.

public void setLoadWithOverviewMode (boolean overview)

Added in API level 7

Sets whether the WebView loads pages in overview mode. The default is false.

public synchronized 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 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 synchronized 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 synchronized 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 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 synchronized void setPluginState (WebSettings.PluginState state)

Added in API level 8

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 synchronized void setPluginsEnabled (boolean flag)

Added in API level 1

This method was deprecated in API level 8.
This method has been deprecated in favor of setPluginState(WebSettings.PluginState)

Sets whether the WebView should enable plugins. The default is false.

Parameters
flag true if plugins should be enabled

public synchronized void setPluginsPath (String pluginsPath)

Added in API level 1

This method was deprecated in API level 9.
This method is no longer used as plugins are loaded from their own APK via the system's package manager.

Sets a custom path to plugins used by the WebView. This method is obsolete since each plugin is now loaded from its own package.

Parameters
pluginsPath a String path to the directory containing plugins

public synchronized void setRenderPriority (WebSettings.RenderPriority priority)

Added in API level 1

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 synchronized 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 void setSaveFormData (boolean save)

Added in API level 1

Sets whether the WebView should save form data. The default is true, unless in private browsing mode, when the value is always false.

public void setSavePassword (boolean save)

Added in API level 1

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

public synchronized 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 synchronized 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 synchronized 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 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 synchronized 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 synchronized void setUseWideViewPort (boolean use)

Added in API level 1

Tells the WebView to use a wide viewport. The default is false.

Parameters
use whether to use a wide viewport

public synchronized 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 synchronized boolean supportMultipleWindows ()

Added in API level 1

Gets whether the WebView supports multiple windows.

Returns
  • true if the WebView supports multiple windows
See Also

public boolean supportZoom ()

Added in API level 1

Gets whether the WebView supports zoom.

Returns
  • true if the WebView supports zoom
See Also
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.