ReactAndroid/com.facebook.react.uimanager/UIManagerModule

UIManagerModule

open class UIManagerModule : ReactContextBaseJavaModule, OnBatchCompleteListener, LifecycleEventListener, UIManager

Native module to allow JS to create and update native Views.

== Transactional Requirement ==

A requirement of this class is to make sure that transactional UI updates occur all at once, meaning that no intermediate state is ever rendered to the screen. For example, if a JS application update changes the background of View A to blue and the width of View B to 100, both need to appear at once. Practically, this means that all UI update code related to a single transaction must be executed as a single code block on the UI thread. Executing as multiple code blocks could allow the platform UI system to interrupt and render a partial UI state.

To facilitate this, this module enqueues operations that are then applied to native view hierarchy through NativeViewHierarchyManager at the end of each transaction.

== CSSNodes ==

In order to allow layout and measurement to occur on a non-UI thread, this module also operates on intermediate CSSNodeDEPRECATED objects that correspond to a native view. These CSSNodeDEPRECATED are able to calculate layout according to their styling rules, and then the resulting x/y/width/height of that layout is scheduled as an operation that will be applied to native view hierarchy at the end of current batch. TODO(5241856): Investigate memory usage of creating many small objects in UIManageModule and consider implementing a pool TODO(5483063): Don't dispatch the view hierarchy at the end of a batch if no UI changes occurred

Constructors

UIManagerModule

constructor(reactContext: ReactApplicationContext, viewManagerResolver: ViewManagerResolver, minTimeLeftInFrameForNonBatchedOperationMs: Int)

constructor(reactContext: ReactApplicationContext, viewManagersList: List<ViewManager>, minTimeLeftInFrameForNonBatchedOperationMs: Int)

Types

CustomEventNamesResolver

interface CustomEventNamesResolver

Resolves a name coming from native side to a name of the event that is exposed to JS.

Properties

METHOD_TYPE_ASYNC

val METHOD_TYPE_ASYNC: String = "async"

METHOD_TYPE_PROMISE

val METHOD_TYPE_PROMISE: String = "promise"

METHOD_TYPE_SYNC

val METHOD_TYPE_SYNC: String = "sync"

NAME

val NAME: String = "UIManager"

TAG

val TAG: String

Functions

addRootView

open fun <T : View?> addRootView(rootView: T): Int

open fun <T : View?> addRootView(rootView: T, initialProps: WritableMap): Int

Registers a new root view.

addUIBlock

open fun addUIBlock(block: UIBlock)

Schedule a block to be executed on the UI thread.

addUIManagerEventListener

open fun addUIManagerEventListener(listener: UIManagerListener)

addUIManagerListener

open fun ~~addUIManagerListener~~(listener: UIManagerModuleListener)

canOverrideExistingModule

open fun canOverrideExistingModule(): Boolean

Return true if you intend to override some other native module that was registered e.g.

clearJSResponder

open fun clearJSResponder()

configureNextLayoutAnimation

open fun configureNextLayoutAnimation(config: ReadableMap, success: Callback, error: Callback)

Configure an animation to be used for the native layout changes, and native views creation.

createConstants

open fun createConstants(viewManagers: List<ViewManager>, @Nullable customBubblingEvents: Map<String, Any>, @Nullable customDirectEvents: Map<String, Any>): Map<String, Any>

createView

open fun createView(tag: Int, className: String, rootViewTag: Int, props: ReadableMap)

dispatchCommand

open fun ~~dispatchCommand~~(reactTag: Int, commandId: Int, @Nullable commandArgs: ReadableArray)

Deprecated, use dispatchCommand instead.

open fun dispatchCommand(reactTag: Int, commandId: String, @Nullable commandArgs: ReadableArray)

Dispatches the commandId received by parameter to the view associated with the reactTag.

dispatchViewManagerCommand

open fun dispatchViewManagerCommand(reactTag: Int, commandId: Dynamic, @Nullable commandArgs: ReadableArray)

findSubviewIn

open fun findSubviewIn(reactTag: Int, point: ReadableArray, callback: Callback)

Find the touch target child native view in the supplied root view hierarchy, given a react target location.

getConstants

open fun getConstants(): Map<String, Any>

getConstantsForViewManager

@Nullable

open fun getConstantsForViewManager(viewManagerName: String): WritableMap

@Nullable

open fun getConstantsForViewManager(viewManager: ViewManager, customDirectEvents: Map<String, Any>): WritableMap

getDefaultEventTypes

open fun getDefaultEventTypes(): WritableMap

getDirectEventNamesResolver

open fun ~~getDirectEventNamesResolver~~(): UIManagerModule.CustomEventNamesResolver

Resolves Direct Event name exposed to JS from the one known to the Native side.

getEventDispatcher

open fun getEventDispatcher(): EventDispatcher

getName

@NonNull

open fun getName(): String

getPerformanceCounters

open fun getPerformanceCounters(): Map<String, Long>

getUIImplementation

open fun ~~getUIImplementation~~(): UIImplementation

This method gives an access to the UIImplementation object that can be used to execute operations on the view hierarchy.

getViewManagerRegistry_DO_NOT_USE

open fun ~~getViewManagerRegistry_DO_NOT_USE~~(): ViewManagerRegistry

This method is intended to reuse the ViewManagerRegistry with FabricUIManager.

initialize

open fun initialize()

This method is called after ReactApplicationContext has been created.

invalidate

open fun invalidate()

The CatalystInstance is going away with Venice.

invalidateNodeLayout

open fun invalidateNodeLayout(tag: Int)

Dirties the node associated with the given react tag

manageChildren

open fun manageChildren(viewTag: Int, @Nullable moveFrom: ReadableArray, @Nullable moveTo: ReadableArray, @Nullable addChildTags: ReadableArray, @Nullable addAtIndices: ReadableArray, @Nullable removeFrom: ReadableArray)

Interface for adding/removing/moving views within a parent view from JS.

markActiveTouchForTag

open fun markActiveTouchForTag(surfaceId: Int, reactTag: Int)

Mark a view as currently active for a touch event.

measure

open fun measure(reactTag: Int, callback: Callback)

Determines the location on screen, width, and height of the given view and returns the values via an async callback.

measureInWindow

open fun measureInWindow(reactTag: Int, callback: Callback)

Determines the location on screen, width, and height of the given view relative to the device screen and returns the values via an async callback.

measureLayout

open fun measureLayout(tag: Int, ancestorTag: Int, errorCallback: Callback, successCallback: Callback)

Measures the view specified by tag relative to the given ancestorTag.

onBatchComplete

open fun onBatchComplete()

To implement the transactional requirement mentioned in the class javadoc, we only commit UI changes to the actual view hierarchy once a batch of JS->Java calls have been completed.

onCatalystInstanceDestroy

open fun ~~onCatalystInstanceDestroy~~()

Allow NativeModule to clean up.

onHostDestroy

open fun onHostDestroy()

Called when host activity receives destroy event (e.g.

onHostPause

open fun onHostPause()

Called when host activity receives pause event (e.g.

onHostResume

open fun onHostResume()

Called either when the host activity receives a resume event (e.g.