ReactAndroid/com.facebook.react.uimanager/ViewGroupManager

ViewGroupManager

abstract class ViewGroupManager<T : ViewGroup?> : BaseViewManager<T, C> , IViewGroupManager<T>

Class providing children management API for view managers of classes extending ViewGroup.

Inheritors

Constructors

Link copied to clipboard
constructor()
constructor(@Nullable reactContext: ReactApplicationContext)

Properties

Link copied to clipboard
val METHOD_TYPE_ASYNC: String = "async"
Link copied to clipboard
val METHOD_TYPE_PROMISE: String = "promise"
Link copied to clipboard
val METHOD_TYPE_SYNC: String = "sync"

Functions

Link copied to clipboard
open fun addView(parent: T, child: View, index: Int)
Adds a child view into the parent at the index specified as a parameter
Link copied to clipboard
open fun addViews(parent: T, views: List<View>)
Convenience method for batching a set of addView calls Note that this adds the views to the beginning of the ViewGroup
Link copied to clipboard
open fun canOverrideExistingModule(): Boolean
Return true if you intend to override some other native module that was registered e.g.
Link copied to clipboard
open fun createShadowNodeInstance(): LayoutShadowNode
This method should return a subclass of ReactShadowNode which will be then used for measuring position and size of the view.
@NonNull
open fun createShadowNodeInstance(@NonNull context: ReactApplicationContext): C
Link copied to clipboard
@NonNull
open fun createView(reactTag: Int, @NonNull reactContext: ThemedReactContext, @Nullable props: ReactStylesDiffMap, @Nullable stateWrapper: StateWrapper, jsResponderHandler: JSResponderHandler): T
Creates a view with knowledge of props and state.
Link copied to clipboard
open fun experimental_prefetchResource(reactContext: ReactContext, surfaceId: Int, reactTag: Int, params: MapBuffer)
THIS PREFETCH METHOD IS EXPERIMENTAL, DO NOT USE IT FOR PRODUCTION CODE, MOST LIKELY IT WILL CHANGE OR BE REMOVED IN THE FUTURE.
Link copied to clipboard
@Nullable
open fun getChildAt(parent: T, index: Int): View
Link copied to clipboard
open fun getChildCount(parent: T): Int
Return the amount of children contained by the view specified as a parameter.
Link copied to clipboard
@Nullable
open fun getCommandsMap(): Map<String, Integer>
Subclasses of ViewManager that expect to receive commands through dispatchViewManagerCommand should override this method returning the map between names of the commands and IDs that are then used in receiveCommand method whenever the command is dispatched for this particular ViewManager.
Link copied to clipboard
@Nullable
open fun getExportedCustomBubblingEventTypeConstants(): Map<String, Any>
Returns a map of config data passed to JS that defines eligible events that can be placed on native views.
@Nullable
open fun getExportedCustomDirectEventTypeConstants(): Map<String, Any>
Returns a map of config data passed to JS that defines eligible events that can be placed on native views.
Link copied to clipboard
@Nullable
open fun getExportedViewConstants(): Map<String, Any>
Returns a map of view-specific constants that are injected to JavaScript.
Link copied to clipboard
@NonNull
abstract fun getName(): String
Link copied to clipboard
open fun getNativeProps(): Map<String, String>
Returns a , representing the native props of the view manager.
Link copied to clipboard
open fun getShadowNodeClass(): Class<out LayoutShadowNode>
This method should return Class instance that represent type of shadow node that this manager will return from createShadowNodeInstance.
Link copied to clipboard
Link copied to clipboard
open fun initialize()
This method is called after ReactApplicationContext has been created.
Link copied to clipboard
open fun invalidate()
The CatalystInstance is going away with Venice.
Link copied to clipboard
open fun measure(context: Context, localData: ReadableMap, props: ReadableMap, state: ReadableMap, width: Float, widthMode: YogaMeasureMode, height: Float, heightMode: YogaMeasureMode, @Nullable attachmentsPositions: Array<Float>): Long
Subclasses can override this method to implement custom measure functions for the ViewManager
open fun measure(context: Context, localData: MapBuffer, props: MapBuffer, @Nullable state: MapBuffer, width: Float, widthMode: YogaMeasureMode, height: Float, heightMode: YogaMeasureMode, @Nullable attachmentsPositions: Array<Float>): Long
THIS MEASURE METHOD IS EXPERIMENTAL, MOST LIKELY YOU ARE LOOKING TO USE THE OTHER OVERLOAD INSTEAD: measureSubclasses can override this method to implement custom measure functions for the ViewManager
Link copied to clipboard
open fun needsCustomLayoutForChildren(): Boolean
Returns whether this View type needs to handle laying out its own children instead of deferring to the standard css-layout algorithm.
Link copied to clipboard
open fun onCatalystInstanceDestroy()
Allow NativeModule to clean up.
Link copied to clipboard
open fun onDropViewInstance(@NonNull view: T)
Called when view is detached from view hierarchy and allows for some additional cleanup by the ViewManager subclass.
Link copied to clipboard
abstract fun onLayoutChange(p: View, p1: Int, p2: Int, p3: Int, p4: Int, p5: Int, p6: Int, p7: Int, p8: Int)
open fun onLayoutChange(v: View, left: Int, top: Int, right: Int, bottom: Int, oldLeft: Int, oldTop: Int, oldRight: Int, oldBottom: Int)
Link copied to clipboard
open fun onSurfaceStopped(surfaceId: Int)
Lifecycle method: called when a surface is stopped.
Link copied to clipboard
open fun receiveCommand(@NonNull root: T, commandId: Int, @Nullable args: ReadableArray)
open fun receiveCommand(@NonNull root: T, commandId: String, @Nullable args: ReadableArray)
Subclasses may use this method to receive events/commands directly from JS through the .
Link copied to clipboard
open fun removeAllViews(parent: T)

