android-components / mozilla.components.concept.engine / Settings

Settings

abstract class Settings (source)

Holds settings of an engine or session. Concrete engine implementations define how these settings are applied i.e. whether a setting is applied on an engine or session instance.

Constructors

Name Summary
<init> Settings()
Holds settings of an engine or session. Concrete engine implementations define how these settings are applied i.e. whether a setting is applied on an engine or session instance.

Properties

Name Summary
allowContentAccess open var allowContentAccess: Boolean
Setting to control whether or not the engine is allowed to load content from a content provider installed in the system.
allowFileAccess open var allowFileAccess: Boolean
Setting to control whether or not file access is allowed.
allowFileAccessFromFileURLs open var allowFileAccessFromFileURLs: Boolean
Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs.
allowUniversalAccessFromFileURLs open var allowUniversalAccessFromFileURLs: Boolean
Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from any origin.
automaticFontSizeAdjustment open var automaticFontSizeAdjustment: Boolean
Setting to control whether the fonts adjust size with the system accessibility settings.
automaticLanguageAdjustment open var automaticLanguageAdjustment: Boolean
Setting to control whether the Accept-Language headers are altered with system locale settings.
displayZoomControls open var displayZoomControls: Boolean
Setting to control whether or not zoom controls should be displayed.
domStorageEnabled open var domStorageEnabled: Boolean
Setting to control whether or not DOM Storage is enabled.
fontInflationEnabled open var fontInflationEnabled: Boolean?
Setting to control whether font inflation is enabled.
fontSizeFactor open var fontSizeFactor: Float?
Setting to control the font size factor. All font sizes will be multiplied by this factor.
forceUserScalableContent open var forceUserScalableContent: Boolean
Setting to force the ability to scale the content
historyTrackingDelegate open var historyTrackingDelegate: HistoryTrackingDelegate?
Setting to provide a history delegate to the engine.
horizontalScrollBarEnabled open var horizontalScrollBarEnabled: Boolean
Setting to control whether or not horizontal scrolling is enabled.
javaScriptCanOpenWindowsAutomatically open var javaScriptCanOpenWindowsAutomatically: Boolean
Setting to control whether or not window.open can be called from JavaScript.
javascriptEnabled open var javascriptEnabled: Boolean
Setting to control whether or not JavaScript is enabled.
loadWithOverviewMode open var loadWithOverviewMode: Boolean
Setting to control whether or not the engine zooms out the content to fit on screen by width.
mediaPlaybackRequiresUserGesture open var mediaPlaybackRequiresUserGesture: Boolean
Setting to control whether or not a user gesture is required to play media.
preferredColorScheme open var preferredColorScheme: PreferredColorScheme
Setting to alert the content that the user prefers a particular theme. This affects the @mediaprefers-color-scheme query.
remoteDebuggingEnabled open var remoteDebuggingEnabled: Boolean
Setting to control whether or not remote debugging is enabled.
requestInterceptor open var requestInterceptor: RequestInterceptor?
Setting to intercept and override requests.
safeBrowsingPolicy open var safeBrowsingPolicy: Array<SafeBrowsingPolicy>
Setting to control tracking protection.
supportMultipleWindows open var supportMultipleWindows: Boolean
Setting to control whether or not multiple windows are supported.
suspendMediaWhenInactive open var suspendMediaWhenInactive: Boolean
Setting to control whether media should be suspended when the session is inactive.
testingModeEnabled open var testingModeEnabled: Boolean
Setting to control whether or not testing mode is enabled.
trackingProtectionPolicy open var trackingProtectionPolicy: TrackingProtectionPolicy?
Setting to control tracking protection.
useWideViewPort open var useWideViewPort: Boolean?
Setting to control whether to support the viewport HTML meta tag or if a wide viewport should be used. If not null, this value overrides useWideViePort webSettings in EngineSession.toggleDesktopMode.
userAgentString open var userAgentString: String?
Setting to control the user agent string.
verticalScrollBarEnabled open var verticalScrollBarEnabled: Boolean
Setting to control whether or not vertical scrolling is enabled.
webFontsEnabled open var webFontsEnabled: Boolean
Setting to control whether or not Web fonts are enabled.

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.

Inheritors

Name Summary
DefaultSettings data class DefaultSettings : Settings
Settings implementation used to set defaults for Engine and EngineSession.