RecyclerBinder

java.lang.Object
- com.facebook.litho.widget.RecyclerBinder

All Implemented Interfaces:

Binder<RecyclerView>, HasStickyHeader, LayoutInfo.RenderInfoCollection, ViewportInfo
```
public class RecyclerBinder
extends java.lang.Object
implements Binder<RecyclerView>, LayoutInfo.RenderInfoCollection, HasStickyHeader
```
This binder class is used to asynchronously layout Components given a list of Component and attaching them to a RecyclerSpec.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RecyclerBinder.Builder`
`static interface`	`RecyclerBinder.CommitPolicy` Defines when a batch should be committed: - IMMEDIATE: Commit batches to the RecyclerView as soon as possible.
`static class`	`RecyclerBinder.RecyclerViewLayoutManagerOverrideParams`

Nested classes/interfaces inherited from interface com.facebook.litho.widget.ViewportInfo
ViewportInfo.State, ViewportInfo.ViewportChanged

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ID_CUSTOM_ATTR_KEY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ID_CUSTOM_ATTR_KEY`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendItem(Component component)` See `appendItem(RenderInfo)`.
`void`	`appendItem(RenderInfo renderInfo)` Inserts a new item at tail.
`void`	`bind(RecyclerView view)` Bind this `Binder` to a `View`.
`boolean`	`canMeasure()` Only for horizontally scrolling layouts: return true if height is not known when measuring the view and the first item will be measured to determine the height.
`void`	`clearAsync()` Removes all items in this binder async.
`void`	`detach()` Detach items under the hood.
`int`	`findFirstFullyVisibleItemPosition()`
`int`	`findFirstVisibleItemPosition()`
`int`	`findLastFullyVisibleItemPosition()`
`int`	`findLastVisibleItemPosition()`
`ComponentTree`	`getComponentAt(int position)` Returns the `ComponentTree` for the item at index position.
`ComponentTree`	`getComponentForStickyHeaderAt(int position)`
`ComponentTreeHolder`	`getComponentTreeHolderAt(int position)`
`RecyclerView.Adapter`	`getInternalAdapter()`
`int`	`getItemCount()` Gets the number of items currently in the adapter attached to this binder (i.e.
`RenderInfo`	`getRenderInfoAt(int position)`
`void`	`insertItemAt(int position, Component component)` See `insertItemAt(int, RenderInfo)`.
`void`	`insertItemAt(int position, RenderInfo renderInfo)` Inserts a new item at position.
`void`	`insertItemAtAsync(int position, RenderInfo renderInfo)` Inserts an item at position.
`void`	`insertRangeAt(int position, java.util.List<RenderInfo> renderInfos)` Inserts the new items starting from position.
`void`	`insertRangeAtAsync(int position, java.util.List<RenderInfo> renderInfos)` Inserts the new items starting from position.
`boolean`	`isSticky(int position)`
`boolean`	`isValidPosition(int position)`
`boolean`	`isWrapContent()` Return true if wrap content is enabled, false otherwise.
`void`	`measure(Size outSize, int widthSpec, int heightSpec, EventHandler<ReMeasureEvent> reMeasureEventHandler)` A component mounting a RecyclerView can use this method to determine its size.
`void`	`mount(RecyclerView view)` Call from the owning `Component`'s onMount.
`void`	`moveItem(int fromPosition, int toPosition)` Moves an item from fromPosition to toPosition.
`void`	`moveItemAsync(int fromPosition, int toPosition)` Moves an item from fromPosition to toPostion.
`void`	`notifyChangeSetComplete(boolean isDataChanged, ChangeSetCompleteCallback changeSetCompleteCallback)` Called after all the change set operations (inserts, removes, etc.) in a batch have completed.
`void`	`notifyChangeSetCompleteAsync(boolean isDataChanged, ChangeSetCompleteCallback changeSetCompleteCallback)` Called after all the change set operations (inserts, removes, etc.) in a batch have completed.
`void`	`notifyItemRenderCompleteAt(int position, long timestampMillis)`
`void`	`removeItemAt(int position)` Removes an item from index position.
`void`	`removeItemAtAsync(int position)` Removes an item from position.
`void`	`removeRangeAt(int position, int count)` Removes count items starting from position.
`void`	`removeRangeAtAsync(int position, int count)` Removes count items starting from position.
`void`	`removeSubAdapterModeRecyclerView(RecyclerView recyclerView)`
`void`	`replaceAll(java.util.List<RenderInfo> renderInfos)` Replaces all items in the `RecyclerBinder` with the provided `RenderInfo`s.
`void`	`resetLayoutInfo(LayoutInfo layoutInfo)` Reset the LayoutInfo for this RecyclerBinder, should only be used in the scenario where you cannot provide the LayoutInfo when RecyclerBinder is created.
`void`	`scrollSmoothToPosition(int position, int offset, SmoothScrollAlignmentType type)`
`void`	`scrollSmoothToPosition(java.lang.Object id, int offset, SmoothScrollAlignmentType type)`
`void`	`scrollToPosition(int position)`
`void`	`scrollToPositionWithOffset(int position, int offset)`
`void`	`scrollToPositionWithOffset(java.lang.Object id, int offset)`
`void`	`setCanMeasure(boolean canMeasure)` Only for horizontally scrolling layouts: set to true if height is not known when measuring the view and the first item will need to be measured to determine the height of the view.
`void`	`setCommitPolicy(int commitPolicy)`
`void`	`setSize(int width, int height)` This should be called when the owner `Component`'s onBoundsDefined is called.
`void`	`setSubAdapterModeRecyclerView(RecyclerView recyclerView)`
`void`	`setViewportChangedListener(ViewportInfo.ViewportChanged viewportChangedListener)` Bind a `ViewportInfo.ViewportChanged` listener to this `Binder`.
`void`	`unbind(RecyclerView view)` Call this method when the view is unbound.
`void`	`unmount(RecyclerView view)` Call from the owning `Component`'s onUnmount.
`void`	`updateItemAt(int position, Component component)` See `updateItemAt(int, Component)`.
`void`	`updateItemAt(int position, RenderInfo renderInfo)` Updates the item at position.
`void`	`updateItemAtAsync(int position, RenderInfo renderInfo)` Update the item at index position.
`void`	`updateRangeAt(int position, java.util.List<RenderInfo> renderInfos)` Updates the range of items starting at position.
`void`	`updateRangeAtAsync(int position, java.util.List<RenderInfo> renderInfos)` Update the items starting from the given index position.
`void`	`updateSubAdapterVisibleRange(int firstVisiblePosition, int lastVisiblePosition)` Updates the visible range when in sub adapter mode.
`void`	`updateSubAdapterWorkingRange(int firstVisibleIndex, int lastVisibleIndex, int firstFullyVisibleIndex, int lastFullyVisibleIndex)` Updates the working range when in sub adapter mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ID_CUSTOM_ATTR_KEY
```
public static final java.lang.String ID_CUSTOM_ATTR_KEY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isWrapContent
```
public boolean isWrapContent()
```
    Description copied from interface: Binder
    
    Return true if wrap content is enabled, false otherwise.
    
    Specified by:
    
    isWrapContent in interface Binder<RecyclerView>
  - canMeasure
