Android APIs
public class

LinearLayoutManager

extends RecyclerView.LayoutManager
java.lang.Object
   ↳ android.support.v7.widget.RecyclerView.LayoutManager
     ↳ android.support.v7.widget.LinearLayoutManager
Known Direct Subclasses

Class Overview

A RecyclerView.LayoutManager implementation which provides similar functionality to ListView.

Summary

Nested Classes
class LinearLayoutManager.LayoutChunkResult  
Constants
int HORIZONTAL
int INVALID_OFFSET
int VERTICAL
Public Constructors
LinearLayoutManager(Context context)
Creates a vertical LinearLayoutManager
LinearLayoutManager(Context context, int orientation, boolean reverseLayout)
Public Methods
void assertNotInLayoutOrScroll(String message)
Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is.
boolean canScrollHorizontally()
Query if horizontal scrolling is currently supported.
boolean canScrollVertically()
Query if vertical scrolling is currently supported.
int computeHorizontalScrollExtent(RecyclerView.State state)

Override this method if you want to support scroll bars.

int computeHorizontalScrollOffset(RecyclerView.State state)

Override this method if you want to support scroll bars.

int computeHorizontalScrollRange(RecyclerView.State state)

Override this method if you want to support scroll bars.

PointF computeScrollVectorForPosition(int targetPosition)
int computeVerticalScrollExtent(RecyclerView.State state)

Override this method if you want to support scroll bars.

int computeVerticalScrollOffset(RecyclerView.State state)

Override this method if you want to support scroll bars.

int computeVerticalScrollRange(RecyclerView.State state)

Override this method if you want to support scroll bars.

int findFirstCompletelyVisibleItemPosition()
Returns the adapter position of the first fully visible view.
int findFirstVisibleItemPosition()
Returns the adapter position of the first visible view.
int findLastCompletelyVisibleItemPosition()
Returns the adapter position of the last fully visible view.
int findLastVisibleItemPosition()
Returns the adapter position of the last visible view.
View findViewByPosition(int position)
Finds the view which represents the given adapter position.
RecyclerView.LayoutParams generateDefaultLayoutParams()
Create a default LayoutParams object for a child of the RecyclerView.
int getOrientation()
Returns the current orientaion of the layout.
boolean getRecycleChildrenOnDetach()
Returns whether LayoutManager will recycle its children when it is detached from RecyclerView.
boolean getReverseLayout()
Returns if views are laid out from the opposite direction of the layout.
boolean getStackFromEnd()
boolean isSmoothScrollbarEnabled()
Returns the current state of the smooth scrollbar feature.
void onDetachedFromWindow(RecyclerView view, RecyclerView.Recycler recycler)
Called when this LayoutManager is detached from its parent RecyclerView or when its parent RecyclerView is detached from its window.
View onFocusSearchFailed(View focused, int focusDirection, RecyclerView.Recycler recycler, RecyclerView.State state)
Called when searching for a focusable view in the given direction has failed for the current content of the RecyclerView.
void onInitializeAccessibilityEvent(AccessibilityEvent event)
void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state)
Lay out all relevant child views from the given adapter.
void onRestoreInstanceState(Parcelable state)
Parcelable onSaveInstanceState()

Called when the LayoutManager should save its state.

int scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler, RecyclerView.State state)
Scroll horizontally by dx pixels in screen coordinates and return the distance traveled.
void scrollToPosition(int position)

Scroll the RecyclerView to make the position visible.

void scrollToPositionWithOffset(int position, int offset)
Scroll to the specified adapter position with the given offset from resolved layout start.
int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state)
Scroll vertically by dy pixels in screen coordinates and return the distance traveled.
void setOrientation(int orientation)
Sets the orientation of the layout.
void setRecycleChildrenOnDetach(boolean recycleChildrenOnDetach)
Set whether LayoutManager will recycle its children when it is detached from RecyclerView.
void setReverseLayout(boolean reverseLayout)
Used to reverse item traversal and layout order.
void setSmoothScrollbarEnabled(boolean enabled)
When smooth scrollbar is enabled, the position and size of the scrollbar thumb is computed based on the number of visible pixels in the visible items.
void setStackFromEnd(boolean stackFromEnd)
Compatibility support for setStackFromBottom(boolean)
void smoothScrollToPosition(RecyclerView recyclerView, RecyclerView.State state, int position)

