org.xwalk.core

Class XWalkSettings

java.lang.Object

org.xwalk.core.XWalkSettings

public class XWalkSettings
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XWalkSettings.LayoutAlgorithm This enum corresponds to WebSettings.LayoutAlgorithm.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOAD_CACHE_ELSE_NETWORK Use cached resources when they are available, even if they have expired.
static int	LOAD_CACHE_ONLY Don't use the network, load from the cache.
static int	LOAD_DEFAULT Default cache usage mode.
static int	LOAD_NO_CACHE Don't use the cache, load from the network.

Constructor Summary

Constructors

Constructor and Description
XWalkSettings(java.lang.Object bridge)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAcceptLanguages() Get the accept languages of XWalkView.
boolean	getAllowContentAccess() Gets whether this XWalkView supports content URL access.
boolean	getAllowFileAccess() Gets whether this XWalkView supports file access.
boolean	getAllowFileAccessFromFileURLs() Gets whether JavaScript running in the context of a file scheme URL can access content from other file scheme URLs.
boolean	getAllowUniversalAccessFromFileURLs() Gets whether JavaScript running in the context of a file scheme URL can access content from any origin.
boolean	getBlockNetworkImage() Gets whether the XWalkView does not load image resources from the network.
boolean	getBlockNetworkLoads() Gets whether the XWalkView does not load any resources from the network.
protected java.lang.Object	getBridge()
boolean	getBuiltInZoomControls() Gets whether the zoom mechanisms built into XWalkView are being used.
int	getCacheMode() Gets the current setting for overriding the cache mode.
boolean	getDatabaseEnabled() Gets whether the database storage API is enabled.
int	getDefaultFixedFontSize() Gets the default fixed font size.
int	getDefaultFontSize() Gets the default font size.
boolean	getDomStorageEnabled() Gets whether the DOM Storage APIs are enabled.
boolean	getJavaScriptCanOpenWindowsAutomatically() Gets whether JavaScript can open windows automatically.
boolean	getJavaScriptEnabled() Gets whether JavaScript is enabled.
XWalkSettings.LayoutAlgorithm	getLayoutAlgorithm() Gets the current layout algorithm.
boolean	getLoadsImagesAutomatically() Gets whether the XWalkView loads image resources.
boolean	getLoadWithOverviewMode() Gets whether this XWalkView loads pages in overview mode.
boolean	getMediaPlaybackRequiresUserGesture() Gets whether the XWalkView requires a user gesture to play media.
boolean	getSaveFormData() Gets whether the XWalkView saves form data.
boolean	getSupportQuirksMode() Gets whether the XWalkView should support the quirks mode.
boolean	getSupportSpatialNavigation() Gets whether the XWalkView should support the spatial navigation.
int	getTextZoom() Gets the text zoom of the page in percent.
java.lang.String	getUserAgentString() Get the user agent of web page/app.
boolean	getUseWideViewPort() Gets whether the XWalkView supports the "viewport" HTML meta tag or will use a wide viewport.
void	setAcceptLanguages(java.lang.String acceptLanguages) Set the accept languages of XWalkView.
void	setAllowContentAccess(boolean allow) Enables or disables content URL access within XWalkView.
void	setAllowFileAccess(boolean allow) Enables or disables file access within XWalkView.
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.
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.
void	setBlockNetworkImage(boolean flag) Sets whether the XWalkView should not load image resources from the network (resources accessed via http and https URI schemes).
void	setBlockNetworkLoads(boolean flag) Sets whether the XWalkView should not load resources from the network.
void	setBuiltInZoomControls(boolean enabled) Sets whether the XWalkView should use its built-in zoom mechanisms.
void	setCacheMode(int mode) Overrides the way the cache is used.
void	setDatabaseEnabled(boolean flag) Sets whether the database storage API is enabled.
void	setDefaultFixedFontSize(int size) Sets the default fixed font size.
void	setDefaultFontSize(int size) Sets the default font size.
void	setDomStorageEnabled(boolean flag) Sets whether the DOM storage API is enabled.
void	setInitialPageScale(float scaleInPercent) Sets the initial scale for this XWalkView.
void	setJavaScriptCanOpenWindowsAutomatically(boolean flag) Tells JavaScript to open windows automatically.
void	setJavaScriptEnabled(boolean flag) Tells the XWalkView to enable JavaScript execution.
void	setLayoutAlgorithm(XWalkSettings.LayoutAlgorithm la) Sets the underlying layout algorithm.
void	setLoadsImagesAutomatically(boolean flag) Sets whether the XWalkView should load image resources.
void	setLoadWithOverviewMode(boolean overview) Sets whether the XWalkView loads pages in overview mode, that is, zooms out the content to fit on screen by width.
void	setMediaPlaybackRequiresUserGesture(boolean require) Sets whether the XWalkView requires a user gesture to play media.
void	setSaveFormData(boolean enable) Sets whether the XWalkView should save form data.
void	setSupportMultipleWindows(boolean support) Sets whether the XWalkView supports multiple windows.
void	setSupportQuirksMode(boolean enable) Sets whether the XWalkView should support the quirks mode.
void	setSupportSpatialNavigation(boolean enable) Sets whether the XWalkView should support the spatial navigation, like a TV remote control.
void	setSupportZoom(boolean support) Sets whether the XWalkView should support zooming using its on-screen zoom controls and gestures.
void	setTextZoom(int textZoom) Sets the text zoom of the page in percent.
void	setUserAgentString(java.lang.String userAgent) Set the user agent of web page/app.
void	setUseWideViewPort(boolean use) Sets whether the XWalkView should enable support for the "viewport" HTML meta tag or should use a wide viewport.
boolean	supportMultipleWindows() Gets whether the XWalkView supports multiple windows.
boolean	supportsMultiTouchZoomForTest() Note: Just for test case.
boolean	supportZoom() Gets whether the XWalkView supports zoom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOAD_DEFAULT