```
public boolean canMeasure()
```
    Description copied from interface: Binder
    
    Only for horizontally scrolling layouts: return true if height is not known when measuring the view and the first item will be measured to determine the height.
    
    Specified by:
    
    canMeasure in interface Binder<RecyclerView>
  - setCanMeasure
```
public void setCanMeasure(boolean canMeasure)
```
    Description copied from interface: Binder
    
    Only for horizontally scrolling layouts: set to true if height is not known when measuring the view and the first item will need to be measured to determine the height of the view.
    
    Specified by:
    
    setCanMeasure in interface Binder<RecyclerView>
  - detach
```
public void detach()
```
    Description copied from interface: Binder
    
    Detach items under the hood.
    
    Specified by:
    
    detach in interface Binder<RecyclerView>
  - notifyItemRenderCompleteAt
```
public void notifyItemRenderCompleteAt(int position,
                                       long timestampMillis)
```
  - updateItemAtAsync
```
public final void updateItemAtAsync(int position,
                                    RenderInfo renderInfo)
```
    Update the item at index position. The RecyclerView will only be notified of the item being updated after a layout calculation has been completed for the new Component.
  - updateRangeAtAsync
```
public final void updateRangeAtAsync(int position,
                                     java.util.List<RenderInfo> renderInfos)
```
    Update the items starting from the given index position. The RecyclerView will only be notified of the item being updated after a layout calculation has been completed for the new Component.
  - insertItemAtAsync
```
public final void insertItemAtAsync(int position,
                                    RenderInfo renderInfo)
```
    Inserts an item at position. The RecyclerView will only be notified of the item being inserted after a layout calculation has been completed for the new Component.
  - insertRangeAtAsync
```
public final void insertRangeAtAsync(int position,
                                     java.util.List<RenderInfo> renderInfos)
```
    Inserts the new items starting from position. The RecyclerView will only be notified of the items being inserted after a layout calculation has been completed for the new Components. There is not a guarantee that the RecyclerView will be notified about all the items in the range at the same time.
  - setSubAdapterModeRecyclerView