Smooth scroll to the specified adapter position.

boolean supportsPredictiveItemAnimations()
Returns whether this LayoutManager supports automatic item animations.
Protected Methods
int getExtraLayoutSpace(RecyclerView.State state)

Returns the amount of extra space that should be laid out by LayoutManager.

boolean isLayoutRTL()
[Expand]
Inherited Methods
From class android.support.v7.widget.RecyclerView.LayoutManager
From class java.lang.Object

Constants

public static final int HORIZONTAL

Constant Value: 0 (0x00000000)

public static final int INVALID_OFFSET

Constant Value: -2147483648 (0x80000000)

public static final int VERTICAL

Constant Value: 1 (0x00000001)

Public Constructors

public LinearLayoutManager (Context context)

Creates a vertical LinearLayoutManager

Parameters
context Current context, will be used to access resources.

public LinearLayoutManager (Context context, int orientation, boolean reverseLayout)

Parameters
context Current context, will be used to access resources.
orientation Layout orientation. Should be HORIZONTAL or VERTICAL.
reverseLayout When set to true, layouts from end to start.

Public Methods

public void assertNotInLayoutOrScroll (String message)

Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is.

Parameters
message The message for the exception. Can be null.

public boolean canScrollHorizontally ()

Query if horizontal scrolling is currently supported. The default implementation returns false.

Returns

public boolean canScrollVertically ()

Query if vertical scrolling is currently supported. The default implementation returns false.

Returns

public int computeHorizontalScrollExtent (RecyclerView.State state)

Override this method if you want to support scroll bars.

Read computeHorizontalScrollExtent() for details.

Default implementation returns 0.

Parameters
state Current state of RecyclerView
Returns
  • The horizontal extent of the scrollbar's thumb

public int computeHorizontalScrollOffset (RecyclerView.State state)

Override this method if you want to support scroll bars.

Read computeHorizontalScrollOffset() for details.

Default implementation returns 0.

Parameters
state Current State of RecyclerView where you can find total item count
Returns
  • The horizontal offset of the scrollbar's thumb

public int computeHorizontalScrollRange (RecyclerView.State state)

Override this method if you want to support scroll bars.

Read computeHorizontalScrollRange() for details.

Default implementation returns 0.

Parameters
state Current State of RecyclerView where you can find total item count
Returns
  • The total horizontal range represented by the vertical scrollbar

public PointF computeScrollVectorForPosition (int targetPosition)

public int computeVerticalScrollExtent (RecyclerView.State state)

Override this method if you want to support scroll bars.

Read computeVerticalScrollExtent() for details.

Default implementation returns 0.

Parameters
state Current state of RecyclerView
Returns
  • The vertical extent of the scrollbar's thumb

public int computeVerticalScrollOffset (RecyclerView.State state)

Override this method if you want to support scroll bars.

Read computeVerticalScrollOffset() for details.

Default implementation returns 0.

Parameters
state Current State of RecyclerView where you can find total item count
Returns
  • The vertical offset of the scrollbar's thumb

public int computeVerticalScrollRange (RecyclerView.State state)

Override this method if you want to support scroll bars.

Read computeVerticalScrollRange() for details.

Default implementation returns 0.

Parameters
state Current State of RecyclerView where you can find total item count
Returns
  • The total vertical range represented by the vertical scrollbar

public int findFirstCompletelyVisibleItemPosition ()

Returns the adapter position of the first fully visible view. This position does not include adapter changes that were dispatched after the last layout pass.

Note that bounds check is only performed in the current orientation. That means, if LayoutManager is horizontal, it will only check the view's left and right edges.

Returns
  • The adapter position of the first fully visible item or NO_POSITION if there aren't any visible items.

public int findFirstVisibleItemPosition ()

Returns the adapter position of the first visible view. This position does not include adapter changes that were dispatched after the last layout pass.

Note that, this value is not affected by layout orientation or item order traversal. (setReverseLayout(boolean)). Views are sorted by their positions in the adapter, not in the layout.

