com.facebook.react.views.webview

Class ReactWebViewManager

java.lang.Object

com.facebook.react.bridge.BaseJavaModule

com.facebook.react.uimanager.ViewManager<T,C>

com.facebook.react.uimanager.BaseViewManager<T,LayoutShadowNode>

com.facebook.react.uimanager.SimpleViewManager<android.webkit.WebView>

com.facebook.react.views.webview.ReactWebViewManager

All Implemented Interfaces:

NativeModule

public class ReactWebViewManager
extends SimpleViewManager<android.webkit.WebView>

Manages instances of WebView Can accept following commands: - GO_BACK - GO_FORWARD - RELOAD WebView instances could emit following direct events: - topLoadingFinish - topLoadingStart - topLoadingError Each event will carry the following properties: - target - view's react tag - url - url set for the webview - loading - whether webview is in a loading state - title - title of the current page - canGoBack - boolean, whether there is anything on a history stack to go back - canGoForward - boolean, whether it is possible to request GO_FORWARD command

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ReactWebViewManager.ReactWebView Subclass of WebView that implements LifecycleEventListener interface in order to call WebView.destroy() on activty destroy event and also to clear the client
protected static class	ReactWebViewManager.ReactWebViewClient

Nested classes/interfaces inherited from class com.facebook.react.bridge.BaseJavaModule

BaseJavaModule.JavaMethod

Nested classes/interfaces inherited from interface com.facebook.react.bridge.NativeModule

NativeModule.NativeMethod

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_GO_BACK
static int	COMMAND_GO_FORWARD
static int	COMMAND_INJECT_JAVASCRIPT
static int	COMMAND_POST_MESSAGE
static int	COMMAND_RELOAD
static int	COMMAND_STOP_LOADING
protected static java.lang.String	REACT_CLASS

Fields inherited from class com.facebook.react.uimanager.BaseViewManager

PROP_TEST_ID

Fields inherited from class com.facebook.react.bridge.BaseJavaModule

METHOD_TYPE_ASYNC, METHOD_TYPE_PROMISE, METHOD_TYPE_SYNC

Constructor Summary

Constructors

Constructor and Description
ReactWebViewManager()
ReactWebViewManager(WebViewConfig webViewConfig)

Method Summary

Modifier and Type	Method and Description
protected void	addEventEmitters(ThemedReactContext reactContext, android.webkit.WebView view) Subclasses can override this method to install custom event emitters on the given View.
protected android.webkit.WebView	createViewInstance(ThemedReactContext reactContext) Subclasses should return a new View instance of the proper type.
java.util.Map<java.lang.String,java.lang.Integer>	getCommandsMap() Subclasses of ViewManager that expect to receive commands through UIManagerModule.dispatchViewManagerCommand(int, int, com.facebook.react.bridge.ReadableArray) should override this method returning the map between names of the commands and IDs that are then used in ViewManager.receiveCommand(T, int, com.facebook.react.bridge.ReadableArray) method whenever the command is dispatched for this particular ViewManager.
java.lang.String	getName()
void	onDropViewInstance(android.webkit.WebView webView) Called when view is detached from view hierarchy and allows for some additional cleanup by the ViewManager subclass.
void	receiveCommand(android.webkit.WebView root, int commandId, ReadableArray args) Subclasses may use this method to receive events/commands directly from JS through the UIManager.
void	setAllowUniversalAccessFromFileURLs(android.webkit.WebView view, boolean allow)
void	setDomStorageEnabled(android.webkit.WebView view, boolean enabled)
void	setInjectedJavaScript(android.webkit.WebView view, java.lang.String injectedJavaScript)
void	setJavaScriptEnabled(android.webkit.WebView view, boolean enabled)
void	setMediaPlaybackRequiresUserAction(android.webkit.WebView view, boolean requires)
void	setMessagingEnabled(android.webkit.WebView view, boolean enabled)
void	setOnContentSizeChange(android.webkit.WebView view, boolean sendContentSizeChangeEvents)
void	setScalesPageToFit(android.webkit.WebView view, boolean enabled)
void	setSource(android.webkit.WebView view, ReadableMap source)
void	setUserAgent(android.webkit.WebView view, java.lang.String userAgent)

Methods inherited from class com.facebook.react.uimanager.SimpleViewManager

createShadowNodeInstance, getShadowNodeClass, updateExtraData

Methods inherited from class com.facebook.react.uimanager.BaseViewManager

setAccessibilityComponentType, setAccessibilityLabel, setAccessibilityLiveRegion, setBackgroundColor, setElevation, setImportantForAccessibility, setOpacity, setRenderToHardwareTexture, setRotation, setScaleX, setScaleY, setTestId, setTransform, setTranslateX, setTranslateY, setZIndex

Methods inherited from class com.facebook.react.uimanager.ViewManager

createView, getExportedCustomBubblingEventTypeConstants, getExportedCustomDirectEventTypeConstants, getExportedViewConstants, getNativeProps, onAfterUpdateTransaction, updateProperties

Methods inherited from class com.facebook.react.bridge.BaseJavaModule

canOverrideExistingModule, getConstants, getMethods, initialize, onCatalystInstanceDestroy, supportsWebWorkers