```
public void setSubAdapterModeRecyclerView(RecyclerView recyclerView)
```
  - removeSubAdapterModeRecyclerView
```
public void removeSubAdapterModeRecyclerView(RecyclerView recyclerView)
```
  - moveItemAsync
```
public final void moveItemAsync(int fromPosition,
                                int toPosition)
```
    Moves an item from fromPosition to toPostion. If there are other pending operations on this binder this will only be executed when all the operations have been completed (to ensure index consistency).
  - removeItemAtAsync
```
public final void removeItemAtAsync(int position)
```
    Removes an item from position. If there are other pending operations on this binder this will only be executed when all the operations have been completed (to ensure index consistency).
  - removeRangeAtAsync
```
public final void removeRangeAtAsync(int position,
                                     int count)
```
    Removes count items starting from position. If there are other pending operations on this binder this will only be executed when all the operations have been completed (to ensure index consistency).
  - clearAsync
```
public final void clearAsync()
```
    Removes all items in this binder async.
  - replaceAll
```
public final void replaceAll(java.util.List<RenderInfo> renderInfos)
```
    Replaces all items in the RecyclerBinder with the provided RenderInfos.
  - appendItem
```
public final void appendItem(Component component)
```
    See appendItem(RenderInfo).
  - appendItem
```
public final void appendItem(RenderInfo renderInfo)
```
    Inserts a new item at tail. The RecyclerView gets notified immediately about the new item being inserted. If the item's position falls within the currently visible range, the layout is immediately computed on the] UiThread. The RenderInfo contains the component that will be inserted in the Binder and extra info like isSticky or spanCount.
  - insertItemAt
```
public final void insertItemAt(int position,
                               Component component)
```
    See insertItemAt(int, RenderInfo).
  - insertItemAt
```
public final void insertItemAt(int position,
                               RenderInfo renderInfo)
```
    Inserts a new item at position. The RecyclerView gets notified immediately about the new item being inserted. If the item's position falls within the currently visible range, the layout is immediately computed on the] UiThread. The RenderInfo contains the component that will be inserted in the Binder and extra info like isSticky or spanCount.
  - insertRangeAt
```
public final void insertRangeAt(int position,
                                java.util.List<RenderInfo> renderInfos)
```
    Inserts the new items starting from position. The RecyclerView gets notified immediately about the new item being inserted. The RenderInfo contains the component that will be inserted in the Binder and extra info like isSticky or spanCount.
  - updateItemAt
```
public final void updateItemAt(int position,
                               Component component)
```
    See updateItemAt(int, Component).
  - updateItemAt
```
public final void updateItemAt(int position,
                               RenderInfo renderInfo)
```
    Updates the item at position. The RecyclerView gets notified immediately about the item being updated. If the item's position falls within the currently visible range, the layout is immediately computed on the UiThread.
  - updateRangeAt
```
public final void updateRangeAt(int position,
                                java.util.List<RenderInfo> renderInfos)
```
    Updates the range of items starting at position. The RecyclerView gets notified immediately about the item being updated.
  - moveItem
```
public final void moveItem(int fromPosition,
                           int toPosition)
```
    Moves an item from fromPosition to toPosition. If the new position of the item is within the currently visible range, a layout is calculated immediately on the UI Thread.
  - removeItemAt
```
public final void removeItemAt(int position)
```
    Removes an item from index position.
  - removeRangeAt
```
public final void removeRangeAt(int position,
                                int count)
```
    Removes count items starting from position.
  - notifyChangeSetCompleteAsync
```
public void notifyChangeSetCompleteAsync(boolean isDataChanged,
                                         ChangeSetCompleteCallback changeSetCompleteCallback)
```
    Called after all the change set operations (inserts, removes, etc.) in a batch have completed. Async variant, may be called off the main thread.
  - notifyChangeSetComplete
```
public void notifyChangeSetComplete(boolean isDataChanged,
                                    ChangeSetCompleteCallback changeSetCompleteCallback)
```
    Called after all the change set operations (inserts, removes, etc.) in a batch have completed.
  - getComponentAt
```
public final ComponentTree getComponentAt(int position)
```
    Returns the ComponentTree for the item at index position. TODO 16212132 remove getComponentAt from binder
    
    Specified by:
    
    getComponentAt in interface Binder<RecyclerView>
  - getComponentForStickyHeaderAt
```
public final ComponentTree getComponentForStickyHeaderAt(int position)
```
    Specified by:
    
    getComponentForStickyHeaderAt in interface HasStickyHeader
    
    Returns:
    
    a component tree for the item at position.
  - getRenderInfoAt