If RecyclerView has item decorators, they will be considered in calculations as well.

LayoutManager may pre-cache some views that are not necessarily visible. Those views are ignored in this method.

Returns
  • The adapter position of the first visible item or NO_POSITION if there aren't any visible items.

public int findLastCompletelyVisibleItemPosition ()

Returns the adapter position of the last fully visible view. This position does not include adapter changes that were dispatched after the last layout pass.

Note that bounds check is only performed in the current orientation. That means, if LayoutManager is horizontal, it will only check the view's left and right edges.

Returns
  • The adapter position of the last fully visible view or NO_POSITION if there aren't any visible items.

public int findLastVisibleItemPosition ()

Returns the adapter position of the last visible view. This position does not include adapter changes that were dispatched after the last layout pass.

Note that, this value is not affected by layout orientation or item order traversal. (setReverseLayout(boolean)). Views are sorted by their positions in the adapter, not in the layout.

If RecyclerView has item decorators, they will be considered in calculations as well.

LayoutManager may pre-cache some views that are not necessarily visible. Those views are ignored in this method.

Returns
  • The adapter position of the last visible view or NO_POSITION if there aren't any visible items.

public View findViewByPosition (int position)

Finds the view which represents the given adapter position.

This method traverses each child since it has no information about child order. Override this method to improve performance if your LayoutManager keeps data about child views.

If a view is ignored via ignoreView(View), it is also ignored by this method.

Parameters
position Position of the item in adapter
Returns
  • The child view that represents the given position or null if the position is not laid out

public RecyclerView.LayoutParams generateDefaultLayoutParams ()

Create a default LayoutParams object for a child of the RecyclerView.

LayoutManagers will often want to use a custom LayoutParams type to store extra information specific to the layout. Client code should subclass RecyclerView.LayoutParams for this purpose.

Important: if you use your own custom LayoutParams type you must also override checkLayoutParams(LayoutParams), generateLayoutParams(android.view.ViewGroup.LayoutParams) and generateLayoutParams(android.content.Context, android.util.AttributeSet).

Returns
  • A new LayoutParams for a child view

public int getOrientation ()

Returns the current orientaion of the layout.

Returns
  • Current orientation.

public boolean getRecycleChildrenOnDetach ()

Returns whether LayoutManager will recycle its children when it is detached from RecyclerView.

Returns
  • true if LayoutManager will recycle its children when it is detached from RecyclerView.

public boolean getReverseLayout ()

Returns if views are laid out from the opposite direction of the layout.

Returns
  • If layout is reversed or not.

public boolean getStackFromEnd ()

public boolean isSmoothScrollbarEnabled ()

Returns the current state of the smooth scrollbar feature. It is enabled by default.

Returns
  • True if smooth scrollbar is enabled, false otherwise.

public void onDetachedFromWindow (RecyclerView view, RecyclerView.Recycler recycler)

Called when this LayoutManager is detached from its parent RecyclerView or when its parent RecyclerView is detached from its window.

Subclass implementations should always call through to the superclass implementation.

Parameters
view The RecyclerView this LayoutManager is bound to
recycler The recycler to use if you prefer to recycle your children instead of keeping them around.

public View onFocusSearchFailed (View focused, int focusDirection, RecyclerView.Recycler recycler, RecyclerView.State state)

Called when searching for a focusable view in the given direction has failed for the current content of the RecyclerView.

This is the LayoutManager's opportunity to populate views in the given direction to fulfill the request if it can. The LayoutManager should attach and return the view to be focused. The default implementation returns null.

Parameters
focused The currently focused view
focusDirection One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_BACKWARD, FOCUS_FORWARD or 0 for not applicable
recycler The recycler to use for obtaining views for currently offscreen items
state Transient state of RecyclerView
Returns
  • The chosen view to be focused

public void onInitializeAccessibilityEvent (AccessibilityEvent event)

public void onLayoutChildren (RecyclerView.Recycler recycler, RecyclerView.State state)

