com.facebook.litho.sections.widget

Class RecyclerCollectionEventsController

java.lang.Object

com.facebook.litho.widget.RecyclerEventsController

com.facebook.litho.sections.widget.RecyclerCollectionEventsController

public class RecyclerCollectionEventsController
extends RecyclerEventsController

An controller that can be passed as Prop to a RecyclerCollection component to trigger events from outside the component hierarchy.

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.litho.widget.RecyclerEventsController

RecyclerEventsController.OnRecyclerUpdateListener

Constructor Summary

Constructors

Constructor and Description
RecyclerCollectionEventsController()

Method Summary

Modifier and Type	Method and Description
void	manuallySetViewportChangedFromExternalScroll(int firstVisibleIndex, int lastVisibleIndex, int firstFullyVisibleIndex, int lastFullyVisibleIndex) Deprecated.
void	requestRefresh() Sent the RecyclerCollection a request to refresh it's backing data.
void	requestRefresh(boolean showSpinner) Sent the RecyclerCollection a request to refresh it's backing data.
void	requestScrollBy(int dx, int dy) Send the RecyclerCollectionComponent a request to scroll the content by the given margins.
void	requestScrollToNextPosition(boolean animated) Send the RecyclerCollectionComponent a request to scroll the content to the next item in the binder.
void	requestScrollToPositionWithSnap(int target) Send the RecyclerCollectionComponent a request to scroll the content to the given target position taking into account snapping behavior.
void	requestScrollToPositionWithSnap(int target, boolean animated) Send the RecyclerCollectionComponent a request to scroll the content to the given target position taking into account snapping behavior.
void	requestScrollToPositionWithSnap(int target, RecyclerView.SmoothScroller smoothScroller) Send the RecyclerCollectionComponent a request to scroll the content to the given target position taking into account provided snapping behavior.
void	requestScrollToPreviousPosition(boolean animated) Send the RecyclerCollectionComponent a request to scroll the content to the previous item in the binder.
void	requestSmoothScrollBy(int dx, int dy) Send the RecyclerCollectionComponent a request to scroll the content by the given margins, animate a scroll by the given amount of pixels along either axis.
void	setSectionTree(SectionTree sectionTree)
void	setSnapMode(int snapMode)
void	updateFirstLastFullyVisibleItemPositions(LayoutInfo layoutInfo)

Methods inherited from class com.facebook.litho.widget.RecyclerEventsController

clearRefreshing, getRecyclerView, requestScrollToPosition, requestScrollToPositionWithOffset, requestScrollToTop, setOnRecyclerUpdateListener, setSectionsRecyclerView, showRefreshing

Methods inherited from class java.lang.Object

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

Constructor Detail

RecyclerCollectionEventsController

public RecyclerCollectionEventsController()

Method Detail

requestRefresh

public void requestRefresh()

Sent the RecyclerCollection a request to refresh it's backing data.

requestRefresh

public void requestRefresh(boolean showSpinner)

Sent the RecyclerCollection a request to refresh it's backing data. If showSpinner is true, then refresh spinner is shown.

Parameters:

showSpinner -

requestScrollToNextPosition

public void requestScrollToNextPosition(boolean animated)

Send the RecyclerCollectionComponent a request to scroll the content to the next item in the binder.

Parameters:

animated - whether the scroll will happen with animation.

requestScrollToPreviousPosition

public void requestScrollToPreviousPosition(boolean animated)

Send the RecyclerCollectionComponent a request to scroll the content to the previous item in the binder.

Parameters:

animated - whether the scroll will happen with animation.

requestScrollToPositionWithSnap

public void requestScrollToPositionWithSnap(int target)

Send the RecyclerCollectionComponent a request to scroll the content to the given target position taking into account snapping behavior.

For example, if the content is center snapped, then the RecyclerView will scroll contents until the target position is visible at the center (as opposed to the edge of RecyclerView which is the case when using RecyclerEventsController.requestScrollToPosition(int, boolean)).

requestScrollToPositionWithSnap

public void requestScrollToPositionWithSnap(int target,
                                            boolean animated)

Send the RecyclerCollectionComponent a request to scroll the content to the given target position taking into account snapping behavior. Can toggle if the scroll is animated

requestScrollToPositionWithSnap

public void requestScrollToPositionWithSnap(int target,
                                            RecyclerView.SmoothScroller smoothScroller)

Send the RecyclerCollectionComponent a request to scroll the content to the given target position taking into account provided snapping behavior. The provided smoothScroller is used to scroll to the target.

requestScrollBy

public void requestScrollBy(int dx,
                            int dy)

Send the RecyclerCollectionComponent a request to scroll the content by the given margins.

requestSmoothScrollBy

public void requestSmoothScrollBy(int dx,
                                  int dy)

Send the RecyclerCollectionComponent a request to scroll the content by the given margins, animate a scroll by the given amount of pixels along either axis.

setSectionTree

public void setSectionTree(SectionTree sectionTree)

setSnapMode

public void setSnapMode(int snapMode)

updateFirstLastFullyVisibleItemPositions

public void updateFirstLastFullyVisibleItemPositions(LayoutInfo layoutInfo)

manuallySetViewportChangedFromExternalScroll

@Deprecated
public void manuallySetViewportChangedFromExternalScroll(int firstVisibleIndex,
                                                                     int lastVisibleIndex,
                                                                     int firstFullyVisibleIndex,
                                                                     int lastFullyVisibleIndex)

Deprecated.

Sets the viewport visibility of the items in the SectionTree held by this recycler manually.

You almost definitely don't want to use this. Please talk to the Litho team if you think you need to!