org.xwalk.core

Class XWalkSettings

java.lang.Object

org.xwalk.core.XWalkSettings

public class XWalkSettings
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcceptLanguages() Get the accept languages of XWalkView.
boolean	getBuiltInZoomControls() Gets whether the zoom mechanisms built into XWalkView are being used.
int	getDefaultFixedFontSize() Gets the default fixed font size.
int	getDefaultFontSize() Gets the default font size.
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	setBuiltInZoomControls(boolean enabled) Sets whether the XWalkView should use its built-in zoom mechanisms.
void	setDefaultFixedFontSize(int size) Sets the default fixed font size.
void	setDefaultFontSize(int size) Sets the default font size.
void	setInitialPageScale(float scaleInPercent) Sets the initial scale for this XWalkView.
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	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

Constructor Detail

XWalkSettings

public XWalkSettings(java.lang.Object bridge)

Method Detail

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

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

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.