com.facebook.litho.widget

Class RecyclerEventsController

java.lang.Object

com.facebook.litho.widget.RecyclerEventsController

Direct Known Subclasses:

RecyclerCollectionEventsController

public class RecyclerEventsController
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecyclerEventsController.OnRecyclerUpdateListener

Constructor Summary

Constructors

Constructor and Description
RecyclerEventsController()

Method Summary

Modifier and Type	Method and Description
void	clearRefreshing()
RecyclerView	getRecyclerView()
void	requestScrollToPosition(int position, boolean animated) Send the Recycler a request to scroll the content to a specific item in the binder.
void	requestScrollToPositionWithOffset(int position, int offset) Send the Recycler a request to scroll the content to a specific item in the binder with the given offset from resolved layout start.
void	requestScrollToTop(boolean animated) Send the Recycler a request to scroll the content to the first item in the binder.
void	setOnRecyclerUpdateListener(RecyclerEventsController.OnRecyclerUpdateListener onRecyclerUpdateListener)
void	setSectionsRecyclerView(SectionsRecyclerView sectionsRecyclerView)
void	showRefreshing()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecyclerEventsController

public RecyclerEventsController()

Method Detail

requestScrollToTop

public void requestScrollToTop(boolean animated)

Send the Recycler a request to scroll the content to the first item in the binder.

Parameters:

animated - if animated is set to true the scroll will happen with an animation.

requestScrollToPosition

public void requestScrollToPosition(int position,
                                    boolean animated)

Send the Recycler a request to scroll the content to a specific item in the binder.

Parameters:

animated - if animated is set to true the scroll will happen with an animation.

requestScrollToPositionWithOffset

public void requestScrollToPositionWithOffset(int position,
                                              int offset)

Send the Recycler a request to scroll the content to a specific item in the binder with the given offset from resolved layout start. Animation will not be performed.

If you are just trying to make a position visible, use requestScrollToPosition(int, boolean).

Note: This offset is valid for LinearLayout only!

Parameters:

position - Index (starting at 0) of the reference item.

offset - The distance (in pixels) between the start edge of the item view and start edge of the RecyclerView.

clearRefreshing

public void clearRefreshing()

showRefreshing

public void showRefreshing()

setSectionsRecyclerView

public void setSectionsRecyclerView(SectionsRecyclerView sectionsRecyclerView)

getRecyclerView

public RecyclerView getRecyclerView()

setOnRecyclerUpdateListener

public void setOnRecyclerUpdateListener(RecyclerEventsController.OnRecyclerUpdateListener onRecyclerUpdateListener)