public static final int LOAD_DEFAULT

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

Since:

7.0

See Also:

Constant Field Values

LOAD_CACHE_ELSE_NETWORK

public static final int LOAD_CACHE_ELSE_NETWORK

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

Since:

7.0

See Also:

Constant Field Values

LOAD_NO_CACHE

public static final int LOAD_NO_CACHE

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

Since:

7.0

See Also:

Constant Field Values

LOAD_CACHE_ONLY

public static final int LOAD_CACHE_ONLY

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

Since:

7.0

See Also:

Constant Field Values

Constructor Detail

XWalkSettings

public XWalkSettings(java.lang.Object bridge)

Method Detail

getBridge

protected java.lang.Object getBridge()

setCacheMode

public void setCacheMode(int mode)

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

Parameters:

mode - the mode to use

Since:

7.0

getCacheMode

public int getCacheMode()

Gets the current setting for overriding the cache mode.

Returns:

the current setting for overriding the cache mode

Since:

7.0

See Also:

setCacheMode(int)

setBlockNetworkLoads

public void setBlockNetworkLoads(boolean flag)

Sets whether the XWalkView 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 XWalkView are not fetched until XWalkView.reload(int) is called. If the application does not have the Manifest.permission.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 Manifest.permission.INTERNET permission, otherwise it is true.

Parameters:

flag - whether the XWalkView should not load any resources from the network

Since:

7.0

See Also:

XWalkView.reload(int)

getBlockNetworkLoads

public boolean getBlockNetworkLoads()

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

Returns:

true if the XWalkView does not load any resources from the network

Since:

7.0

See Also:

setBlockNetworkLoads(boolean)

setAllowFileAccess

public void setAllowFileAccess(boolean allow)

Enables or disables file access within XWalkView. 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.

Since:

7.0

getAllowFileAccess

public boolean getAllowFileAccess()

Gets whether this XWalkView supports file access.

Since:

7.0

See Also:

setAllowFileAccess(boolean)

setAllowContentAccess

public void setAllowContentAccess(boolean allow)

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

Since:

7.0

getAllowContentAccess

public boolean getAllowContentAccess()

Gets whether this XWalkView supports content URL access.

Since:

7.0

See Also:

setAllowContentAccess(boolean)

setJavaScriptEnabled

public void setJavaScriptEnabled(boolean flag)

Tells the XWalkView to enable JavaScript execution. The default is true. Note that the default value of this setting is different with WebView.

Parameters:

flag - true if the XWalkView should execute JavaScript

Since:

7.0

setAllowUniversalAccessFromFileURLs

public void setAllowUniversalAccessFromFileURLs(boolean flag)

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

Parameters:

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

Since:

7.0

setAllowFileAccessFromFileURLs

public void setAllowFileAccessFromFileURLs(boolean flag)

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

Parameters:

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

Since:

7.0

setLoadsImagesAutomatically

public void setLoadsImagesAutomatically(boolean flag)

Sets whether the XWalkView 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 XWalkView are loaded automatically. The default is true.

Parameters:

flag - whether the XWalkView should load image resources

Since:

7.0

getLoadsImagesAutomatically

public boolean getLoadsImagesAutomatically()

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

Returns:

true if the XWalkView loads image resources

Since:

7.0

See Also:

setLoadsImagesAutomatically(boolean)

setBlockNetworkImage

public void setBlockNetworkImage(boolean flag)