Remove all child views from the parent View.

Link copied to clipboard
open fun removeView(parent: T, view: View)
Link copied to clipboard
open fun removeViewAt(parent: T, index: Int)
Removes View from the parent View at the index specified as a parameter.
Link copied to clipboard
open fun setAccessibilityActions(view: T, accessibilityActions: ReadableArray)
Link copied to clipboard
open fun setAccessibilityCollection(@NonNull view: T, @Nullable accessibilityCollection: ReadableMap)
Link copied to clipboard
open fun setAccessibilityCollectionItem(@NonNull view: T, @Nullable accessibilityCollectionItem: ReadableMap)
Link copied to clipboard
open fun setAccessibilityHint(@NonNull view: T, @Nullable accessibilityHint: String)
Link copied to clipboard
open fun setAccessibilityLabel(@NonNull view: T, @Nullable accessibilityLabel: String)
Link copied to clipboard
open fun setAccessibilityLabelledBy(@NonNull view: T, @Nullable nativeId: Dynamic)
Link copied to clipboard
open fun setAccessibilityLiveRegion(@NonNull view: T, @Nullable liveRegion: String)
Link copied to clipboard
open fun setAccessibilityOrder(@NonNull view: T, @Nullable nativeIds: ReadableArray)
Link copied to clipboard
open fun setAccessibilityRole(@NonNull view: T, @Nullable accessibilityRole: String)
Link copied to clipboard
open fun setAccessibilityValue(view: T, accessibilityValue: ReadableMap)
Link copied to clipboard
open fun setBackgroundColor(@NonNull view: T, @ColorInt backgroundColor: Int)
Link copied to clipboard
open fun setBorderBottomLeftRadius(view: T, borderRadius: Float)
Link copied to clipboard
open fun setBorderBottomRightRadius(view: T, borderRadius: Float)
Link copied to clipboard
open fun setBorderRadius(view: T, borderRadius: Float)
Link copied to clipboard
open fun setBorderTopLeftRadius(view: T, borderRadius: Float)
Link copied to clipboard
open fun setBorderTopRightRadius(view: T, borderRadius: Float)
Link copied to clipboard
open fun setBoxShadow(view: T, @Nullable shadows: ReadableArray)
Link copied to clipboard
open fun setClick(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setClickCapture(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setElevation(@NonNull view: T, elevation: Float)
Link copied to clipboard
open fun setFilter(@NonNull view: T, @Nullable filter: ReadableArray)
Link copied to clipboard
open fun setImportantForAccessibility(@NonNull view: T, @Nullable importantForAccessibility: String)
Link copied to clipboard
open fun setMixBlendMode(@NonNull view: T, @Nullable mixBlendMode: String)
Link copied to clipboard
open fun setMoveShouldSetResponder(@NonNull view: T, value: Boolean)
Link copied to clipboard
Link copied to clipboard
open fun setNativeId(@NonNull view: T, @Nullable nativeId: String)
Link copied to clipboard
open fun setOpacity(@NonNull view: T, opacity: Float)
Link copied to clipboard
open fun setOutlineColor(view: T, @Nullable color: Integer)
Link copied to clipboard
open fun setOutlineOffset(view: T, offset: Float)
Link copied to clipboard
open fun setOutlineStyle(view: T, @Nullable outlineStyle: String)
Link copied to clipboard
open fun setOutlineWidth(view: T, width: Float)
Link copied to clipboard
open fun setPadding(view: T, left: Int, top: Int, right: Int, bottom: Int)
Subclasses can override this method to set padding for the given View in Fabric.
Link copied to clipboard
open fun setPointerEnter(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerEnterCapture(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerLeave(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerLeaveCapture(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerMove(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerMoveCapture(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerOut(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerOutCapture(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerOver(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setPointerOverCapture(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setRenderToHardwareTexture(@NonNull view: T, useHWTexture: Boolean)
Link copied to clipboard
open fun setResponderEnd(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderGrant(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderMove(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderReject(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderRelease(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderStart(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderTerminate(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setResponderTerminationRequest(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setRole(@NonNull view: T, @Nullable role: String)
Link copied to clipboard
open fun setRotation(@NonNull view: T, rotation: Float)
Link copied to clipboard
open fun setScaleX(@NonNull view: T, scaleX: Float)
Link copied to clipboard
open fun setScaleY(@NonNull view: T, scaleY: Float)
Link copied to clipboard
open fun setShadowColor(@NonNull view: T, shadowColor: Int)
Link copied to clipboard
open fun setShouldBlockNativeResponder(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setStartShouldSetResponder(@NonNull view: T, value: Boolean)
Link copied to clipboard
Link copied to clipboard
open fun setTestId(@NonNull view: T, @Nullable testId: String)
Link copied to clipboard
open fun setTouchCancel(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setTouchEnd(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setTouchMove(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setTouchStart(@NonNull view: T, value: Boolean)
Link copied to clipboard
open fun setTransform(@NonNull view: T, @Nullable matrix: ReadableArray)
Link copied to clipboard
open fun setTransformOrigin(@NonNull view: T, @Nullable transformOrigin: ReadableArray)
Link copied to clipboard
open fun setTranslateX(@NonNull view: T, translateX: Float)
Link copied to clipboard
open fun setTranslateY(@NonNull view: T, translateY: Float)
Link copied to clipboard
open fun setViewState(@NonNull view: T, @Nullable accessibilityState: ReadableMap)
Link copied to clipboard
open fun setViewZIndex(view: View, zIndex: Int)
Link copied to clipboard
open fun setZIndex(@NonNull view: T, zIndex: Float)
Link copied to clipboard
open fun updateExtraData(root: T, extraData: Any)
Subclasses can implement this method to receive an optional extra data enqueued from the corresponding instance of ReactShadowNode in onCollectExtraUpdates.
Link copied to clipboard
open fun updateProperties(@NonNull viewToUpdate: T, props: ReactStylesDiffMap)
For the vast majority of ViewManagers, you will not need to override this.
Link copied to clipboard
@Nullable
open fun updateState(@NonNull view: T, props: ReactStylesDiffMap, stateWrapper: StateWrapper): Any
Subclasses can implement this method to receive state updates shared between all instances of this component type.