Methods inherited from class java.lang.Object

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

Field Detail

REACT_CLASS

protected static final java.lang.String REACT_CLASS

See Also:

Constant Field Values

COMMAND_GO_BACK

public static final int COMMAND_GO_BACK

See Also:

Constant Field Values

COMMAND_GO_FORWARD

public static final int COMMAND_GO_FORWARD

See Also:

Constant Field Values

COMMAND_RELOAD

public static final int COMMAND_RELOAD

See Also:

Constant Field Values

COMMAND_STOP_LOADING

public static final int COMMAND_STOP_LOADING

See Also:

Constant Field Values

COMMAND_POST_MESSAGE

public static final int COMMAND_POST_MESSAGE

See Also:

Constant Field Values

COMMAND_INJECT_JAVASCRIPT

public static final int COMMAND_INJECT_JAVASCRIPT

See Also:

Constant Field Values

Constructor Detail

ReactWebViewManager

public ReactWebViewManager()

ReactWebViewManager

public ReactWebViewManager(WebViewConfig webViewConfig)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface NativeModule

Specified by:

getName in class ViewManager<android.webkit.WebView,LayoutShadowNode>

Returns:

the name of this view manager. This will be the name used to reference this view manager from JavaScript in createReactNativeComponentClass.

createViewInstance

protected android.webkit.WebView createViewInstance(ThemedReactContext reactContext)

Description copied from class: ViewManager

Subclasses should return a new View instance of the proper type.

Specified by:

createViewInstance in class ViewManager<android.webkit.WebView,LayoutShadowNode>

setJavaScriptEnabled

public void setJavaScriptEnabled(android.webkit.WebView view,
                                 boolean enabled)

setScalesPageToFit

public void setScalesPageToFit(android.webkit.WebView view,
                               boolean enabled)

setDomStorageEnabled

public void setDomStorageEnabled(android.webkit.WebView view,
                                 boolean enabled)

setUserAgent

public void setUserAgent(android.webkit.WebView view,
                         @Nullable
                         java.lang.String userAgent)

setMediaPlaybackRequiresUserAction

public void setMediaPlaybackRequiresUserAction(android.webkit.WebView view,
                                               boolean requires)

setAllowUniversalAccessFromFileURLs

public void setAllowUniversalAccessFromFileURLs(android.webkit.WebView view,
                                                boolean allow)

setInjectedJavaScript

public void setInjectedJavaScript(android.webkit.WebView view,
                                  @Nullable
                                  java.lang.String injectedJavaScript)

setMessagingEnabled

public void setMessagingEnabled(android.webkit.WebView view,
                                boolean enabled)

setSource

public void setSource(android.webkit.WebView view,
                      @Nullable
                      ReadableMap source)

setOnContentSizeChange

public void setOnContentSizeChange(android.webkit.WebView view,
                                   boolean sendContentSizeChangeEvents)

addEventEmitters

protected void addEventEmitters(ThemedReactContext reactContext,
                                android.webkit.WebView view)

Description copied from class: ViewManager

Subclasses can override this method to install custom event emitters on the given View. You might want to override this method if your view needs to emit events besides basic touch events to JS (e.g. scroll events).

Overrides:

addEventEmitters in class ViewManager<android.webkit.WebView,LayoutShadowNode>

getCommandsMap

@Nullable
public java.util.Map<java.lang.String,java.lang.Integer> getCommandsMap()

Description copied from class: ViewManager

Subclasses of ViewManager that expect to receive commands through UIManagerModule.dispatchViewManagerCommand(int, int, com.facebook.react.bridge.ReadableArray) should override this method returning the map between names of the commands and IDs that are then used in ViewManager.receiveCommand(T, int, com.facebook.react.bridge.ReadableArray) method whenever the command is dispatched for this particular ViewManager. As an example we may consider ReactWebViewManager that expose the following commands: goBack, goForward, reload. In this case the map returned from ViewManager.getCommandsMap() from ReactWebViewManager will look as follows: { "goBack": 1, "goForward": 2, "reload": 3, } Now assuming that "reload" command is dispatched through UIManagerModule we trigger ReactWebViewManager#receiveCommand passing "3" as commandId argument.

Overrides:

getCommandsMap in class ViewManager<android.webkit.WebView,LayoutShadowNode>

Returns:

map of string to int mapping of the expected commands

receiveCommand

public void receiveCommand(android.webkit.WebView root,
                           int commandId,
                           @Nullable
                           ReadableArray args)

Description copied from class: ViewManager

Subclasses may use this method to receive events/commands directly from JS through the UIManager. Good example of such a command would be scrollTo request with coordinates for a ScrollView or goBack request for a WebView instance.

Overrides:

receiveCommand in class ViewManager<android.webkit.WebView,LayoutShadowNode>

Parameters:

root - View instance that should receive the command

commandId - code of the command

args - optional arguments for the command

onDropViewInstance

public void onDropViewInstance(android.webkit.WebView webView)

Description copied from class: ViewManager

Called when view is detached from view hierarchy and allows for some additional cleanup by the ViewManager subclass.

Overrides:

onDropViewInstance in class ViewManager<android.webkit.WebView,LayoutShadowNode>