org.apache.cordova

Interface CordovaWebView

All Known Implementing Classes:

CordovaWebViewImpl

public interface CordovaWebView

Main interface for interacting with a Cordova webview - implemented by CordovaWebViewImpl. This is an interface so that it can be easily mocked in tests. Methods may be added to this interface without a major version bump, as plugins & embedders are not expected to implement it.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CORDOVA_VERSION

Method Summary

Modifier and Type	Method and Description
boolean	backHistory()
boolean	canGoBack()
void	clearCache()
void	clearCache(boolean b) Deprecated.
void	clearHistory()
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, 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 statememt) 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()

Field Detail

CORDOVA_VERSION

static final java.lang.String CORDOVA_VERSION

See Also:

Constant Field Values

Method Detail

init

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

isInitialized

boolean isInitialized()

getView

android.view.View getView()

loadUrlIntoView

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

stopLoading

void stopLoading()

canGoBack

boolean canGoBack()

clearCache

void clearCache()

clearCache

@Deprecated
void clearCache(boolean b)

Deprecated.

Use parameter-less overload

clearHistory

void clearHistory()

backHistory

boolean backHistory()

handlePause

void handlePause(boolean keepRunning)

onNewIntent

void onNewIntent(android.content.Intent intent)

handleResume

void handleResume(boolean keepRunning)

handleStart

void handleStart()

handleStop

void handleStop()

handleDestroy

void handleDestroy()

sendJavascript

@Deprecated
void sendJavascript(java.lang.String statememt)

Deprecated.

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);

showWebPage

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. NOTE: If openExternal is false, only whitelisted URLs can be loaded.

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

isCustomViewShowing

@Deprecated
boolean isCustomViewShowing()

Deprecated.

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

showCustomView

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

Deprecated.

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

hideCustomView

@Deprecated
void hideCustomView()

Deprecated.

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

getResourceApi

CordovaResourceApi getResourceApi()

setButtonPlumbedToJs

void setButtonPlumbedToJs(int keyCode,
                          boolean override)

isButtonPlumbedToJs

boolean isButtonPlumbedToJs(int keyCode)

sendPluginResult

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

getPluginManager

PluginManager getPluginManager()

getEngine

CordovaWebViewEngine getEngine()

getPreferences

CordovaPreferences getPreferences()

getCookieManager

ICordovaCookieManager getCookieManager()

getUrl

java.lang.String getUrl()

getContext

android.content.Context getContext()

loadUrl

void loadUrl(java.lang.String url)

postMessage

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