Files
react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/UIManager.java
T
David Vacca bc11e9c7f1 Expose getEventDispatcher() method into UIManager interface
Summary:
This diff promotes the UIManagerModule.getEventDispatcher() to the interface UIManager and it implements this method in FabricUIManager class.

Changelog: [internal]

Reviewed By: JoshuaGross

Differential Revision: D18862862

fbshipit-source-id: 424f0e601ed1807dbd5d33048daf7dc3bb200dcd
2019-12-10 20:33:55 -08:00

97 lines
3.4 KiB
Java

/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
package com.facebook.react.bridge;
import static com.facebook.infer.annotation.ThreadConfined.UI;
import android.view.View;
import androidx.annotation.Nullable;
import androidx.annotation.UiThread;
import com.facebook.infer.annotation.ThreadConfined;
public interface UIManager extends JSIModule, PerformanceCounter {
/** Registers a new root view. */
@UiThread
@ThreadConfined(UI)
<T extends View> int addRootView(
final T rootView, WritableMap initialProps, @Nullable String initialUITemplate);
/**
* Updates the layout specs of the RootShadowNode based on the Measure specs received by
* parameters.
*/
@UiThread
@ThreadConfined(UI)
void updateRootLayoutSpecs(int rootTag, int widthMeasureSpec, int heightMeasureSpec);
/**
* Dispatches the commandId received by parameter to the view associated with the reactTag. The
* command will be processed in the UIThread.
*
* <p>Receiving commands as ints is deprecated and will be removed in a future release.
*
* <p>Pre-Fabric, this is only called on the Native Module Thread.
*
* @param reactTag {@link int} that identifies the view that will receive this command
* @param commandId {@link int} command id
* @param commandArgs {@link ReadableArray} parameters associated with the command
*/
void dispatchCommand(int reactTag, int commandId, @Nullable ReadableArray commandArgs);
/**
* Dispatches the commandId received by parameter to the view associated with the reactTag. The
* command will be processed in the UIThread.
*
* <p>Pre-Fabric, this is only called on the Native Module Thread.
*
* @param reactTag {@link int} that identifies the view that will receive this command
* @param commandId {@link String} command id
* @param commandArgs {@link ReadableArray} parameters associated with the command
*/
void dispatchCommand(int reactTag, String commandId, @Nullable ReadableArray commandArgs);
/** @return the {@link EventDispatcher} object that is used by this class. */
<T> T getEventDispatcher();
/**
* Used by native animated module to bypass the process of updating the values through the shadow
* view hierarchy. This method will directly update native views, which means that updates for
* layout-related propertied won't be handled properly. Make sure you know what you're doing
* before calling this method :)
*
* @param tag {@link int} that identifies the view that will be updated
* @param props {@link ReadableMap} props that should be immediately updated in view
*/
@UiThread
@ThreadConfined(UI)
void synchronouslyUpdateViewOnUIThread(int reactTag, ReadableMap props);
/**
* Dispatch an accessibility event to a view asynchronously.
*
* <p>Pre-Fabric, this is only called on the Native Module Thread.
*
* @param reactTag
* @param eventType
*/
void sendAccessibilityEvent(int reactTag, int eventType);
/**
* When mounting instructions are scheduled on the UI thread, should they be executed immediately?
* For Fabric. Should noop in pre-Fabric.
*
* <p>This should only be called on the UI thread.
*
* @param flag
*/
@UiThread
@ThreadConfined(UI)
void setAllowImmediateUIOperationExecution(boolean flag);
}