org.apache.cordova

Class CordovaWebViewImpl

java.lang.Object

org.apache.cordova.CordovaWebViewImpl

All Implemented Interfaces:

CordovaWebView

public class CordovaWebViewImpl
extends java.lang.Object
implements CordovaWebView

Main classes for interacting with a Cordova webview. Manages plugins, events, and a CordovaWebViewEngine. Class uses two-phase initialization. You must call init() before calling any other methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CordovaWebViewImpl.EngineClient

Field Summary

Fields

Modifier and Type	Field and Description
protected CordovaWebViewEngine	engine
static java.lang.String	TAG

Fields inherited from interface org.apache.cordova.CordovaWebView

CORDOVA_VERSION

Constructor Summary

Constructors

Constructor and Description
CordovaWebViewImpl(CordovaWebViewEngine cordovaWebViewEngine)

Method Summary

Modifier and Type	Method and Description
boolean	backHistory()
boolean	canGoBack()
void	clearCache()
void	clearCache(boolean b) Deprecated.
void	clearHistory()
static CordovaWebViewEngine	createEngine(android.content.Context context, CordovaPreferences preferences)
android.content.Context	getContext()
ICordovaCookieManager	getCookieManager()
CordovaWebViewEngine	getEngine()
PluginManager	getPluginManager()
CordovaPreferences	getPreferences()
CordovaResourceApi	getResourceApi()
java.lang.String	getUrl()
android.view.View	getView()
void	handleDestroy()
void	handlePause(boolean keepRunning)
void	handleResume(boolean keepRunning)
void	handleStart()
void	handleStop()
void	hideCustomView() Deprecated.
void	init(CordovaInterface cordova)
void	init(CordovaInterface cordova, java.util.List<PluginEntry> pluginEntries, CordovaPreferences preferences)
boolean	isButtonPlumbedToJs(int keyCode)
boolean	isCustomViewShowing() Deprecated.
boolean	isInitialized()
void	loadUrl(java.lang.String url)
void	loadUrlIntoView(java.lang.String url, boolean recreatePlugins)
void	onNewIntent(android.content.Intent intent)
java.lang.Object	postMessage(java.lang.String id, java.lang.Object data)
void	sendJavascript(java.lang.String statement) Deprecated.
void	sendPluginResult(PluginResult cr, java.lang.String callbackId)
void	setButtonPlumbedToJs(int keyCode, boolean override)
void	showCustomView(android.view.View view, android.webkit.WebChromeClient.CustomViewCallback callback) Deprecated.
void	showWebPage(java.lang.String url, boolean openExternal, boolean clearHistory, java.util.Map<java.lang.String,java.lang.Object> params) Load the specified URL in the Cordova webview or a new browser instance.
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

engine

protected final CordovaWebViewEngine engine

Constructor Detail

CordovaWebViewImpl

public CordovaWebViewImpl(CordovaWebViewEngine cordovaWebViewEngine)

Method Detail

createEngine

public static CordovaWebViewEngine createEngine(android.content.Context context,
                                                CordovaPreferences preferences)

init

public void init(CordovaInterface cordova)

init

public void init(CordovaInterface cordova,
                 java.util.List<PluginEntry> pluginEntries,
                 CordovaPreferences preferences)

Specified by:

init in interface CordovaWebView

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface CordovaWebView

loadUrlIntoView

public void loadUrlIntoView(java.lang.String url,
                            boolean recreatePlugins)

Specified by:

loadUrlIntoView in interface CordovaWebView

loadUrl

public void loadUrl(java.lang.String url)

Specified by:

loadUrl in interface CordovaWebView

showWebPage