Sets whether the XWalkView 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 XWalkView are fetched automatically. The default is false.

Parameters:

flag - whether the XWalkView should not load image resources from the network

Since:

7.0

See Also:

setBlockNetworkLoads(boolean)

getBlockNetworkImage

public boolean getBlockNetworkImage()

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

Returns:

true if the XWalkView does not load image resources from the network

Since:

7.0

See Also:

setBlockNetworkImage(boolean)

getJavaScriptEnabled

public boolean getJavaScriptEnabled()

Gets whether JavaScript is enabled.

Returns:

true if JavaScript is enabled

Since:

7.0

See Also:

setJavaScriptEnabled(boolean)

getAllowUniversalAccessFromFileURLs

public boolean getAllowUniversalAccessFromFileURLs()

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

Returns:

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

Since:

7.0

See Also:

setAllowUniversalAccessFromFileURLs(boolean)

getAllowFileAccessFromFileURLs

public boolean getAllowFileAccessFromFileURLs()

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

Since:

7.0

See Also:

setAllowFileAccessFromFileURLs(boolean)

setJavaScriptCanOpenWindowsAutomatically

public void setJavaScriptCanOpenWindowsAutomatically(boolean flag)

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

Parameters:

flag - true if JavaScript can open windows automatically

Since:

7.0

getJavaScriptCanOpenWindowsAutomatically

public boolean getJavaScriptCanOpenWindowsAutomatically()

Gets whether JavaScript can open windows automatically.

Returns:

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

Since:

7.0

See Also:

setJavaScriptCanOpenWindowsAutomatically(boolean)

setSupportMultipleWindows

public void setSupportMultipleWindows(boolean support)

Sets whether the XWalkView supports multiple windows. If set to true, XWalkUIClient.onCreateWindowRequested(org.xwalk.core.XWalkView, org.xwalk.core.XWalkUIClient.InitiateBy, android.webkit.ValueCallback<org.xwalk.core.XWalkView>) must be implemented by the host application. The default is false.

Parameters:

support - whether to suport multiple windows

Since:

7.0

supportMultipleWindows

public boolean supportMultipleWindows()

Gets whether the XWalkView supports multiple windows.

Returns:

true if the XWalkView supports multiple windows

Since:

7.0

See Also:

setSupportMultipleWindows(boolean)

setUseWideViewPort

public void setUseWideViewPort(boolean use)

Sets whether the XWalkView 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 XWalkView control in device-independent (CSS) pixels. When the value is true and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used.

Parameters:

use - whether to enable support for the viewport meta tag.

Since:

6.0

getUseWideViewPort

public boolean getUseWideViewPort()

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

Returns:

true if the XWalkView supports the viewport meta tag.

Since:

6.0

setDomStorageEnabled

public void setDomStorageEnabled(boolean flag)

Sets whether the DOM storage API is enabled. The default value is true. Note that the default value of this setting is different with WebView.

Parameters:

flag - true if the XWalkView should use the DOM storage API

Since:

7.0

getDomStorageEnabled

public boolean getDomStorageEnabled()

Gets whether the DOM Storage APIs are enabled.

Returns:

true if the DOM Storage APIs are enabled

Since:

7.0

See Also:

setDomStorageEnabled(boolean)

setDatabaseEnabled

public void setDatabaseEnabled(boolean flag)

Sets whether the database storage API is enabled. The default value is true, which is different with WebView. This setting is global in effect, across all XWalkView instances in a process. Note you should only modify this setting prior to making any XWalkView page load within a given process, as the XWalkView implementation may ignore changes to this setting after that point.

Parameters:

flag - true if the XWalkView should use the database storage API

Since:

7.0

getDatabaseEnabled

public boolean getDatabaseEnabled()

Gets whether the database storage API is enabled.

Returns:

true if the database storage API is enabled

Since:

7.0

setMediaPlaybackRequiresUserGesture

public void setMediaPlaybackRequiresUserGesture(boolean require)

Sets whether the XWalkView requires a user gesture to play media. The default is false, which is different with WebView.

Parameters:

require - whether the XWalkView requires a user gesture to play media

Since:

7.0

getMediaPlaybackRequiresUserGesture

public boolean getMediaPlaybackRequiresUserGesture()

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

Returns:

true if the XWalkView requires a user gesture to play media

Since:

7.0

See Also:

setMediaPlaybackRequiresUserGesture(boolean)

setUserAgentString

public void setUserAgentString(java.lang.String userAgent)

Set the user agent of web page/app.

Parameters:

userAgent - the user agent string passed from client.

Since:

6.0

getUserAgentString

public java.lang.String getUserAgentString()

Get the user agent of web page/app.

