WebSettings
abstract class WebSettings
kotlin.Any | |
↳ | android.webkit.WebSettings |
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 for controlling the layout of html. |
|
The plugin state effects how plugins are treated on a page. |
|
Enum for specifying the text size. |
|
Enum for specifying the WebView's desired density. |
Constants | |
---|---|
static Int |
Enable force dark dependent on the state of the WebView parent view. |
static Int |
Disable force dark, irrespective of the force dark mode of the WebView parent. |
static Int |
Unconditionally enable force dark. |
static Int |
Use cached resources when they are available, even if they have expired. |
static Int |
Don't use the network, load from the cache. |
static Int |
Default cache usage mode. |
static Int |
Normal cache usage mode. |
static Int |
Don't use the cache, load from the network. |
static Int |
No menu items should be disabled. |
static Int |
Disable all the action mode menu items for text processing. |
static Int |
Disable menu item "Share". |
static Int |
Disable menu item "Web Search". |
static Int |
In this mode, the WebView will allow a secure origin to load content from any other origin, even if that origin is insecure. |
static Int |
In this mode, the WebView will attempt to be compatible with the approach of a modern web browser with regard to mixed content. |
static Int |
In this mode, the WebView will not allow a secure origin to load content from an insecure origin. |
Public constructors | |
---|---|
Public methods | |
---|---|
abstract Boolean |
Gets whether the WebView enables smooth transition while panning or zooming. |
abstract Boolean |
Gets whether this WebView supports content URL access. |
abstract Boolean |
Gets whether this WebView supports file access. |
abstract Boolean |
Gets whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs. |
abstract Boolean |
Gets whether JavaScript running in the context of a file scheme URL can access content from any origin. |
abstract Boolean |
Gets whether the WebView does not load image resources from the network. |
abstract Boolean |
Gets whether the WebView does not load any resources from the network. |
abstract Boolean |
Gets whether the zoom mechanisms built into WebView are being used. |
abstract Int |
Gets the current setting for overriding the cache mode. |
abstract String! |
Gets the cursive font family name. |
abstract Boolean |
Gets whether the database storage API is enabled. |
abstract String! |
Gets the path to where database storage API databases are saved. |
abstract Int |
Gets the default fixed font size. |
abstract Int |
Gets the default font size. |
abstract String! |
Gets the default text encoding name. |
open static String! |
getDefaultUserAgent(context: Context!) Returns the default User-Agent used by a WebView. |
abstract WebSettings.ZoomDensity! |
Gets the default zoom density of the page. |
abstract Int |
Gets the action mode menu items that are disabled, expressed in an integer field flag. |
abstract Boolean |
Gets whether the WebView displays on-screen zoom controls when using the built-in zoom mechanisms. |
abstract Boolean |
Gets whether the DOM Storage APIs are enabled. |
abstract String! |
Gets the fantasy font family name. |
abstract String! |
Gets the fixed font family name. |
open Int |
Get the force dark mode for this WebView. |
abstract Boolean |
Gets whether JavaScript can open windows automatically. |
abstract Boolean |
Gets whether JavaScript is enabled. |
abstract WebSettings.LayoutAlgorithm! |
Gets the current layout algorithm. |
abstract Boolean |
Gets whether light touches are enabled. |
abstract Boolean |
Gets whether this WebView loads pages in overview mode. |
abstract Boolean |
Gets whether the WebView loads image resources. |
abstract Boolean |
Gets whether the WebView requires a user gesture to play media. |
abstract Int |
Gets the minimum font size. |
abstract Int |
Gets the minimum logical font size. |
abstract Int |
Gets the current behavior of the WebView with regard to loading insecure content from a secure origin. |
abstract Boolean |
Gets whether this WebView should raster tiles when it is offscreen but attached to a window. |
abstract WebSettings.PluginState! |
Gets the current state regarding whether plugins are enabled. |
abstract Boolean |
Gets whether Safe Browsing is enabled. |
abstract String! |
Gets the sans-serif font family name. |
abstract Boolean |
Gets whether the WebView saves form data. |
abstract Boolean |
Gets whether the WebView saves passwords. |
abstract String! |
Gets the serif font family name. |
abstract String! |
Gets the standard font family name. |
open WebSettings.TextSize! |
Gets the text size of the page. |
abstract Int |
Gets the text zoom of the page in percent. |
abstract Boolean |
Gets whether the WebView supports the "viewport" HTML meta tag or will use a wide viewport. |
abstract String! |
Gets the WebView's user-agent string. |
open Boolean |
Get if algorithmic darkening is allowed or not for this WebView. |
open Unit |
Control whether algorithmic darkening is allowed. |
abstract Unit |
setAllowContentAccess(allow: Boolean) Enables or disables content URL access within WebView. |
abstract Unit |
setAllowFileAccess(allow: Boolean) Enables or disables file access within WebView. |
abstract Unit |
Sets whether cross-origin requests in the context of a file scheme URL should be allowed to access content from other file scheme URLs. |
abstract Unit |
Sets whether cross-origin requests in the context of a file scheme URL should be allowed to access content from any origin. |
abstract Unit |
setBlockNetworkImage(flag: Boolean) Sets whether the WebView should not load image resources from the network (resources accessed via http and https URI schemes). |
abstract Unit |
setBlockNetworkLoads(flag: Boolean) Sets whether the WebView should not load resources from the network. |
abstract Unit |
setBuiltInZoomControls(enabled: Boolean) Sets whether the WebView should use its built-in zoom mechanisms. |
abstract Unit |
setCacheMode(mode: Int) Overrides the way the cache is used. |
abstract Unit |
setCursiveFontFamily(font: String!) Sets the cursive font family name. |
abstract Unit |
setDatabaseEnabled(flag: Boolean) Sets whether the database storage API is enabled. |
abstract Unit |
setDatabasePath(databasePath: String!) Sets the path to where database storage API databases should be saved. |
abstract Unit |
setDefaultFixedFontSize(size: Int) Sets the default fixed font size. |
abstract Unit |
setDefaultFontSize(size: Int) Sets the default font size. |
abstract Unit |
setDefaultTextEncodingName(encoding: String!) Sets the default text encoding name to use when decoding html pages. |
abstract Unit |
Sets the default zoom density of the page. |
abstract Unit |
Disables the action mode menu items according to |
abstract Unit |
setDisplayZoomControls(enabled: Boolean) Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms. |
abstract Unit |
setDomStorageEnabled(flag: Boolean) Sets whether the DOM storage API is enabled. |
abstract Unit |
setEnableSmoothTransition(enable: Boolean) Sets whether the WebView will enable smooth transition while panning or zooming or while the window hosting the WebView does not have focus. |
abstract Unit |
setFantasyFontFamily(font: String!) Sets the fantasy font family name. |
abstract Unit |
setFixedFontFamily(font: String!) Sets the fixed font family name. |
open Unit |
setForceDark(forceDark: Int) Set the force dark mode for this WebView. |
abstract Unit |
setGeolocationDatabasePath(databasePath: String!) Sets the path where the Geolocation databases should be saved. |
abstract Unit |
setGeolocationEnabled(flag: Boolean) Sets whether Geolocation is enabled. |
abstract Unit |
Tells JavaScript to open windows automatically. |
abstract Unit |
setJavaScriptEnabled(flag: Boolean) Tells the WebView to enable JavaScript execution. |
abstract Unit |
Sets the underlying layout algorithm. |
abstract Unit |
setLightTouchEnabled(enabled: Boolean) Enables using light touches to make a selection and activate mouseovers. |
abstract Unit |
setLoadWithOverviewMode(overview: Boolean) Sets whether the WebView loads pages in overview mode, that is, zooms out the content to fit on screen by width. |
abstract Unit |
Sets whether the WebView should load image resources. |
abstract Unit |
setMediaPlaybackRequiresUserGesture(require: Boolean) Sets whether the WebView requires a user gesture to play media. |
abstract Unit |
setMinimumFontSize(size: Int) Sets the minimum font size. |
abstract Unit |
setMinimumLogicalFontSize(size: Int) Sets the minimum logical font size. |
abstract Unit |
setMixedContentMode(mode: Int) Configures the WebView's behavior when a secure origin attempts to load a resource from an insecure origin. |
abstract Unit |
setNeedInitialFocus(flag: Boolean) Tells the WebView whether it needs to set a node to have focus when android. |
abstract Unit |
setOffscreenPreRaster(enabled: Boolean) Sets whether this WebView should raster tiles when it is offscreen but attached to a window. |
abstract Unit |
setPluginState(state: WebSettings.PluginState!) Tells the WebView to enable, disable, or have plugins on demand. |
abstract Unit |
setRenderPriority(priority: WebSettings.RenderPriority!) Sets the priority of the Render thread. |
abstract Unit |
setSafeBrowsingEnabled(enabled: Boolean) Sets whether Safe Browsing is enabled. |
abstract Unit |
setSansSerifFontFamily(font: String!) Sets the sans-serif font family name. |
abstract Unit |
setSaveFormData(save: Boolean) Sets whether the WebView should save form data. |
abstract Unit |
setSavePassword(save: Boolean) Sets whether the WebView should save passwords. |
abstract Unit |
setSerifFontFamily(font: String!) Sets the serif font family name. |
abstract Unit |
setStandardFontFamily(font: String!) Sets the standard font family name. |
abstract Unit |
setSupportMultipleWindows(support: Boolean) Sets whether the WebView whether supports multiple windows. |
abstract Unit |
setSupportZoom(support: Boolean) Sets whether the WebView should support zooming using its on-screen zoom controls and gestures. |
open Unit |
Sets the text size of the page. |
abstract Unit |
setTextZoom(textZoom: Int) Sets the text zoom of the page in percent. |
abstract Unit |
setUseWideViewPort(use: Boolean) Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. |
abstract Unit |
setUserAgentString(ua: String?) Sets the WebView's user-agent string. |
abstract Boolean |
Gets whether the WebView supports multiple windows. |
abstract Boolean |
Gets whether the WebView supports zoom. |
Constants
FORCE_DARK_AUTO
static valFORCE_DARK_AUTO: Int
Deprecated: refer to setForceDark
Enable force dark dependent on the state of the WebView parent view. If the WebView parent view is being automatically force darkened (see: android.view.View#setForceDarkAllowed
), then WebView content will be rendered so as to emulate a dark theme. WebViews that are not attached to the view hierarchy will not be inverted.
Value: 1
See Also
FORCE_DARK_OFF
static valFORCE_DARK_OFF: Int
Deprecated: refer to setForceDark
Disable force dark, irrespective of the force dark mode of the WebView parent. In this mode, WebView content will always be rendered as-is, regardless of whether native views are being automatically darkened.
Value: 0
See Also
FORCE_DARK_ON
static valFORCE_DARK_ON: Int
Deprecated: refer to setForceDark
Unconditionally enable force dark. In this mode WebView content will always be rendered so as to emulate a dark theme.
Value: 2
See Also
LOAD_CACHE_ELSE_NETWORK
static val LOAD_CACHE_ELSE_NETWORK: Int
Use cached resources when they are available, even if they have expired. Otherwise load resources from the network. Use with setCacheMode
.
Value: 1
LOAD_CACHE_ONLY
static val LOAD_CACHE_ONLY: Int
Don't use the network, load from the cache. Use with setCacheMode
.
Value: 3
LOAD_DEFAULT
static val LOAD_DEFAULT: Int
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
.
Value: -1
LOAD_NORMAL
static valLOAD_NORMAL: Int
Deprecated: This value is obsolete, as from API level android.os.Build.VERSION_CODES#HONEYCOMB
and onwards it has the same effect as LOAD_DEFAULT
.
Normal cache usage mode. Use with setCacheMode
.
Value: 0
LOAD_NO_CACHE
static val LOAD_NO_CACHE: Int
Don't use the cache, load from the network. Use with setCacheMode
.
Value: 2
MENU_ITEM_NONE
static val MENU_ITEM_NONE: Int
No menu items should be disabled.
Value: 0
See Also
MENU_ITEM_PROCESS_TEXT
static val MENU_ITEM_PROCESS_TEXT: Int
Disable all the action mode menu items for text processing. By default WebView searches for activities that are able to handle android.content.Intent#ACTION_PROCESS_TEXT
and show them in the action mode menu. If this flag is set via setDisabledActionModeMenuItems
, these menu items will be disabled.
Value: 4
See Also
MENU_ITEM_SHARE
static val MENU_ITEM_SHARE: Int
Disable menu item "Share".
Value: 1
See Also
MENU_ITEM_WEB_SEARCH
static val MENU_ITEM_WEB_SEARCH: Int
Disable menu item "Web Search".
Value: 2
See Also
MIXED_CONTENT_ALWAYS_ALLOW
static val MIXED_CONTENT_ALWAYS_ALLOW: 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.
Value: 0
See Also
MIXED_CONTENT_COMPATIBILITY_MODE
static val MIXED_CONTENT_COMPATIBILITY_MODE: 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
.
Value: 2
See Also
MIXED_CONTENT_NEVER_ALLOW
static val MIXED_CONTENT_NEVER_ALLOW: 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.
Value: 1
See Also
Public constructors
WebSettings
WebSettings()
Public methods
enableSmoothTransition
abstract funenableSmoothTransition(): Boolean
Deprecated: 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
getAllowContentAccess
abstract fun getAllowContentAccess(): Boolean
Gets whether this WebView supports content URL access.
See Also
getAllowFileAccess
abstract fun getAllowFileAccess(): Boolean
Gets whether this WebView supports file access.
See Also
getAllowFileAccessFromFileURLs
abstract fun getAllowFileAccessFromFileURLs(): Boolean
Gets whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs.
Return | |
---|---|
Boolean |
whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs |
See Also
getAllowUniversalAccessFromFileURLs
abstract fun getAllowUniversalAccessFromFileURLs(): Boolean
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.
Return | |
---|---|
Boolean |
whether JavaScript running in the context of a file scheme URL can access content from any origin |
See Also
getBlockNetworkImage
abstract fun getBlockNetworkImage(): Boolean
Gets whether the WebView does not load image resources from the network.
Return | |
---|---|
Boolean |
true if the WebView does not load image resources from the network |
See Also
getBlockNetworkLoads
abstract fun getBlockNetworkLoads(): Boolean
Gets whether the WebView does not load any resources from the network.
Return | |
---|---|
Boolean |
true if the WebView does not load any resources from the network |
See Also
getBuiltInZoomControls
abstract fun getBuiltInZoomControls(): Boolean
Gets whether the zoom mechanisms built into WebView are being used.
Return | |
---|---|
Boolean |
true if the zoom mechanisms built into WebView are being used |
See Also
getCacheMode
abstract fun getCacheMode(): Int
Gets the current setting for overriding the cache mode.
Return | |
---|---|
Int |
the current setting for overriding the cache mode Value is android.webkit.WebSettings#LOAD_DEFAULT , android.webkit.WebSettings#LOAD_NORMAL , android.webkit.WebSettings#LOAD_CACHE_ELSE_NETWORK , android.webkit.WebSettings#LOAD_NO_CACHE , or android.webkit.WebSettings#LOAD_CACHE_ONLY |
See Also
getCursiveFontFamily
abstract fun getCursiveFontFamily(): String!
Gets the cursive font family name.
Return | |
---|---|
String! |
the cursive font family name as a string |
See Also
getDatabaseEnabled
abstract fungetDatabaseEnabled(): Boolean
Deprecated: WebSQL is deprecated and this method will become a no-op on all Android versions once support is removed in Chromium. See https://developer.chrome.com/blog/deprecating-web-sql for more information.
Gets whether the database storage API is enabled.
Return | |
---|---|
Boolean |
true if the database storage API is enabled |
See Also
getDatabasePath
abstract fungetDatabasePath(): String!
Deprecated: Database paths are managed by the implementation this method is obsolete.
Gets the path to where database storage API databases are saved.
Return | |
---|---|
String! |
the String path to the database storage API databases |
See Also
getDefaultFixedFontSize
abstract fun getDefaultFixedFontSize(): Int
Gets the default fixed font size.
Return | |
---|---|
Int |
a non-negative integer between 1 and 72 |
See Also
getDefaultFontSize
abstract fun getDefaultFontSize(): Int
Gets the default font size.
Return | |
---|---|
Int |
a non-negative integer between 1 and 72 |
See Also
getDefaultTextEncodingName
abstract fun getDefaultTextEncodingName(): String!
Gets the default text encoding name.
Return | |
---|---|
String! |
the default text encoding name as a string |
See Also
getDefaultUserAgent
open static fun getDefaultUserAgent(context: Context!): String!
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 WebSettings#setUserAgentString(String)
.
Parameters | |
---|---|
context |
Context!: a Context object used to access application assets |
getDefaultZoom
abstract fungetDefaultZoom(): WebSettings.ZoomDensity!
Deprecated: 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.
Return | |
---|---|
WebSettings.ZoomDensity! |
the zoom density |
See Also
getDisabledActionModeMenuItems
abstract fun getDisabledActionModeMenuItems(): Int
Gets the action mode menu items that are disabled, expressed in an integer field flag. The default value is MENU_ITEM_NONE
Return | |
---|---|
Int |
all the disabled menu item flags combined with bitwise OR. Value is either 0 or a combination of android.webkit.WebSettings#MENU_ITEM_NONE , android.webkit.WebSettings#MENU_ITEM_SHARE , android.webkit.WebSettings#MENU_ITEM_WEB_SEARCH , and android.webkit.WebSettings#MENU_ITEM_PROCESS_TEXT |
getDisplayZoomControls
abstract fun getDisplayZoomControls(): Boolean
Gets whether the WebView displays on-screen zoom controls when using the built-in zoom mechanisms.
Return | |
---|---|
Boolean |
true if the WebView displays on-screen zoom controls when using the built-in zoom mechanisms |
See Also
getDomStorageEnabled
abstract fun getDomStorageEnabled(): Boolean
Gets whether the DOM Storage APIs are enabled.
Return | |
---|---|
Boolean |
true if the DOM Storage APIs are enabled |
See Also
getFantasyFontFamily
abstract fun getFantasyFontFamily(): String!
Gets the fantasy font family name.
Return | |
---|---|
String! |
the fantasy font family name as a string |
See Also
getFixedFontFamily
abstract fun getFixedFontFamily(): String!
Gets the fixed font family name.
Return | |
---|---|
String! |
the fixed font family name as a string |
See Also
getForceDark
open fungetForceDark(): Int
Deprecated: refer to setForceDark
.
Get the force dark mode for this WebView. The default force dark mode is FORCE_DARK_AUTO
.
Return | |
---|---|
Int |
the currently set force dark mode. Value is android.webkit.WebSettings#FORCE_DARK_OFF , android.webkit.WebSettings#FORCE_DARK_AUTO , or android.webkit.WebSettings#FORCE_DARK_ON |
See Also
getJavaScriptCanOpenWindowsAutomatically
abstract fun getJavaScriptCanOpenWindowsAutomatically(): Boolean
Gets whether JavaScript can open windows automatically.
Return | |
---|---|
Boolean |
true if JavaScript can open windows automatically during window.open() |
getJavaScriptEnabled
abstract fun getJavaScriptEnabled(): Boolean
Gets whether JavaScript is enabled.
Return | |
---|---|
Boolean |
true if JavaScript is enabled |
See Also
getLayoutAlgorithm
abstract fun getLayoutAlgorithm(): WebSettings.LayoutAlgorithm!
Gets the current layout algorithm.
Return | |
---|---|
WebSettings.LayoutAlgorithm! |
the layout algorithm in use, as a LayoutAlgorithm value |
See Also
getLightTouchEnabled
abstract fungetLightTouchEnabled(): Boolean
Deprecated: This setting is obsolete.
Gets whether light touches are enabled.
See Also
getLoadWithOverviewMode
abstract fun getLoadWithOverviewMode(): Boolean
Gets whether this WebView loads pages in overview mode.
Return | |
---|---|
Boolean |
whether this WebView loads pages in overview mode |
See Also
getLoadsImagesAutomatically
abstract fun getLoadsImagesAutomatically(): Boolean
Gets whether the WebView loads image resources. This includes images embedded using the data URI scheme.
Return | |
---|---|
Boolean |
true if the WebView loads image resources |
See Also
getMediaPlaybackRequiresUserGesture
abstract fun getMediaPlaybackRequiresUserGesture(): Boolean
Gets whether the WebView requires a user gesture to play media.
Return | |
---|---|
Boolean |
true if the WebView requires a user gesture to play media |
See Also
getMinimumFontSize
abstract fun getMinimumFontSize(): Int
Gets the minimum font size.
Return | |
---|---|
Int |
a non-negative integer between 1 and 72 |
See Also
getMinimumLogicalFontSize
abstract fun getMinimumLogicalFontSize(): Int
Gets the minimum logical font size.
Return | |
---|---|
Int |
a non-negative integer between 1 and 72 |
See Also
getMixedContentMode
abstract fun getMixedContentMode(): Int
Gets the current behavior of the WebView with regard to loading insecure content from a secure origin.
Return | |
---|---|
Int |
The current setting, one of MIXED_CONTENT_NEVER_ALLOW , MIXED_CONTENT_ALWAYS_ALLOW or MIXED_CONTENT_COMPATIBILITY_MODE . |
getOffscreenPreRaster
abstract fun getOffscreenPreRaster(): Boolean
Gets whether this WebView should raster tiles when it is offscreen but attached to a window.
Return | |
---|---|
Boolean |
true if this WebView will raster tiles when it is offscreen but attached to a window. |
getPluginState
abstract fungetPluginState(): WebSettings.PluginState!
Deprecated: Plugins are not supported in API level android.os.Build.VERSION_CODES#KITKAT
or later; enabling plugins is a no-op.
Gets the current state regarding whether plugins are enabled.
Return | |
---|---|
WebSettings.PluginState! |
the plugin state as a PluginState value |
See Also
getSafeBrowsingEnabled
abstract fun getSafeBrowsingEnabled(): Boolean
Gets whether Safe Browsing is enabled. See setSafeBrowsingEnabled
.
Return | |
---|---|
Boolean |
true if Safe Browsing is enabled and false otherwise. |
getSansSerifFontFamily
abstract fun getSansSerifFontFamily(): String!
Gets the sans-serif font family name.
Return | |
---|---|
String! |
the sans-serif font family name as a string |
See Also
getSaveFormData
abstract fungetSaveFormData(): Boolean
Deprecated: Deprecated in Java.
Gets whether the WebView saves form data.
Return | |
---|---|
Boolean |
whether the WebView saves form data |
See Also
getSavePassword
abstract fungetSavePassword(): Boolean
Deprecated: Saving passwords in WebView will not be supported in future versions.
Gets whether the WebView saves passwords.
Return | |
---|---|
Boolean |
whether the WebView saves passwords |
See Also
getSerifFontFamily
abstract fun getSerifFontFamily(): String!
Gets the serif font family name. The default is "serif".
Return | |
---|---|
String! |
the serif font family name as a string |
See Also
getStandardFontFamily
abstract fun getStandardFontFamily(): String!
Gets the standard font family name.
Return | |
---|---|
String! |
the standard font family name as a string |
See Also
getTextSize
open fungetTextSize(): WebSettings.TextSize!
Deprecated: Use getTextZoom
instead.
Gets the text size of the page. If the text size was previously specified in percent using setTextZoom
, this will return the closest matching TextSize
.
Return | |
---|---|
WebSettings.TextSize! |
the text size as a TextSize value |
See Also
getTextZoom
abstract fun getTextZoom(): Int
Gets the text zoom of the page in percent.
Return | |
---|---|
Int |
the text zoom of the page in percent |
See Also
getUseWideViewPort
abstract fun getUseWideViewPort(): Boolean
Gets whether the WebView supports the "viewport" HTML meta tag or will use a wide viewport.
Return | |
---|---|
Boolean |
true if the WebView supports the viewport meta tag |
See Also
getUserAgentString
abstract fun getUserAgentString(): String!
Gets the WebView's user-agent string.
Return | |
---|---|
String! |
the WebView's user-agent string |
See Also
isAlgorithmicDarkeningAllowed
open fun isAlgorithmicDarkeningAllowed(): Boolean
Get if algorithmic darkening is allowed or not for this WebView. The default is false.
Return | |
---|---|
Boolean |
if the algorithmic darkening is allowed or not. |
See Also
setAlgorithmicDarkeningAllowed
open fun setAlgorithmicDarkeningAllowed(allow: Boolean): Unit
Control whether algorithmic darkening is allowed.
Note: This API and the behaviour described only apply to apps with targetSdkVersion
≥ android.os.Build.VERSION_CODES#TIRAMISU
.
WebView always sets the media query prefers-color-scheme
according to the app's theme attribute isLightTheme
, i.e. prefers-color-scheme
is light
if isLightTheme is true or not specified, otherwise it is dark
. This means that the web content's light or dark style will be applied automatically to match the app's theme if the content supports it.
Algorithmic darkening is disallowed by default.
If the app's theme is dark and it allows algorithmic darkening, WebView will attempt to darken web content using an algorithm, if the content doesn't define its own dark styles and doesn't explicitly disable darkening.
If Android is applying Force Dark to WebView then WebView will ignore the value of this setting and behave as if it were set to true.
The deprecated setForceDark
and related API are no-ops in apps with targetSdkVersion
≥ android.os.Build.VERSION_CODES#TIRAMISU
, but they still apply to apps with targetSdkVersion
< android.os.Build.VERSION_CODES#TIRAMISU
.
The below table summarizes how APIs work with different apps.
App | Web content which uses prefers-color-scheme |
Web content which does not use prefers-color-scheme |
---|---|---|
App with isLightTheme True or not set |
Renders with the light theme defined by the content author. | Renders with the default styling defined by the content author. |
App with Android forceDark in effect | Renders with the dark theme defined by the content author. | Renders with the styling modified to dark colors by an algorithm if allowed by the content author. |
App with isLightTheme False, targetSdkVersion < android.os.Build.VERSION_CODES#TIRAMISU , and has FORCE_DARK_AUTO |
Renders with the dark theme defined by the content author. | Renders with the default styling defined by the content author. |
App with isLightTheme False, targetSdkVersion ≥ android.os.Build.VERSION_CODES#TIRAMISU , and setAlgorithmicDarkening(false) |
Renders with the dark theme defined by the content author. | Renders with the default styling defined by the content author. |
App with isLightTheme False, targetSdkVersion ≥ android.os.Build.VERSION_CODES#TIRAMISU , and setAlgorithmicDarkening(true) |
Renders with the dark theme defined by the content author. | Renders with the styling modified to dark colors by an algorithm if allowed by the content author. |
Parameters | |
---|---|
allow |
Boolean: allow algorithmic darkening or not. |
setAllowContentAccess
abstract fun setAllowContentAccess(allow: Boolean): Unit
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
abstract fun setAllowFileAccess(allow: Boolean): Unit
Enables or disables file access within WebView. Note that this enables or disables file system access only. Assets and resources are still accessible using file:///android_asset and file:///android_res.
Note: Apps should not open file://
URLs from any external source in WebView, don't enable this if your app accepts arbitrary URLs from external sources. It's recommended to always use androidx.webkit.WebViewAssetLoader to access files including assets and resources over http(s)://
schemes, instead of file://
URLs. To prevent possible security issues targeting android.os.Build.VERSION_CODES#Q
and earlier, you should explicitly set this value to false
.
The default value is true
for apps targeting android.os.Build.VERSION_CODES#Q
and below, and false
when targeting android.os.Build.VERSION_CODES#R
and above.
setAllowFileAccessFromFileURLs
abstract funsetAllowFileAccessFromFileURLs(flag: Boolean): Unit
Deprecated: This setting is not secure, please use androidx.webkit.WebViewAssetLoader to load file content securely.
Sets whether cross-origin requests in the context of a file scheme URL should be allowed to access content from other file scheme URLs. Note that some accesses such as image HTML elements don't follow same-origin rules and aren't affected by this setting.
Don't enable this setting if you open files that may be created or altered by external sources. Enabling this setting allows malicious scripts loaded in a file://
context to access arbitrary local files including WebView cookies and app private data.
Loading content via file://
URLs is generally discouraged. See the note in setAllowFileAccess
.
Note that the value of this setting is ignored if the value of getAllowUniversalAccessFromFileURLs
is true
. The default value is true
for apps targeting android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1
and below, and false
when targeting android.os.Build.VERSION_CODES#JELLY_BEAN
and above. To prevent possible violation of same domain policy when targeting android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1
and earlier, you should explicitly set this value to false
.
Parameters | |
---|---|
flag |
Boolean: whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs |
setAllowUniversalAccessFromFileURLs
abstract funsetAllowUniversalAccessFromFileURLs(flag: Boolean): Unit
Deprecated: This setting is not secure, please use androidx.webkit.WebViewAssetLoader to load file content securely.
Sets whether cross-origin requests 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 or web contexts. Note that some access such as image HTML elements doesn't follow same-origin rules and isn't affected by this setting.
Don't enable this setting if you open files that may be created or altered by external sources. Enabling this setting allows malicious scripts loaded in a file://
context to launch cross-site scripting attacks, either accessing arbitrary local files including WebView cookies, app private data or even credentials used on arbitrary web sites.
Loading content via file://
URLs is generally discouraged. See the note in setAllowFileAccess
.
The default value is true
for apps targeting android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1
and below, and false
when targeting android.os.Build.VERSION_CODES#JELLY_BEAN
and above. To prevent possible violation of same domain policy when targeting android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1
and earlier, you should explicitly set this value to false
.
Parameters | |
---|---|
flag |
Boolean: whether JavaScript running in the context of a file scheme URL should be allowed to access content from any origin |
setBlockNetworkImage
abstract fun setBlockNetworkImage(flag: Boolean): Unit
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
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 |
Boolean: whether the WebView should not load image resources from the network |
See Also
setBlockNetworkLoads
abstract fun setBlockNetworkLoads(flag: Boolean): Unit
Sets whether the WebView should not load resources from the network. Use setBlockNetworkImage
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 android.webkit.WebView#reload
is called. If the application does not have the android.Manifest.permission#INTERNET
permission, attempts to set a value of false
will cause a java.lang.SecurityException
to be thrown. The default value is false
if the application has the android.Manifest.permission#INTERNET
permission, otherwise it is true
.
Parameters | |
---|---|
flag |
Boolean: true means block network loads by the WebView |
See Also
setBuiltInZoomControls
abstract fun setBuiltInZoomControls(enabled: Boolean): Unit
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
. 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. However, on-screen zoom controls are deprecated in Android (see android.widget.ZoomButtonsController
) so it's recommended to disable setDisplayZoomControls
.
Parameters | |
---|---|
enabled |
Boolean: whether the WebView should use its built-in zoom mechanisms |
setCacheMode
abstract fun setCacheMode(mode: Int): Unit
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 |
Int: the mode to use Value is android.webkit.WebSettings#LOAD_DEFAULT , android.webkit.WebSettings#LOAD_NORMAL , android.webkit.WebSettings#LOAD_CACHE_ELSE_NETWORK , android.webkit.WebSettings#LOAD_NO_CACHE , or android.webkit.WebSettings#LOAD_CACHE_ONLY |
setCursiveFontFamily
abstract fun setCursiveFontFamily(font: String!): Unit
Sets the cursive font family name. The default is "cursive".
Parameters | |
---|---|
font |
String!: a font family name |
setDatabaseEnabled
abstract funsetDatabaseEnabled(flag: Boolean): Unit
Deprecated: WebSQL is deprecated and this method will become a no-op on all Android versions once support is removed in Chromium. See https://developer.chrome.com/blog/deprecating-web-sql for more information.
Sets whether the database storage API is enabled. The default value is false. See also setDatabasePath
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 |
Boolean: true if the WebView should use the database storage API |
setDatabasePath
abstract funsetDatabasePath(databasePath: String!): Unit
Deprecated: 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 |
String!: a path to the directory where databases should be saved. |
setDefaultFixedFontSize
abstract fun setDefaultFixedFontSize(size: Int): Unit
Sets the default fixed font size. The default is 16.
Parameters | |
---|---|
size |
Int: a non-negative integer between 1 and 72. Any number outside the specified range will be pinned. |
setDefaultFontSize
abstract fun setDefaultFontSize(size: Int): Unit
Sets the default font size. The default is 16.
Parameters | |
---|---|
size |
Int: a non-negative integer between 1 and 72. Any number outside the specified range will be pinned. |
setDefaultTextEncodingName
abstract fun setDefaultTextEncodingName(encoding: String!): Unit
Sets the default text encoding name to use when decoding html pages. The default is "UTF-8".
Parameters | |
---|---|
encoding |
String!: the text encoding name |
setDefaultZoom
abstract funsetDefaultZoom(zoom: WebSettings.ZoomDensity!): Unit
Deprecated: 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 ZoomDensity#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, android.webkit.WebView#setInitialScale
and setUseWideViewPort
can be used.
Parameters | |
---|---|
zoom |
WebSettings.ZoomDensity!: the zoom density |
setDisabledActionModeMenuItems
abstract fun setDisabledActionModeMenuItems(: Int): Unit
Disables the action mode menu items according to menuItems
flag.
Parameters | |
---|---|
menuItems |
Int: an integer field flag for the menu items to be disabled. Value is either 0 or a combination of android.webkit.WebSettings#MENU_ITEM_NONE , android.webkit.WebSettings#MENU_ITEM_SHARE , android.webkit.WebSettings#MENU_ITEM_WEB_SEARCH , and android.webkit.WebSettings#MENU_ITEM_PROCESS_TEXT |
setDisplayZoomControls
abstract fun setDisplayZoomControls(enabled: Boolean): Unit
Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms. See setBuiltInZoomControls
. The default is true
. However, on-screen zoom controls are deprecated in Android (see android.widget.ZoomButtonsController
) so it's recommended to set this to false
.
Parameters | |
---|---|
enabled |
Boolean: whether the WebView should display on-screen zoom controls |
setDomStorageEnabled
abstract fun setDomStorageEnabled(flag: Boolean): Unit
Sets whether the DOM storage API is enabled. The default value is false
.
Parameters | |
---|---|
flag |
Boolean: true if the WebView should use the DOM storage API |
setEnableSmoothTransition
abstract funsetEnableSmoothTransition(enable: Boolean): Unit
Deprecated: 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
abstract fun setFantasyFontFamily(font: String!): Unit
Sets the fantasy font family name. The default is "fantasy".
Parameters | |
---|---|
font |
String!: a font family name |
setFixedFontFamily
abstract fun setFixedFontFamily(font: String!): Unit
Sets the fixed font family name. The default is "monospace".
Parameters | |
---|---|
font |
String!: a font family name |
setForceDark
open funsetForceDark(forceDark: Int): Unit
Deprecated: The "force dark" model previously implemented by WebView was complex and didn't interoperate well with current Web standards for prefers-color-scheme
and color-scheme
. In apps with targetSdkVersion
≥ android.os.Build.VERSION_CODES#TIRAMISU
this API is a no-op and WebView will always use the dark style defined by web content authors if the app's theme is dark. To customize the behavior, refer to setAlgorithmicDarkeningAllowed
.
Set the force dark mode for this WebView.
Parameters | |
---|---|
forceDark |
Int: the force dark mode to set. Value is android.webkit.WebSettings#FORCE_DARK_OFF , android.webkit.WebSettings#FORCE_DARK_AUTO , or android.webkit.WebSettings#FORCE_DARK_ON |
See Also
setGeolocationDatabasePath
abstract funsetGeolocationDatabasePath(databasePath: String!): Unit
Deprecated: 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.
Parameters | |
---|---|
databasePath |
String!: a path to the directory where databases should be saved. |
setGeolocationEnabled
abstract fun setGeolocationEnabled(flag: Boolean): Unit
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
android.Manifest.permission#ACCESS_COARSE_LOCATION
,android.Manifest.permission#ACCESS_FINE_LOCATION
; - an application must provide an implementation of the
WebChromeClient#onGeolocationPermissionsShowPrompt
callback to receive notifications that a page is requesting access to location via the JavaScript Geolocation API.
Parameters | |
---|---|
flag |
Boolean: whether Geolocation should be enabled |
setJavaScriptCanOpenWindowsAutomatically
abstract fun setJavaScriptCanOpenWindowsAutomatically(flag: Boolean): Unit
Tells JavaScript to open windows automatically. This applies to the JavaScript function window.open()
. The default is false
.
Parameters | |
---|---|
flag |
Boolean: true if JavaScript can open windows automatically |
setJavaScriptEnabled
abstract fun setJavaScriptEnabled(flag: Boolean): Unit
Tells the WebView to enable JavaScript execution. The default is false
.
Parameters | |
---|---|
flag |
Boolean: true if the WebView should execute JavaScript |
setLayoutAlgorithm
abstract fun setLayoutAlgorithm(l: WebSettings.LayoutAlgorithm!): Unit
Sets the underlying layout algorithm. This will cause a re-layout of the WebView. The default is LayoutAlgorithm#NARROW_COLUMNS
.
Parameters | |
---|---|
l |
WebSettings.LayoutAlgorithm!: the layout algorithm to use, as a LayoutAlgorithm value |
setLightTouchEnabled
abstract funsetLightTouchEnabled(enabled: Boolean): Unit
Deprecated: From android.os.Build.VERSION_CODES#JELLY_BEAN
this setting is obsolete and has no effect.
Enables using light touches to make a selection and activate mouseovers.
setLoadWithOverviewMode
abstract fun setLoadWithOverviewMode(overview: Boolean): Unit
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
abstract fun setLoadsImagesAutomatically(flag: Boolean): Unit
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
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 |
Boolean: whether the WebView should load image resources |
setMediaPlaybackRequiresUserGesture
abstract fun setMediaPlaybackRequiresUserGesture(require: Boolean): Unit
Sets whether the WebView requires a user gesture to play media. The default is true
.
Parameters | |
---|---|
require |
Boolean: whether the WebView requires a user gesture to play media |
setMinimumFontSize
abstract fun setMinimumFontSize(size: Int): Unit
Sets the minimum font size. The default is 8.
Parameters | |
---|---|
size |
Int: a non-negative integer between 1 and 72. Any number outside the specified range will be pinned. |
setMinimumLogicalFontSize
abstract fun setMinimumLogicalFontSize(size: Int): Unit
Sets the minimum logical font size. The default is 8.
Parameters | |
---|---|
size |
Int: a non-negative integer between 1 and 72. Any number outside the specified range will be pinned. |
setMixedContentMode
abstract fun setMixedContentMode(mode: Int): Unit
Configures the WebView's behavior when a secure origin attempts to load a resource from an insecure origin. By default, apps that target android.os.Build.VERSION_CODES#KITKAT
or below default to MIXED_CONTENT_ALWAYS_ALLOW
. Apps targeting android.os.Build.VERSION_CODES#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 |
Int: The mixed content mode to use. One of MIXED_CONTENT_NEVER_ALLOW , MIXED_CONTENT_ALWAYS_ALLOW or MIXED_CONTENT_COMPATIBILITY_MODE . |
setNeedInitialFocus
abstract fun setNeedInitialFocus(flag: Boolean): Unit
Tells the WebView whether it needs to set a node to have focus when android.webkit.WebView#requestFocus(int,android.graphics.Rect) is called. The default value is true
.
Parameters | |
---|---|
flag |
Boolean: whether the WebView needs to set a node |
setOffscreenPreRaster
abstract fun setOffscreenPreRaster(enabled: Boolean): Unit
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
abstract funsetPluginState(state: WebSettings.PluginState!): Unit
Deprecated: Plugins are not supported in API level android.os.Build.VERSION_CODES#KITKAT
or later; enabling plugins is a no-op.
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 PluginState#OFF
.
Parameters | |
---|---|
state |
WebSettings.PluginState!: a PluginState value |
setRenderPriority
abstract funsetRenderPriority(priority: WebSettings.RenderPriority!): Unit
Deprecated: 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 RenderPriority#NORMAL
.
Parameters | |
---|---|
priority |
WebSettings.RenderPriority!: the priority |
setSafeBrowsingEnabled
abstract fun setSafeBrowsingEnabled(enabled: Boolean): Unit
Sets whether Safe Browsing is enabled. Safe Browsing allows WebView to protect against malware and phishing attacks by verifying the links.
Safe Browsing can be disabled for all WebViews using a manifest tag (read general Safe Browsing info). The manifest tag has a lower precedence than this API.
Safe Browsing is enabled by default for devices which support it.
Parameters | |
---|---|
enabled |
Boolean: Whether Safe Browsing is enabled. |
setSansSerifFontFamily
abstract fun setSansSerifFontFamily(font: String!): Unit
Sets the sans-serif font family name. The default is "sans-serif".
Parameters | |
---|---|
font |
String!: a font family name |
setSaveFormData
abstract funsetSaveFormData(save: Boolean): Unit
Deprecated: In Android O and afterwards, this function does not have any effect, the form data will be saved to platform's autofill service if applicable.
Sets whether the WebView should save form data. In Android O, the platform has implemented a fully functional Autofill feature to store form data. Therefore, the Webview form data save feature is disabled. Note that the feature will continue to be supported on older versions of Android as before.
setSavePassword
abstract funsetSavePassword(save: Boolean): Unit
Deprecated: Saving passwords in WebView will not be supported in future versions.
Sets whether the WebView should save passwords. The default is true
.
setSerifFontFamily
abstract fun setSerifFontFamily(font: String!): Unit
Sets the serif font family name. The default is "sans-serif".
Parameters | |
---|---|
font |
String!: a font family name |
setStandardFontFamily
abstract fun setStandardFontFamily(font: String!): Unit
Sets the standard font family name. The default is "sans-serif".
Parameters | |
---|---|
font |
String!: a font family name |
setSupportMultipleWindows
abstract fun setSupportMultipleWindows(support: Boolean): Unit
Sets whether the WebView whether supports multiple windows. If set to true, WebChromeClient#onCreateWindow
must be implemented by the host application. The default is false
.
Parameters | |
---|---|
support |
Boolean: whether to support multiple windows |
setSupportZoom
abstract fun setSupportZoom(support: Boolean): Unit
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
. This setting does not affect zooming performed using the WebView#zoomIn()
and WebView#zoomOut()
methods. The default is true
.
Parameters | |
---|---|
support |
Boolean: whether the WebView should support zoom |
setTextSize
open funsetTextSize(t: WebSettings.TextSize!): Unit
Deprecated: Use setTextZoom
instead.
Sets the text size of the page. The default is TextSize#NORMAL
.
Parameters | |
---|---|
t |
WebSettings.TextSize!: the text size as a TextSize value |
setTextZoom
abstract fun setTextZoom(textZoom: Int): Unit
Sets the text zoom of the page in percent. The default is 100.
Parameters | |
---|---|
textZoom |
Int: the text zoom in percent |
setUseWideViewPort
abstract fun setUseWideViewPort(use: Boolean): Unit
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 |
Boolean: whether to enable support for the viewport meta tag |
setUserAgentString
abstract fun setUserAgentString(ua: String?): Unit
Sets the WebView's user-agent string. If the string is null
or empty, the system default value will be used.
If the user-agent is overridden in this way, the values of the User-Agent Client Hints headers and navigator.userAgentData
for this WebView could be changed.
See androidx.webkit.WebSettingsCompat #setUserAgentMetadata(WebSettings,UserAgentMetadata) for details.
Note that starting from android.os.Build.VERSION_CODES#KITKAT
Android version, changing the user-agent while loading a web page causes WebView to initiate loading once again.
Parameters | |
---|---|
ua |
String?: new user-agent string This value may be null . |
supportMultipleWindows
abstract fun supportMultipleWindows(): Boolean
Gets whether the WebView supports multiple windows.
Return | |
---|---|
Boolean |
true if the WebView supports multiple windows |
See Also
supportZoom
abstract fun supportZoom(): Boolean
Gets whether the WebView supports zoom.
Return | |
---|---|
Boolean |
true if the WebView supports zoom |
See Also