public void showWebPage(java.lang.String url,
                        boolean openExternal,
                        boolean clearHistory,
                        java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: CordovaWebView

Load the specified URL in the Cordova webview or a new browser instance. NOTE: If openExternal is false, only whitelisted URLs can be loaded.

Specified by:

showWebPage in interface CordovaWebView

Parameters:

url - The url to load.

openExternal - Load url in browser instead of Cordova webview.

clearHistory - Clear the history stack, so new page becomes top of history

params - Parameters for new app

showCustomView

@Deprecated
public void showCustomView(android.view.View view,
                                        android.webkit.WebChromeClient.CustomViewCallback callback)

Deprecated.

Description copied from interface: CordovaWebView

Deprecated in 4.0.0. Use your own View-toggling logic.

Specified by:

showCustomView in interface CordovaWebView

hideCustomView

@Deprecated
public void hideCustomView()

Deprecated.

Description copied from interface: CordovaWebView

Deprecated in 4.0.0. Use your own View-toggling logic.

Specified by:

hideCustomView in interface CordovaWebView

isCustomViewShowing

@Deprecated
public boolean isCustomViewShowing()

Deprecated.

Description copied from interface: CordovaWebView

Deprecated in 4.0.0. Use your own View-toggling logic.

Specified by:

isCustomViewShowing in interface CordovaWebView

sendJavascript

@Deprecated
public void sendJavascript(java.lang.String statement)

Deprecated.

Description copied from interface: CordovaWebView

Send JavaScript statement back to JavaScript. Deprecated (https://issues.apache.org/jira/browse/CB-6851) Instead of executing snippets of JS, you should use the exec bridge to create a Java->JS communication channel. To do this: 1. Within plugin.xml (to have your JS run before deviceready): 2. Within your .js (call exec on start-up): require('cordova/channel').onCordovaReady.subscribe(function() { require('cordova/exec')(win, null, 'Plugin', 'method', []); function win(message) { ... process message from java here ... } }); 3. Within your .java: PluginResult dataResult = new PluginResult(PluginResult.Status.OK, CODE); dataResult.setKeepCallback(true); savedCallbackContext.sendPluginResult(dataResult);

Specified by:

sendJavascript in interface CordovaWebView

sendPluginResult

public void sendPluginResult(PluginResult cr,
                             java.lang.String callbackId)

Specified by:

sendPluginResult in interface CordovaWebView

getPluginManager

public PluginManager getPluginManager()

Specified by:

getPluginManager in interface CordovaWebView

getPreferences

public CordovaPreferences getPreferences()

Specified by:

getPreferences in interface CordovaWebView

getCookieManager

public ICordovaCookieManager getCookieManager()

Specified by:

getCookieManager in interface CordovaWebView

getResourceApi

public CordovaResourceApi getResourceApi()

Specified by:

getResourceApi in interface CordovaWebView

getEngine

public CordovaWebViewEngine getEngine()

Specified by:

getEngine in interface CordovaWebView

getView

public android.view.View getView()

Specified by:

getView in interface CordovaWebView

getContext

public android.content.Context getContext()

Specified by:

getContext in interface CordovaWebView

setButtonPlumbedToJs

public void setButtonPlumbedToJs(int keyCode,
                                 boolean override)

Specified by:

setButtonPlumbedToJs in interface CordovaWebView

isButtonPlumbedToJs

public boolean isButtonPlumbedToJs(int keyCode)

Specified by:

isButtonPlumbedToJs in interface CordovaWebView

postMessage

public java.lang.Object postMessage(java.lang.String id,
                                    java.lang.Object data)

Specified by:

postMessage in interface CordovaWebView

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface CordovaWebView

stopLoading

public void stopLoading()

Specified by:

stopLoading in interface CordovaWebView

canGoBack

public boolean canGoBack()

Specified by:

canGoBack in interface CordovaWebView

clearCache

public void clearCache()

Specified by:

clearCache in interface CordovaWebView

clearCache

@Deprecated
public void clearCache(boolean b)

Deprecated.

Description copied from interface: CordovaWebView

Use parameter-less overload

Specified by:

clearCache in interface CordovaWebView

clearHistory

public void clearHistory()

Specified by:

clearHistory in interface CordovaWebView

backHistory

public boolean backHistory()

Specified by:

backHistory in interface CordovaWebView

onNewIntent

public void onNewIntent(android.content.Intent intent)

Specified by:

onNewIntent in interface CordovaWebView

handlePause

public void handlePause(boolean keepRunning)

Specified by:

handlePause in interface CordovaWebView

handleResume

public void handleResume(boolean keepRunning)

Specified by:

handleResume in interface CordovaWebView

handleStart

public void handleStart()

Specified by:

handleStart in interface CordovaWebView

handleStop

public void handleStop()

Specified by:

handleStop in interface CordovaWebView

handleDestroy

public void handleDestroy()

Specified by:

handleDestroy in interface CordovaWebView