org.xwalk.core

Class XWalkPreferences

java.lang.Object

XWalkPreferencesInternal

org.xwalk.core.XWalkPreferences

public final class XWalkPreferences
extends XWalkPreferencesInternal

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	ANIMATABLE_XWALK_VIEW The key string to enable/disable animatable XWalkView.
static java.lang.String	REMOTE_DEBUGGING The key string to enable/disable remote debugging.

Constructor Summary

Constructors

Constructor and Description
XWalkPreferences()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	getValue(java.lang.String key) Get a preference value from Crosswalk.
static void	setValue(java.lang.String key, boolean enabled) Set a 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 false. 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

Constructor Detail

XWalkPreferences

public XWalkPreferences()

Method Detail

setValue

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

Set a 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.

Throws:

java.lang.RuntimeException

Since:

1.0

getValue

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

Get a 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.

Throws:

java.lang.RuntimeException

Since:

1.0