```
public final RenderInfo getRenderInfoAt(int position)
```
    Specified by:
    
    getRenderInfoAt in interface LayoutInfo.RenderInfoCollection
    
    Returns:
    
    the RenderInfo at this position. Since this list is modified on the main thread, this function may only be called from the main thread.
  - getComponentTreeHolderAt
```
public final ComponentTreeHolder getComponentTreeHolderAt(int position)
```
    Returns:
    
    the ComponentTreeHolder at this position. Since this list is modified on the main thread, this function may only be called from the main thread.
  - bind
```
public void bind(RecyclerView view)
```
    Description copied from interface: Binder
    
    Bind this Binder to a View. Remember to call ViewGroup#notifyDataSetChanged() when your Components are ready to be used.
    
    Specified by:
    
    bind in interface Binder<RecyclerView>
  - unbind
```
public void unbind(RecyclerView view)
```
    Description copied from interface: Binder
    
    Call this method when the view is unbound.
    
    Specified by:
    
    unbind in interface Binder<RecyclerView>
    
    Parameters:
    
    view - the view being unbound.
  - measure
```
public void measure(Size outSize,
                    int widthSpec,
                    int heightSpec,
                    EventHandler<ReMeasureEvent> reMeasureEventHandler)
```
    A component mounting a RecyclerView can use this method to determine its size. A Recycler that scrolls horizontally will leave the width unconstrained and will measure its children with a sizeSpec for the height matching the heightSpec passed to this method.
    If padding is defined on the parent component it should be subtracted from the parent size specs before passing them to this method.
    Currently we can't support the equivalent of MATCH_PARENT on the scrollDirection (so for example we don't support MATCH_PARENT on width in an horizontal RecyclerView). This is mainly because we don't have the equivalent of LayoutParams in components. We can extend the api of the binder in the future to provide some more layout hints in order to support this.
    
    Specified by:
    
    measure in interface Binder<RecyclerView>
    
    Parameters:
    
    outSize - will be populated with the measured dimensions for this Binder.
    
    widthSpec - the widthSpec to be used to measure the RecyclerView.
    
    heightSpec - the heightSpec to be used to measure the RecyclerView.
    
    reMeasureEventHandler - the EventHandler to invoke in order to trigger a re-measure.
  - getItemCount
```
public int getItemCount()
```
    Gets the number of items currently in the adapter attached to this binder (i.e. the number of items the underlying RecyclerView knows about).
    
    Specified by:
    
    getItemCount in interface ViewportInfo
    
    Returns:
    
    total number of items in the adapter
  - setSize
```
public void setSize(int width,
                    int height)
```
    This should be called when the owner Component's onBoundsDefined is called. It will inform the binder of the final measured size. The binder might decide to re-compute its children layouts if the measures provided here are not compatible with the ones receive in onMeasure.
    
    Specified by:
    
    setSize in interface Binder<RecyclerView>
    
    Parameters:
    
    width - Usually the view width minus horizontal padding.
    
    height - Usually the view height minus vertical padding.
  - mount
```
public void mount(RecyclerView view)
```
    Call from the owning Component's onMount. This is where the adapter is assigned to the RecyclerView.
    
    Specified by:
    
    mount in interface Binder<RecyclerView>
    
    Parameters:
    
    view - the RecyclerView being mounted.
  - unmount
```
public void unmount(RecyclerView view)
```
    Call from the owning Component's onUnmount. This is where the adapter is removed from the RecyclerView.
    
    Specified by:
    
    unmount in interface Binder<RecyclerView>
    
    Parameters:
    
    view - the RecyclerView being unmounted.
  - scrollToPosition
```
public void scrollToPosition(int position)
```
  - scrollSmoothToPosition
```
public void scrollSmoothToPosition(java.lang.Object id,
                                   int offset,
                                   SmoothScrollAlignmentType type)
```
  - scrollSmoothToPosition
```
public void scrollSmoothToPosition(int position,
                                   int offset,
                                   SmoothScrollAlignmentType type)
```
  - scrollToPositionWithOffset
```
public void scrollToPositionWithOffset(java.lang.Object id,
                                       int offset)
```
  - scrollToPositionWithOffset
```
public void scrollToPositionWithOffset(int position,
                                       int offset)
```
  - findFirstVisibleItemPosition
```
public int findFirstVisibleItemPosition()
```
    Specified by:
    
    findFirstVisibleItemPosition in interface ViewportInfo
    
    Returns:
    
    the adapter position of the first visible view.
  - findFirstFullyVisibleItemPosition
