com.facebook.react.views.scroll

Class ScrollEvent

java.lang.Object

com.facebook.react.uimanager.events.Event<ScrollEvent>

com.facebook.react.views.scroll.ScrollEvent

public class ScrollEvent
extends Event<ScrollEvent>

A event dispatched from a ScrollView scrolling.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_NAME

Constructor Summary

Constructors

Constructor and Description
ScrollEvent(int viewTag, long timestampMs, int scrollX, int scrollY, int contentWidth, int contentHeight, int scrollViewWidth, int scrollViewHeight)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatch(RCTEventEmitter rctEventEmitter) Dispatch this event to JS using the given event emitter.
short	getCoalescingKey()
java.lang.String	getEventName()

Methods inherited from class com.facebook.react.uimanager.events.Event

canCoalesce, coalesce, dispose, getTimestampMs, getViewTag

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_NAME

public static final java.lang.String EVENT_NAME

See Also:

Constant Field Values

Constructor Detail

ScrollEvent

public ScrollEvent(int viewTag,
           long timestampMs,
           int scrollX,
           int scrollY,
           int contentWidth,
           int contentHeight,
           int scrollViewWidth,
           int scrollViewHeight)

Method Detail

getEventName

public java.lang.String getEventName()

Specified by:

getEventName in class Event<ScrollEvent>

Returns:

the name of this event as registered in JS

getCoalescingKey

public short getCoalescingKey()

Overrides:

getCoalescingKey in class Event<ScrollEvent>

Returns:

a key used to determine which other events of this type this event can be coalesced with. For example, touch move events should only be coalesced within a single gesture so a coalescing key there would be the unique gesture id.

dispatch

public void dispatch(RCTEventEmitter rctEventEmitter)

Description copied from class: Event

Dispatch this event to JS using the given event emitter.

Specified by:

dispatch in class Event<ScrollEvent>