Returns:

the XWalkView's user-agent string.

Since:

6.0

setAcceptLanguages

public void setAcceptLanguages(java.lang.String acceptLanguages)

Set the accept languages of XWalkView.

Parameters:

acceptLanguages - the accept languages string passed from client.

Since:

6.0

getAcceptLanguages

public java.lang.String getAcceptLanguages()

Get the accept languages of XWalkView.

Returns:

the accept languages

Since:

6.0

setSaveFormData

public void setSaveFormData(boolean enable)

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

Since:

7.0

getSaveFormData

public boolean getSaveFormData()

Gets whether the XWalkView saves form data.

Returns:

whether the XWalkView saves form data

Since:

7.0

See Also:

setSaveFormData(boolean)

setInitialPageScale

public void setInitialPageScale(float scaleInPercent)

Sets the initial scale for this XWalkView.

Parameters:

scaleInPercent - the initial scale in percent.

Since:

6.0

setTextZoom

public void setTextZoom(int textZoom)

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

Parameters:

textZoom - the text zoom in percent.

Since:

6.0

getTextZoom

public int getTextZoom()

Gets the text zoom of the page in percent.

Returns:

the text zoom of the page in percent.

Since:

6.0

setDefaultFontSize

public void setDefaultFontSize(int size)

Sets the default font size. The default is 16.

Parameters:

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

Since:

6.0

getDefaultFontSize

public int getDefaultFontSize()

Gets the default font size.

Returns:

a non-negative integer between 1 and 72.

Since:

6.0

setDefaultFixedFontSize

public void setDefaultFixedFontSize(int size)

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.

Since:

6.0

getDefaultFixedFontSize

public int getDefaultFixedFontSize()

Gets the default fixed font size.

Returns:

a non-negative integer between 1 and 72.

Since:

6.0

setSupportZoom

public void setSupportZoom(boolean support)

Sets whether the XWalkView 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 XWalkView should support zoom.

Since:

6.0

supportZoom

public boolean supportZoom()

Gets whether the XWalkView supports zoom.

Returns:

true if the XWalkView supports zoom.

Since:

6.0

setBuiltInZoomControls

public void setBuiltInZoomControls(boolean enabled)

Sets whether the XWalkView should use its built-in zoom mechanisms. The built-in zoom mechanisms comprise on-screen zoom controls, which are displayed over the XWalkView'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.

Parameters:

enabled - whether the XWalkView should use its built-in zoom mechanisms.

Since:

6.0

getBuiltInZoomControls

public boolean getBuiltInZoomControls()

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

Returns:

true if the zoom mechanisms built into XWalkView are being used.

Since:

6.0

supportsMultiTouchZoomForTest

public boolean supportsMultiTouchZoomForTest()

Note: Just for test case. Gets whether the XWalkView supports multi touch zoom.

Returns:

true if the XWalkView supports multi touch zoom.

setSupportSpatialNavigation

public void setSupportSpatialNavigation(boolean enable)

Sets whether the XWalkView should support the spatial navigation, like a TV remote control.

Parameters:

enable - whether the XWalkView should support the spatial navigation.

Since:

6.0

getSupportSpatialNavigation

public boolean getSupportSpatialNavigation()

Gets whether the XWalkView should support the spatial navigation.

Returns:

true if XWalkView support the spatial navigation.

Since:

6.0

setSupportQuirksMode

public void setSupportQuirksMode(boolean enable)

Sets whether the XWalkView should support the quirks mode.

Parameters:

enable - whether the XWalkView should support the quirks mode.

Since:

6.0

getSupportQuirksMode

public boolean getSupportQuirksMode()

Gets whether the XWalkView should support the quirks mode.

Returns:

true if XWalkView supports the quirks mode.

Since:

6.0

setLayoutAlgorithm

public void setLayoutAlgorithm(XWalkSettings.LayoutAlgorithm la)

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

Parameters:

la - the layout algorithm to use.

Since:

6.0

getLayoutAlgorithm

public XWalkSettings.LayoutAlgorithm getLayoutAlgorithm()

Gets the current layout algorithm.

Returns:

the layout algorithm in use.

Since:

6.0

setLoadWithOverviewMode

public void setLoadWithOverviewMode(boolean overview)

Sets whether the XWalkView 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 XWalkView control, for example, when getUseWideViewPort() is enabled. The default is false.

Parameters:

overview - whether this XWalkView loads pages in overview mode.

Since:

7.0

getLoadWithOverviewMode

public boolean getLoadWithOverviewMode()

Gets whether this XWalkView loads pages in overview mode.

Returns:

whether this XWalkView loads pages in overview mode.

Since:

7.0