Lay out all relevant child views from the given adapter. The LayoutManager is in charge of the behavior of item animations. By default, RecyclerView has a non-null ItemAnimator, and simple item animations are enabled. This means that add/remove operations on the adapter will result in animations to add new or appearing items, removed or disappearing items, and moved items. If a LayoutManager returns false from supportsPredictiveItemAnimations(), which is the default, and runs a normal layout operation during onLayoutChildren(Recycler, State), the RecyclerView will have enough information to run those animations in a simple way. For example, the default ItemAnimator, DefaultItemAnimator, will simple fade views in and out, whether they are actuall added/removed or whether they are moved on or off the screen due to other add/remove operations.

A LayoutManager wanting a better item animation experience, where items can be animated onto and off of the screen according to where the items exist when they are not on screen, then the LayoutManager should return true from supportsPredictiveItemAnimations() and add additional logic to onLayoutChildren(Recycler, State). Supporting predictive animations means that onLayoutChildren(Recycler, State) will be called twice; once as a "pre" layout step to determine where items would have been prior to a real layout, and again to do the "real" layout. In the pre-layout phase, items will remember their pre-layout positions to allow them to be laid out appropriately. Also, removed items will be returned from the scrap to help determine correct placement of other items. These removed items should not be added to the child list, but should be used to help calculate correct positioning of other views, including views that were not previously onscreen (referred to as APPEARING views), but whose pre-layout offscreen position can be determined given the extra information about the pre-layout removed views.

The second layout pass is the real layout in which only non-removed views will be used. The only additional requirement during this pass is, if supportsPredictiveItemAnimations() returns true, to note which views exist in the child list prior to layout and which are not there after layout (referred to as DISAPPEARING views), and to position/layout those views appropriately, without regard to the actual bounds of the RecyclerView. This allows the animation system to know the location to which to animate these disappearing views.

The default LayoutManager implementations for RecyclerView handle all of these requirements for animations already. Clients of RecyclerView can either use one of these layout managers directly or look at their implementations of onLayoutChildren() to see how they account for the APPEARING and DISAPPEARING views.

Parameters
recycler Recycler to use for fetching potentially cached views for a position
state Transient state of RecyclerView

public void onRestoreInstanceState (Parcelable state)

public Parcelable onSaveInstanceState ()

Called when the LayoutManager should save its state. This is a good time to save your scroll position, configuration and anything else that may be required to restore the same layout state if the LayoutManager is recreated.

RecyclerView does NOT verify if the LayoutManager has changed between state save and restore. This will let you share information between your LayoutManagers but it is also your responsibility to make sure they use the same parcelable class.

Returns
  • Necessary information for LayoutManager to be able to restore its state

public int scrollHorizontallyBy (int dx, RecyclerView.Recycler recycler, RecyclerView.State state)

Scroll horizontally by dx pixels in screen coordinates and return the distance traveled. The default implementation does nothing and returns 0.

Parameters
dx distance to scroll by in pixels. X increases as scroll position approaches the right.
recycler Recycler to use for fetching potentially cached views for a position
state Transient state of RecyclerView
Returns
  • The actual distance scrolled. The return value will be negative if dx was negative and scrolling proceeeded in that direction. Math.abs(result) may be less than dx if a boundary was reached.

public void scrollToPosition (int position)

Scroll the RecyclerView to make the position visible.

RecyclerView will scroll the minimum amount that is necessary to make the target position visible. If you are looking for a similar behavior to setSelection(int) or setSelectionFromTop(int, int), use scrollToPositionWithOffset(int, int).

Note that scroll position change will not be reflected until the next layout call.

Parameters
position Scroll to this adapter position

public void scrollToPositionWithOffset (int position, int offset)

Scroll to the specified adapter position with the given offset from resolved layout start. Resolved layout start depends on getReverseLayout(), getLayoutDirection(android.view.View) and getStackFromEnd().

For example, if layout is VERTICAL and getStackFromEnd() is true, calling scrollToPositionWithOffset(10, 20) will layout such that item[10]'s bottom is 20 pixels above the RecyclerView's bottom.

Note that scroll position change will not be reflected until the next layout call.

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

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.

public int scrollVerticallyBy (int dy, RecyclerView.Recycler recycler, RecyclerView.State state)

Scroll vertically by dy pixels in screen coordinates and return the distance traveled. The default implementation does nothing and returns 0.