```
public int findFirstFullyVisibleItemPosition()
```
    Specified by:
    
    findFirstFullyVisibleItemPosition in interface ViewportInfo
    
    Returns:
    
    the adapter position of the first fully visible view.
  - findLastVisibleItemPosition
```
public int findLastVisibleItemPosition()
```
    Specified by:
    
    findLastVisibleItemPosition in interface ViewportInfo
    
    Returns:
    
    the adapter position of the last visible view.
  - findLastFullyVisibleItemPosition
```
public int findLastFullyVisibleItemPosition()
```
    Specified by:
    
    findLastFullyVisibleItemPosition in interface ViewportInfo
    
    Returns:
    
    the adapter position of the last fully visible view.
  - isSticky
```
public boolean isSticky(int position)
```
    Specified by:
    
    isSticky in interface HasStickyHeader
    
    Returns:
    
    Whether the item at given position is *sticky*
  - isValidPosition
```
public boolean isValidPosition(int position)
```
    Specified by:
    
    isValidPosition in interface HasStickyHeader
    
    Returns:
    
    Whether the item at given position is *valid*, i.e. whether such position exists.
  - getInternalAdapter
```
public RecyclerView.Adapter getInternalAdapter()
```
    Returns:
    
    the internal RecyclerView.Adapter that is used to communicate to the RecyclerView. This should generally only be useful when operating in sub-adapter mode.
  - setViewportChangedListener
```
public void setViewportChangedListener(ViewportInfo.ViewportChanged viewportChangedListener)
```
    Description copied from interface: Binder
    
    Bind a ViewportInfo.ViewportChanged listener to this Binder. The listener will be notified of Viewport changes.
    
    Specified by:
    
    setViewportChangedListener in interface Binder<RecyclerView>
  - updateSubAdapterVisibleRange
```
public void updateSubAdapterVisibleRange(int firstVisiblePosition,
                                         int lastVisiblePosition)
```
    Updates the visible range when in sub adapter mode. Do not call this otherwise. This method exists because in sub adapter mode, the RecyclerBinder is never mounted to a RecyclerView and needs outside signals from the multiplexing adapter to determine which of its indices are visible.
  - updateSubAdapterWorkingRange
```
public void updateSubAdapterWorkingRange(int firstVisibleIndex,
                                         int lastVisibleIndex,
                                         int firstFullyVisibleIndex,
                                         int lastFullyVisibleIndex)
```
    Updates the working range when in sub adapter mode. Do not call this otherwise. This method exists because in sub adapter mode, the RecyclerBinder is never mounted to a RecyclerView and needs outside signals from the multiplexing adapter to determine which of its indices are visible.
  - setCommitPolicy
```
public void setCommitPolicy(int commitPolicy)
```
  - resetLayoutInfo
```
public void resetLayoutInfo(LayoutInfo layoutInfo)
```
    Reset the LayoutInfo for this RecyclerBinder, should only be used in the scenario where you cannot provide the LayoutInfo when RecyclerBinder is created.
    
    Parameters:
    
    layoutInfo - an implementation of LayoutInfo that will expose information about the LayoutManager this RecyclerBinder will use.

Class RecyclerBinder

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.litho.widget.ViewportInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_CUSTOM_ATTR_KEY

Method Detail

isWrapContent

canMeasure

setCanMeasure

detach

notifyItemRenderCompleteAt

updateItemAtAsync

updateRangeAtAsync

insertItemAtAsync

insertRangeAtAsync

setSubAdapterModeRecyclerView

removeSubAdapterModeRecyclerView

moveItemAsync

removeItemAtAsync

removeRangeAtAsync

clearAsync

replaceAll

appendItem

appendItem

insertItemAt

insertItemAt

insertRangeAt

updateItemAt

updateItemAt

updateRangeAt

moveItem

removeItemAt

removeRangeAt

notifyChangeSetCompleteAsync

notifyChangeSetComplete

getComponentAt

getComponentForStickyHeaderAt

getRenderInfoAt

getComponentTreeHolderAt

bind

unbind

measure

getItemCount

setSize

mount

unmount

scrollToPosition

scrollSmoothToPosition

scrollSmoothToPosition

scrollToPositionWithOffset

scrollToPositionWithOffset

findFirstVisibleItemPosition

findFirstFullyVisibleItemPosition

findLastVisibleItemPosition

findLastFullyVisibleItemPosition

isSticky

isValidPosition

getInternalAdapter

setViewportChangedListener

updateSubAdapterVisibleRange

updateSubAdapterWorkingRange

setCommitPolicy

resetLayoutInfo