com.facebook.react.views.scroll

Class ReactScrollViewManager

java.lang.Object

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

com.facebook.react.uimanager.ViewGroupManager<ReactScrollView>

com.facebook.react.views.scroll.ReactScrollViewManager

All Implemented Interfaces:

ReactScrollViewCommandHelper.ScrollCommandHandler<ReactScrollView>

public class ReactScrollViewManager
extends ViewGroupManager<ReactScrollView>
implements ReactScrollViewCommandHelper.ScrollCommandHandler<ReactScrollView>

View manager for ReactScrollView components.

Note that ReactScrollView and ReactHorizontalScrollView are exposed to JS as a single ScrollView component, configured via the horizontal boolean property.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_SHOWS_HORIZONTAL_SCROLL_INDICATOR
static java.lang.String	PROP_SHOWS_VERTICAL_SCROLL_INDICATOR

Constructor Summary

Constructors

Constructor and Description
ReactScrollViewManager()

Method Summary

Methods

Modifier and Type	Method and Description
ReactScrollView	createViewInstance(ThemedReactContext context) 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.util.Map	getExportedCustomDirectEventTypeConstants() Returns a map of config data passed to JS that defines eligible events that can be placed on native views.
java.lang.String	getName()
void	receiveCommand(ReactScrollView scrollView, int commandId, ReadableArray args) Subclasses may use this method to receive events/commands directly from JS through the UIManager.
void	scrollTo(ReactScrollView scrollView, ReactScrollViewCommandHelper.ScrollToCommandData data)
void	scrollWithoutAnimationTo(ReactScrollView scrollView, ReactScrollViewCommandHelper.ScrollToCommandData data)
void	updateView(ReactScrollView scrollView, CatalystStylesDiffMap props) Subclass should use this method to populate native view with updated style properties.

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

addView, createCSSNodeInstance, getChildAt, getChildCount, needsCustomLayoutForChildren, removeView, updateExtraData

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

addEventEmitters, createView, getExportedCustomBubblingEventTypeConstants, getExportedViewConstants, getNativeProps, onAfterUpdateTransaction, onDropViewInstance, updateProperties

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SHOWS_VERTICAL_SCROLL_INDICATOR

public static final java.lang.String PROP_SHOWS_VERTICAL_SCROLL_INDICATOR

See Also:

Constant Field Values

PROP_SHOWS_HORIZONTAL_SCROLL_INDICATOR

public static final java.lang.String PROP_SHOWS_HORIZONTAL_SCROLL_INDICATOR

See Also:

Constant Field Values

Constructor Detail

ReactScrollViewManager

public ReactScrollViewManager()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class ViewManager<ReactScrollView,ReactShadowNode>

Returns:

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

createViewInstance

public ReactScrollView createViewInstance(ThemedReactContext context)

Description copied from class: ViewManager

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

Specified by:

createViewInstance in class ViewManager<ReactScrollView,ReactShadowNode>

updateView

public void updateView(ReactScrollView scrollView,
              CatalystStylesDiffMap props)

Description copied from class: ViewManager

Subclass should use this method to populate native view with updated style properties. In case when a certain property is present in map but the value is null, this property should be reset to the default value TODO(krzysztof) This method should be replaced by updateProperties and removed completely after all view managers adapt @ReactProp

Overrides:

updateView in class ViewGroupManager<ReactScrollView>

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<ReactScrollView,ReactShadowNode>

Returns:

map of string to int mapping of the expected commands

receiveCommand

public void receiveCommand(ReactScrollView scrollView,
                  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<ReactScrollView,ReactShadowNode>

Parameters:

scrollView - View instance that should receive the command

commandId - code of the command

args - optional arguments for the command

scrollTo

public void scrollTo(ReactScrollView scrollView,
            ReactScrollViewCommandHelper.ScrollToCommandData data)

Specified by:

scrollTo in interface ReactScrollViewCommandHelper.ScrollCommandHandler<ReactScrollView>

scrollWithoutAnimationTo

public void scrollWithoutAnimationTo(ReactScrollView scrollView,
                            ReactScrollViewCommandHelper.ScrollToCommandData data)

Specified by:

scrollWithoutAnimationTo in interface ReactScrollViewCommandHelper.ScrollCommandHandler<ReactScrollView>

getExportedCustomDirectEventTypeConstants

@Nullable
public java.util.Map getExportedCustomDirectEventTypeConstants()

Description copied from class: ViewManager

Returns a map of config data passed to JS that defines eligible events that can be placed on native views. This should return non-bubbling directly-dispatched event types. Returned map should be of the form: { "onTwirl": { "registrationName": "onTwirl" } }

Overrides:

getExportedCustomDirectEventTypeConstants in class ViewManager<ReactScrollView,ReactShadowNode>