Parameters
dy distance to scroll in pixels. Y increases as scroll position approaches the bottom.
recycler Recycler to use for fetching potentially cached views for a position
state Transient state of RecyclerView
Returns
  • The actual distance scrolled. The return value will be negative if dy was negative and scrolling proceeeded in that direction. Math.abs(result) may be less than dy if a boundary was reached.

public void setOrientation (int orientation)

Sets the orientation of the layout. LinearLayoutManager will do its best to keep scroll position.

Parameters
orientation HORIZONTAL or VERTICAL

public void setRecycleChildrenOnDetach (boolean recycleChildrenOnDetach)

Set whether LayoutManager will recycle its children when it is detached from RecyclerView.

If you are using a RecyclerView.RecycledViewPool, it might be a good idea to set this flag to true so that views will be avilable to other RecyclerViews immediately.

Note that, setting this flag will result in a performance drop if RecyclerView is restored.

Parameters
recycleChildrenOnDetach Whether children should be recycled in detach or not.

public void setReverseLayout (boolean reverseLayout)

Used to reverse item traversal and layout order. This behaves similar to the layout change for RTL views. When set to true, first item is laid out at the end of the UI, second item is laid out before it etc. For horizontal layouts, it depends on the layout direction. When set to true, If RecyclerView is LTR, than it will layout from RTL, if RecyclerView} is RTL, it will layout from LTR. If you are looking for the exact same behavior of setStackFromBottom(boolean), use setStackFromEnd(boolean)

public void setSmoothScrollbarEnabled (boolean enabled)

When smooth scrollbar is enabled, the position and size of the scrollbar thumb is computed based on the number of visible pixels in the visible items. This however assumes that all list items have similar or equal widths or heights (depending on list orientation). If you use a list in which items have different dimensions, the scrollbar will change appearance as the user scrolls through the list. To avoid this issue, you need to disable this property. When smooth scrollbar is disabled, the position and size of the scrollbar thumb is based solely on the number of items in the adapter and the position of the visible items inside the adapter. This provides a stable scrollbar as the user navigates through a list of items with varying widths / heights.

Parameters
enabled Whether or not to enable smooth scrollbar.

public void setStackFromEnd (boolean stackFromEnd)

Compatibility support for setStackFromBottom(boolean)

public void smoothScrollToPosition (RecyclerView recyclerView, RecyclerView.State state, int position)

Smooth scroll to the specified adapter position.

To support smooth scrolling, override this method, create your RecyclerView.SmoothScroller instance and call startSmoothScroll(SmoothScroller).

Parameters
recyclerView The RecyclerView to which this layout manager is attached
state Current State of RecyclerView
position Scroll to this adapter position.

public boolean supportsPredictiveItemAnimations ()

Returns whether this LayoutManager supports automatic item animations. A LayoutManager wishing to support item animations should obey certain rules as outlined in onLayoutChildren(Recycler, State). The default return value is false, so subclasses of LayoutManager will not get predictive item animations by default.

Whether item animations are enabled in a RecyclerView is determined both by the return value from this method and the ItemAnimator set on the RecyclerView itself. If the RecyclerView has a non-null ItemAnimator but this method returns false, then simple item animations will be enabled, in which views that are moving onto or off of the screen are simply faded in/out. If the RecyclerView has a non-null ItemAnimator and this method returns true, then there will be two calls to onLayoutChildren(Recycler, State) to setup up the information needed to more intelligently predict where appearing and disappearing views should be animated from/to.

Returns
  • true if predictive item animations should be enabled, false otherwise

Protected Methods

protected int getExtraLayoutSpace (RecyclerView.State state)

Returns the amount of extra space that should be laid out by LayoutManager. By default, LinearLayoutManager lays out 1 extra page of items while smooth scrolling and 0 otherwise. You can override this method to implement your custom layout pre-cache logic.

Laying out invisible elements will eventually come with performance cost. On the other hand, in places like smooth scrolling to an unknown location, this extra content helps LayoutManager to calculate a much smoother scrolling; which improves user experience.

You can also use this if you are trying to pre-layout your upcoming views.

Returns
  • The extra space that should be laid out (in pixels).

protected boolean isLayoutRTL ()