com.facebook.react.uimanager.events

Class Event<T extends Event>

java.lang.Object

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

Direct Known Subclasses:

DrawerClosedEvent, DrawerOpenedEvent, DrawerSlideEvent, DrawerStateChangedEvent, ScrollEvent, ToolbarClickEvent, TouchEvent

public abstract class Event<T extends Event>
extends java.lang.Object

A UI event that can be dispatched to JS.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Event(int viewTag, long timestampMs)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCoalesce()
T	coalesce(T otherEvent) Given two events, coalesce them into a single event that will be sent to JS instead of two separate events.
abstract void	dispatch(RCTEventEmitter rctEventEmitter) Dispatch this event to JS using the given event emitter.
void	dispose() Called when the EventDispatcher is done with an event, either because it was dispatched or because it was coalesced with another Event.
short	getCoalescingKey()
abstract java.lang.String	getEventName()
long	getTimestampMs()
int	getViewTag()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

protected Event(int viewTag,
     long timestampMs)

Method Detail

getViewTag

public final int getViewTag()

Returns:

the view id for the view that generated this event

getTimestampMs

public final long getTimestampMs()

Returns:

the time at which the event happened in the SystemClock.uptimeMillis() base.

canCoalesce

public boolean canCoalesce()

Returns:

false if this Event can *never* be coalesced

coalesce

public T coalesce(T otherEvent)

Given two events, coalesce them into a single event that will be sent to JS instead of two separate events. By default, just chooses the one the is more recent. Two events will only ever try to be coalesced if they have the same event name, view id, and coalescing key.

getCoalescingKey

public short getCoalescingKey()

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.

dispose

public void dispose()

Called when the EventDispatcher is done with an event, either because it was dispatched or because it was coalesced with another Event.

getEventName

public abstract java.lang.String getEventName()

Returns:

the name of this event as registered in JS

dispatch

public abstract void dispatch(RCTEventEmitter rctEventEmitter)

Dispatch this event to JS using the given event emitter.