org.apache.cordova.engine

Class SystemWebViewEngine

java.lang.Object

org.apache.cordova.engine.SystemWebViewEngine

All Implemented Interfaces:

CordovaWebViewEngine

public class SystemWebViewEngine
extends java.lang.Object
implements CordovaWebViewEngine

Glue classes between CordovaWebView (main Cordova logic) and SystemWebView (the actual View). We make the Engine separate from the actual View so that: A) We don't need to worry about WebView methods clashing with CordovaWebViewEngine methods (e.g.: goBack() is void for WebView, and boolean for CordovaWebViewEngine) B) Separating the actual View from the Engine makes API surfaces smaller. Class uses two-phase initialization. However, CordovaWebView is responsible for calling .init().

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cordova.CordovaWebViewEngine

CordovaWebViewEngine.Client, CordovaWebViewEngine.EngineView

Field Summary

Fields

Modifier and Type	Field and Description
protected CordovaBridge	bridge
protected CordovaWebViewEngine.Client	client
protected org.apache.cordova.engine.SystemCookieManager	cookieManager
protected CordovaInterface	cordova
protected NativeToJsMessageQueue	nativeToJsMessageQueue
protected CordovaWebView	parentWebView
protected PluginManager	pluginManager
protected CordovaPreferences	preferences
protected CordovaResourceApi	resourceApi
static java.lang.String	TAG
protected SystemWebView	webView

Constructor Summary

Constructors

Constructor and Description
SystemWebViewEngine(android.content.Context context, CordovaPreferences preferences) Used when created via reflection.
SystemWebViewEngine(SystemWebView webView)
SystemWebViewEngine(SystemWebView webView, CordovaPreferences preferences)

Method Summary

Modifier and Type	Method and Description
boolean	canGoBack()
void	clearCache()
void	clearHistory() After calling clearHistory(), canGoBack() should be false.
void	destroy() Clean up all resources associated with the WebView.
void	evaluateJavascript(java.lang.String js, android.webkit.ValueCallback<java.lang.String> callback) Add the evaulate Javascript method
ICordovaCookieManager	getCookieManager()
CordovaWebView	getCordovaWebView()
java.lang.String	getUrl() Return the currently loaded URL
android.view.View	getView()
boolean	goBack() Go to previous page in history.
void	init(CordovaWebView parentWebView, CordovaInterface cordova, CordovaWebViewEngine.Client client, CordovaResourceApi resourceApi, PluginManager pluginManager, NativeToJsMessageQueue nativeToJsMessageQueue)
void	loadUrl(java.lang.String url, boolean clearNavigationStack) Load the url into the webview.
void	setPaused(boolean value) Pauses / resumes the WebView's event loop.
void	stopLoading()

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

webView

protected final SystemWebView webView

cookieManager

protected final org.apache.cordova.engine.SystemCookieManager cookieManager

preferences

protected CordovaPreferences preferences

bridge

protected CordovaBridge bridge

client

protected CordovaWebViewEngine.Client client

parentWebView

protected CordovaWebView parentWebView

cordova

protected CordovaInterface cordova

pluginManager

protected PluginManager pluginManager

resourceApi

protected CordovaResourceApi resourceApi

nativeToJsMessageQueue

protected NativeToJsMessageQueue nativeToJsMessageQueue

Constructor Detail

SystemWebViewEngine

public SystemWebViewEngine(android.content.Context context,
                           CordovaPreferences preferences)

Used when created via reflection.

SystemWebViewEngine

public SystemWebViewEngine(SystemWebView webView)

SystemWebViewEngine

public SystemWebViewEngine(SystemWebView webView,
                           CordovaPreferences preferences)

Method Detail

init

public void init(CordovaWebView parentWebView,
                 CordovaInterface cordova,
                 CordovaWebViewEngine.Client client,
                 CordovaResourceApi resourceApi,
                 PluginManager pluginManager,
                 NativeToJsMessageQueue nativeToJsMessageQueue)

Specified by:

init in interface CordovaWebViewEngine

getCordovaWebView

public CordovaWebView getCordovaWebView()

Specified by:

getCordovaWebView in interface CordovaWebViewEngine

getCookieManager

public ICordovaCookieManager getCookieManager()

Specified by:

getCookieManager in interface CordovaWebViewEngine

getView

public android.view.View getView()

Specified by:

getView in interface CordovaWebViewEngine

loadUrl

public void loadUrl(java.lang.String url,
                    boolean clearNavigationStack)

Load the url into the webview.

Specified by:

loadUrl in interface CordovaWebViewEngine

getUrl

public java.lang.String getUrl()

Description copied from interface: CordovaWebViewEngine

Return the currently loaded URL

Specified by:

getUrl in interface CordovaWebViewEngine

stopLoading

public void stopLoading()

Specified by:

stopLoading in interface CordovaWebViewEngine

clearCache

public void clearCache()

Specified by:

clearCache in interface CordovaWebViewEngine

clearHistory

public void clearHistory()

Description copied from interface: CordovaWebViewEngine

After calling clearHistory(), canGoBack() should be false.

Specified by:

clearHistory in interface CordovaWebViewEngine

canGoBack

public boolean canGoBack()

Specified by:

canGoBack in interface CordovaWebViewEngine

goBack

public boolean goBack()

Go to previous page in history. (We manage our own history)

Specified by:

goBack in interface CordovaWebViewEngine

Returns:

true if we went back, false if we are already at top

setPaused

public void setPaused(boolean value)

Description copied from interface: CordovaWebViewEngine

Pauses / resumes the WebView's event loop.

Specified by:

setPaused in interface CordovaWebViewEngine

destroy

public void destroy()

Description copied from interface: CordovaWebViewEngine

Clean up all resources associated with the WebView.

Specified by:

destroy in interface CordovaWebViewEngine

evaluateJavascript

public void evaluateJavascript(java.lang.String js,
                               android.webkit.ValueCallback<java.lang.String> callback)

Description copied from interface: CordovaWebViewEngine

Add the evaulate Javascript method

Specified by:

evaluateJavascript in interface CordovaWebViewEngine