org.xwalk.core

Class XWalkPreferences

java.lang.Object

org.xwalk.core.XWalkPreferences

public class XWalkPreferences
extends java.lang.Object

This class represents the preferences and could be set by callers. It is not thread-safe and must be called on the UI thread. Afterwards, the preference could be read from all threads and can impact all XWalkView instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_UNIVERSAL_ACCESS_FROM_FILE The key string to allow/disallow having universal access from file origin.
static java.lang.String	ANIMATABLE_XWALK_VIEW The key string to enable/disable animatable XWalkView.
static java.lang.String	JAVASCRIPT_CAN_OPEN_WINDOW The key string to allow/disallow javascript to open window automatically.
static java.lang.String	PROFILE_NAME The key string to set xwalk profile name.
static java.lang.String	REMOTE_DEBUGGING The key string to enable/disable remote debugging.
static java.lang.String	SUPPORT_MULTIPLE_WINDOWS The key string to enable/disable multiple windows.

Constructor Summary

Constructors

Constructor and Description
XWalkPreferences()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	getBooleanValue(java.lang.String key) Get a boolean preference value from Crosswalk.
static int	getIntegerValue(java.lang.String key) Get a int preference value from Crosswalk.
static java.lang.String	getStringValue(java.lang.String key) Get a string preference value from Crosswalk.
static boolean	getValue(java.lang.String key) Deprecated.
static void	setValue(java.lang.String key, boolean enabled) Set a boolean preference value into Crosswalk.
static void	setValue(java.lang.String key, int value) Set an integer preference value into Crosswalk.
static void	setValue(java.lang.String key, java.lang.String value) Set a string preference value into Crosswalk.

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_DEBUGGING

public static final java.lang.String REMOTE_DEBUGGING

The key string to enable/disable remote debugging.

Since:

1.0

See Also:

Constant Field Values

ANIMATABLE_XWALK_VIEW

public static final java.lang.String ANIMATABLE_XWALK_VIEW

The key string to enable/disable animatable XWalkView. Default value is true. If this key is set to False, then SurfaceView will be created internally as the rendering backend. If this key is set to True, the XWalkView created by Crosswalk can be transformed and animated. Internally, Crosswalk is alternatively using TextureView as the backend of XWalkView. TextureView is a kind of android.view.View that is different from SurfaceView. Unlike SurfaceView, it can be resized, transformed and animated. Once this key is set to True, all XWalkView will use TextureView as the rendering target instead of SurfaceView. The downside of TextureView is, it would consume more graphics memory than SurfaceView and may have 1~3 extra frames of latency to display updates. Note this key MUST be set before creating the first XWalkView, otherwise a RuntimeException will be thrown.

Since:

2.0

See Also:

Constant Field Values

JAVASCRIPT_CAN_OPEN_WINDOW

public static final java.lang.String JAVASCRIPT_CAN_OPEN_WINDOW

The key string to allow/disallow javascript to open window automatically.

Since:

3.0

See Also:

Constant Field Values

ALLOW_UNIVERSAL_ACCESS_FROM_FILE

public static final java.lang.String ALLOW_UNIVERSAL_ACCESS_FROM_FILE

The key string to allow/disallow having universal access from file origin.

Since:

3.0

See Also:

Constant Field Values

SUPPORT_MULTIPLE_WINDOWS

public static final java.lang.String SUPPORT_MULTIPLE_WINDOWS

The key string to enable/disable multiple windows.

Since:

3.0

See Also:

Constant Field Values

PROFILE_NAME

public static final java.lang.String PROFILE_NAME

The key string to set xwalk profile name. User data will be kept separated for different profiles. Profile needs to be set before any XWalkView instance created.

Since:

3.0

See Also:

Constant Field Values

Constructor Detail

XWalkPreferences

public XWalkPreferences()

Method Detail

setValue

public static void setValue(java.lang.String key,
            boolean enabled)

Set a boolean preference value into Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

enabled - true if setting it as enabled.

Since:

1.0

setValue

public static void setValue(java.lang.String key,
            int value)

Set an integer preference value into Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

value - the integer value.

Since:

3.0

setValue

public static void setValue(java.lang.String key,
            java.lang.String value)

Set a string preference value into Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

value - the string value.

Since:

3.0

getValue

public static boolean getValue(java.lang.String key)

Deprecated.

Get a boolean preference value from Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

Returns:

true if it's enabled.

Since:

1.0

getBooleanValue

public static boolean getBooleanValue(java.lang.String key)

Get a boolean preference value from Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

Returns:

true if it's enabled.

Since:

3.0

getIntegerValue

public static int getIntegerValue(java.lang.String key)

Get a int preference value from Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

Returns:

the integer value.

Since:

3.0

getStringValue

public static java.lang.String getStringValue(java.lang.String key)

Get a string preference value from Crosswalk. An exception will be thrown if the key for the preference is not valid.

Parameters:

key - the string name of the key.

Returns:

the string value.

Since:

3.0