StickyHeaderLinearLayoutManager

class StickyHeaderLinearLayoutManager @JvmOverloads() constructor(context: Context, orientation: Int, reverseLayout: Boolean) : LinearLayoutManager

Adds sticky headers capabilities to your RecyclerView.Adapter. The adapter / controller must override StickyHeaderCallbacks.isStickyHeader to indicate which items are sticky.

Example usage:

class StickyHeaderController() : EpoxyController() {
    override fun isStickyHeader(position: Int) {
        // Write your logic to tell which item is sticky.
    }
}

Constructors

StickyHeaderLinearLayoutManager

@JvmOverloads()

fun StickyHeaderLinearLayoutManager(context: Context, orientation: Int = RecyclerView.VERTICAL, reverseLayout: Boolean = false)

Types

SavedState

data class SavedState(superState: Parcelable?, scrollPosition: Int, scrollOffset: Int) : Parcelable

Save / restore existing RecyclerView state and scrolling position and offset.

Functions

addDisappearingView

open fun addDisappearingView(p0: View)

open fun addDisappearingView(p0: View, p1: Int)

addView

open fun addView(p0: View)

open fun addView(p0: View, p1: Int)

assertInLayoutOrScroll

open fun assertInLayoutOrScroll(p0: String)

assertNotInLayoutOrScroll

open override fun assertNotInLayoutOrScroll(p0: String)

attachView

open fun attachView(@NonNull() p0: View)

open fun attachView(@NonNull() p0: View, p1: Int)

open fun attachView(@NonNull() p0: View, p1: Int, p2: RecyclerView.LayoutParams)

calculateExtraLayoutSpace

open fun calculateExtraLayoutSpace(@NonNull() p0: RecyclerView.State, @NonNull() p1: IntArray)

calculateItemDecorationsForChild

open fun calculateItemDecorationsForChild(@NonNull() p0: View, @NonNull() p1: Rect)

canScrollHorizontally

open override fun canScrollHorizontally(): Boolean

canScrollVertically

open override fun canScrollVertically(): Boolean

checkLayoutParams

open fun checkLayoutParams(p0: RecyclerView.LayoutParams): Boolean

collectAdjacentPrefetchPositions

open override fun collectAdjacentPrefetchPositions(p0: Int, p1: Int, p2: RecyclerView.State, p3: RecyclerView.LayoutManager.LayoutPrefetchRegistry)

collectInitialPrefetchPositions

open override fun collectInitialPrefetchPositions(p0: Int, p1: RecyclerView.LayoutManager.LayoutPrefetchRegistry)

collectPrefetchPositionsForLayoutState

open fun collectPrefetchPositionsForLayoutState(p0: RecyclerView.State, p1: LinearLayoutManager.LayoutState, p2: RecyclerView.LayoutManager.LayoutPrefetchRegistry)

computeHorizontalScrollExtent

open override fun computeHorizontalScrollExtent(state: RecyclerView.State): Int

computeHorizontalScrollOffset

open override fun computeHorizontalScrollOffset(state: RecyclerView.State): Int

computeHorizontalScrollRange

open override fun computeHorizontalScrollRange(state: RecyclerView.State): Int

computeScrollVectorForPosition

open override fun computeScrollVectorForPosition(targetPosition: Int): PointF?

computeVerticalScrollExtent

open override fun computeVerticalScrollExtent(state: RecyclerView.State): Int

computeVerticalScrollOffset

open override fun computeVerticalScrollOffset(state: RecyclerView.State): Int

computeVerticalScrollRange

open override fun computeVerticalScrollRange(state: RecyclerView.State): Int

convertFocusDirectionToLayoutDirection

open fun convertFocusDirectionToLayoutDirection(p0: Int): Int

createLayoutState

open fun createLayoutState(): LinearLayoutManager.LayoutState

detachAndScrapAttachedViews

open fun detachAndScrapAttachedViews(@NonNull() p0: RecyclerView.Recycler)

detachAndScrapView

open fun detachAndScrapView(@NonNull() p0: View, @NonNull() p1: RecyclerView.Recycler)

detachAndScrapViewAt

open fun detachAndScrapViewAt(p0: Int, @NonNull() p1: RecyclerView.Recycler)

detachView

open fun detachView(@NonNull() p0: View)

detachViewAt

open fun detachViewAt(p0: Int)

dispatchAttachedToWindow

open fun dispatchAttachedToWindow(p0: RecyclerView)

dispatchDetachedFromWindow

open fun dispatchDetachedFromWindow(p0: RecyclerView, p1: RecyclerView.Recycler)

endAnimation

open fun endAnimation(p0: View)

ensureLayoutState

open fun ensureLayoutState()

fill

open fun fill(p0: RecyclerView.Recycler, p1: LinearLayoutManager.LayoutState, p2: RecyclerView.State, p3: Boolean): Int

findContainingItemView

open fun findContainingItemView(@NonNull() p0: View): View?

findFirstCompletelyVisibleItemPosition

open fun findFirstCompletelyVisibleItemPosition(): Int

findFirstVisibleChildClosestToEnd

open fun findFirstVisibleChildClosestToEnd(p0: Boolean, p1: Boolean): View

findFirstVisibleChildClosestToStart

open fun findFirstVisibleChildClosestToStart(p0: Boolean, p1: Boolean): View

findFirstVisibleItemPosition

open fun findFirstVisibleItemPosition(): Int

findLastCompletelyVisibleItemPosition

open fun findLastCompletelyVisibleItemPosition(): Int

findLastVisibleItemPosition

open fun findLastVisibleItemPosition(): Int

findOnePartiallyOrCompletelyInvisibleChild

open fun findOnePartiallyOrCompletelyInvisibleChild(p0: Int, p1: Int): View

findOneVisibleChild

open fun findOneVisibleChild(p0: Int, p1: Int, p2: Boolean, p3: Boolean): View

findReferenceChild

open fun findReferenceChild(p0: RecyclerView.Recycler, p1: RecyclerView.State, p2: Int, p3: Int, p4: Int): View

findViewByPosition

open override fun findViewByPosition(p0: Int): View?

generateDefaultLayoutParams

open override fun generateDefaultLayoutParams(): RecyclerView.LayoutParams

generateLayoutParams

open fun generateLayoutParams(p0: ViewGroup.LayoutParams): RecyclerView.LayoutParams

open fun generateLayoutParams(p0: Context, p1: AttributeSet): RecyclerView.LayoutParams

getBaseline

open fun getBaseline(): Int

getBottomDecorationHeight

open fun getBottomDecorationHeight(@NonNull() p0: View): Int

getChildAt

open fun getChildAt(p0: Int): View?

getChildCount

open fun getChildCount(): Int

getClipToPadding

open fun getClipToPadding(): Boolean

getColumnCountForAccessibility

open fun getColumnCountForAccessibility(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State): Int

getDecoratedBottom

open fun getDecoratedBottom(@NonNull() p0: View): Int

getDecoratedBoundsWithMargins

open fun getDecoratedBoundsWithMargins(@NonNull() p0: View, @NonNull() p1: Rect)

getDecoratedLeft

open fun getDecoratedLeft(@NonNull() p0: View): Int

getDecoratedMeasuredHeight

open fun getDecoratedMeasuredHeight(@NonNull() p0: View): Int

getDecoratedMeasuredWidth

open fun getDecoratedMeasuredWidth(@NonNull() p0: View): Int

getDecoratedRight

open fun getDecoratedRight(@NonNull() p0: View): Int

getDecoratedTop

open fun getDecoratedTop(@NonNull() p0: View): Int

getExtraLayoutSpace

open fun getExtraLayoutSpace(p0: RecyclerView.State): Int

getFocusedChild

open fun getFocusedChild(): View?

getHeight

@Px()

open fun getHeight(): Int

getHeightMode

open fun getHeightMode(): Int

getInitialPrefetchItemCount

open fun getInitialPrefetchItemCount(): Int

getItemCount

open fun getItemCount(): Int

getItemViewType

open fun getItemViewType(@NonNull() p0: View): Int

getLayoutDirection

open fun getLayoutDirection(): Int

getLeftDecorationWidth

open fun getLeftDecorationWidth(@NonNull() p0: View): Int

getMinimumHeight

@Px()

open fun getMinimumHeight(): Int

getMinimumWidth

@Px()

open fun getMinimumWidth(): Int

getOrientation

open fun getOrientation(): Int

getPaddingBottom

@Px()

open fun getPaddingBottom(): Int

getPaddingEnd

@Px()

open fun getPaddingEnd(): Int

getPaddingLeft

@Px()

open fun getPaddingLeft(): Int

getPaddingRight

@Px()

open fun getPaddingRight(): Int

getPaddingStart

@Px()

open fun getPaddingStart(): Int

getPaddingTop

@Px()

open fun getPaddingTop(): Int

getPosition

open fun getPosition(@NonNull() p0: View): Int

getRecycleChildrenOnDetach

open fun getRecycleChildrenOnDetach(): Boolean

getReverseLayout

open fun getReverseLayout(): Boolean

getRightDecorationWidth

open fun getRightDecorationWidth(@NonNull() p0: View): Int

getRowCountForAccessibility

open fun getRowCountForAccessibility(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State): Int

getSelectionModeForAccessibility

open fun getSelectionModeForAccessibility(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State): Int

getStackFromEnd

open fun getStackFromEnd(): Boolean

getTopDecorationHeight

open fun getTopDecorationHeight(@NonNull() p0: View): Int

getTransformedBoundingBox

open fun getTransformedBoundingBox(@NonNull() p0: View, p1: Boolean, @NonNull() p2: Rect)

getWidth

@Px()

open fun getWidth(): Int

getWidthMode

open fun getWidthMode(): Int

hasFlexibleChildInBothOrientations

open fun hasFlexibleChildInBothOrientations(): Boolean

hasFocus

open fun hasFocus(): Boolean

ignoreView

open fun ignoreView(@NonNull() p0: View)

isAttachedToWindow

open fun isAttachedToWindow(): Boolean

isAutoMeasureEnabled

open override fun isAutoMeasureEnabled(): Boolean

isFocused

open fun isFocused(): Boolean

isItemPrefetchEnabled

fun isItemPrefetchEnabled(): Boolean

isLayoutHierarchical

open fun isLayoutHierarchical(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State): Boolean

isLayoutRTL

open fun isLayoutRTL(): Boolean

isMeasurementCacheEnabled

open fun isMeasurementCacheEnabled(): Boolean

isSmoothScrollbarEnabled

open fun isSmoothScrollbarEnabled(): Boolean

isSmoothScrolling

open fun isSmoothScrolling(): Boolean

isStickyHeader

fun isStickyHeader(view: View): Boolean

Returns true if view is the current sticky header.

isViewPartiallyVisible

open fun isViewPartiallyVisible(@NonNull() p0: View, p1: Boolean, p2: Boolean): Boolean

layoutChunk

open fun layoutChunk(p0: RecyclerView.Recycler, p1: RecyclerView.State, p2: LinearLayoutManager.LayoutState, p3: LinearLayoutManager.LayoutChunkResult)

layoutDecorated

open fun layoutDecorated(@NonNull() p0: View, p1: Int, p2: Int, p3: Int, p4: Int)

layoutDecoratedWithMargins

open fun layoutDecoratedWithMargins(@NonNull() p0: View, p1: Int, p2: Int, p3: Int, p4: Int)

measureChild

open fun measureChild(@NonNull() p0: View, p1: Int, p2: Int)

measureChildWithMargins

open fun measureChildWithMargins(@NonNull() p0: View, p1: Int, p2: Int)

moveView

open fun moveView(p0: Int, p1: Int)

offsetChildrenHorizontal

open fun offsetChildrenHorizontal(@Px() p0: Int)

offsetChildrenVertical

open fun offsetChildrenVertical(@Px() p0: Int)

onAdapterChanged

open override fun onAdapterChanged(oldAdapter: RecyclerView.Adapter<*>?, newAdapter: RecyclerView.Adapter<*>?)

onAddFocusables

open fun onAddFocusables(@NonNull() p0: RecyclerView, @NonNull() p1: ArrayList<View>, p2: Int, p3: Int): Boolean

onAnchorReady

open fun onAnchorReady(p0: RecyclerView.Recycler, p1: RecyclerView.State, p2: LinearLayoutManager.AnchorInfo, p3: Int)

onAttachedToWindow

open override fun onAttachedToWindow(recyclerView: RecyclerView)

onDetachedFromWindow

open fun onDetachedFromWindow(p0: RecyclerView)

open override fun onDetachedFromWindow(p0: RecyclerView, p1: RecyclerView.Recycler)

onFocusSearchFailed

open override fun onFocusSearchFailed(focused: View, focusDirection: Int, recycler: RecyclerView.Recycler, state: RecyclerView.State): View?

onInitializeAccessibilityEvent

open override fun onInitializeAccessibilityEvent(p0: AccessibilityEvent)

open fun onInitializeAccessibilityEvent(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State, @NonNull() p2: AccessibilityEvent)

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(p0: AccessibilityNodeInfoCompat)

open fun onInitializeAccessibilityNodeInfo(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State, @NonNull() p2: AccessibilityNodeInfoCompat)

onInitializeAccessibilityNodeInfoForItem

open fun onInitializeAccessibilityNodeInfoForItem(p0: View, p1: AccessibilityNodeInfoCompat)

open fun onInitializeAccessibilityNodeInfoForItem(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State, @NonNull() p2: View, @NonNull() p3: AccessibilityNodeInfoCompat)

onInterceptFocusSearch

open fun onInterceptFocusSearch(@NonNull() p0: View, p1: Int): View?

onItemsAdded

open fun onItemsAdded(@NonNull() p0: RecyclerView, p1: Int, p2: Int)

onItemsChanged

open fun onItemsChanged(@NonNull() p0: RecyclerView)

onItemsMoved

open fun onItemsMoved(@NonNull() p0: RecyclerView, p1: Int, p2: Int, p3: Int)

onItemsRemoved

open fun onItemsRemoved(@NonNull() p0: RecyclerView, p1: Int, p2: Int)

onItemsUpdated

open fun onItemsUpdated(@NonNull() p0: RecyclerView, p1: Int, p2: Int)

open fun onItemsUpdated(@NonNull() p0: RecyclerView, p1: Int, p2: Int, @Nullable() p3: Any?)

onLayoutChildren

open override fun onLayoutChildren(recycler: RecyclerView.Recycler, state: RecyclerView.State)

onLayoutCompleted

open override fun onLayoutCompleted(p0: RecyclerView.State)

onMeasure

open fun onMeasure(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State, p2: Int, p3: Int)

onRequestChildFocus

open fun onRequestChildFocus(@NonNull() p0: RecyclerView, @NonNull() p1: View, @Nullable() p2: View?): Boolean

open fun onRequestChildFocus(@NonNull() p0: RecyclerView, @NonNull() p1: RecyclerView.State, @NonNull() p2: View, @Nullable() p3: View?): Boolean

onRestoreInstanceState

open override fun onRestoreInstanceState(state: Parcelable?)

onSaveInstanceState

open override fun onSaveInstanceState(): Parcelable

onScrollStateChanged

open fun onScrollStateChanged(p0: Int)

onSmoothScrollerStopped

open fun onSmoothScrollerStopped(p0: RecyclerView.SmoothScroller)

performAccessibilityAction

open fun performAccessibilityAction(p0: Int, @Nullable() p1: Bundle?): Boolean

open fun performAccessibilityAction(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State, p2: Int, @Nullable() p3: Bundle?): Boolean

performAccessibilityActionForItem

open fun performAccessibilityActionForItem(@NonNull() p0: View, p1: Int, @Nullable() p2: Bundle?): Boolean

open fun performAccessibilityActionForItem(@NonNull() p0: RecyclerView.Recycler, @NonNull() p1: RecyclerView.State, @NonNull() p2: View, p3: Int, @Nullable() p4: Bundle?): Boolean

postOnAnimation

open fun postOnAnimation(p0: Runnable)

prepareForDrop

open override fun prepareForDrop(@NonNull() p0: View, @NonNull() p1: View, p2: Int, p3: Int)

removeAllViews

open fun removeAllViews()

removeAndRecycleAllViews

open fun removeAndRecycleAllViews(@NonNull() p0: RecyclerView.Recycler)

removeAndRecycleScrapInt

open fun removeAndRecycleScrapInt(p0: RecyclerView.Recycler)

removeAndRecycleView

open fun removeAndRecycleView(@NonNull() p0: View, @NonNull() p1: RecyclerView.Recycler)

removeAndRecycleViewAt

open fun removeAndRecycleViewAt(p0: Int, @NonNull() p1: RecyclerView.Recycler)

removeCallbacks

open fun removeCallbacks(p0: Runnable): Boolean

removeDetachedView

open fun removeDetachedView(@NonNull() p0: View)

removeView

open fun removeView(p0: View)

removeViewAt

open fun removeViewAt(p0: Int)

requestChildRectangleOnScreen

open fun requestChildRectangleOnScreen(@NonNull() p0: RecyclerView, @NonNull() p1: View, @NonNull() p2: Rect, p3: Boolean): Boolean

open fun requestChildRectangleOnScreen(@NonNull() p0: RecyclerView, @NonNull() p1: View, @NonNull() p2: Rect, p3: Boolean, p4: Boolean): Boolean

requestLayout

open fun requestLayout()

requestSimpleAnimationsInNextLayout

open fun requestSimpleAnimationsInNextLayout()

resolveIsInfinite

open fun resolveIsInfinite(): Boolean

scrollBy

open fun scrollBy(p0: Int, p1: RecyclerView.Recycler, p2: RecyclerView.State): Int

scrollHorizontallyBy

open override fun scrollHorizontallyBy(dx: Int, recycler: RecyclerView.Recycler, state: RecyclerView.State?): Int

scrollToPosition

open override fun scrollToPosition(position: Int)

scrollToPositionWithOffset

open override fun scrollToPositionWithOffset(position: Int, offset: Int)

scrollVerticallyBy

open override fun scrollVerticallyBy(dy: Int, recycler: RecyclerView.Recycler, state: RecyclerView.State?): Int

setAutoMeasureEnabled

open fun setAutoMeasureEnabled(p0: Boolean)

setExactMeasureSpecsFrom

open fun setExactMeasureSpecsFrom(p0: RecyclerView)

setInitialPrefetchItemCount

open fun setInitialPrefetchItemCount(p0: Int)

setItemPrefetchEnabled

fun setItemPrefetchEnabled(p0: Boolean)

setMeasuredDimension

open fun setMeasuredDimension(p0: Int, p1: Int)

open fun setMeasuredDimension(p0: Rect, p1: Int, p2: Int)

setMeasuredDimensionFromChildren

open fun setMeasuredDimensionFromChildren(p0: Int, p1: Int)

setMeasurementCacheEnabled

open fun setMeasurementCacheEnabled(p0: Boolean)

setMeasureSpecs

open fun setMeasureSpecs(p0: Int, p1: Int)

setOrientation

open fun setOrientation(p0: Int)

setRecycleChildrenOnDetach

open fun setRecycleChildrenOnDetach(p0: Boolean)

setRecyclerView

open fun setRecyclerView(p0: RecyclerView)

setReverseLayout

open fun setReverseLayout(p0: Boolean)

setSmoothScrollbarEnabled

open fun setSmoothScrollbarEnabled(p0: Boolean)

setStackFromEnd

open fun setStackFromEnd(p0: Boolean)

setStickyHeaderTranslationX

fun setStickyHeaderTranslationX(translationX: Float)

Offsets the horizontal location of the sticky header relative to the its default position.

setStickyHeaderTranslationY

fun setStickyHeaderTranslationY(translationY: Float)

Offsets the vertical location of the sticky header relative to the its default position.

shouldMeasureChild

open fun shouldMeasureChild(p0: View, p1: Int, p2: Int, p3: RecyclerView.LayoutParams): Boolean

shouldMeasureTwice

open override fun shouldMeasureTwice(): Boolean

shouldReMeasureChild

open fun shouldReMeasureChild(p0: View, p1: Int, p2: Int, p3: RecyclerView.LayoutParams): Boolean

smoothScrollToPosition

open override fun smoothScrollToPosition(p0: RecyclerView, p1: RecyclerView.State, p2: Int)

startSmoothScroll

open fun startSmoothScroll(p0: RecyclerView.SmoothScroller)

stopIgnoringView

open fun stopIgnoringView(@NonNull() p0: View)

stopSmoothScroller

open fun stopSmoothScroller()

supportsPredictiveItemAnimations

open override fun supportsPredictiveItemAnimations(): Boolean

validateChildOrder

open fun validateChildOrder()

Properties

mAnchorInfo

val mAnchorInfo: LinearLayoutManager.AnchorInfo

mAutoMeasure

val mAutoMeasure: Boolean

mChildHelper

val mChildHelper: ChildHelper

mHorizontalBoundCheck

val mHorizontalBoundCheck: ViewBoundsCheck

mIsAttachedToWindow

val mIsAttachedToWindow: Boolean

mOrientation

val mOrientation: Int

mOrientationHelper

val mOrientationHelper: OrientationHelper

mPendingSavedState

val mPendingSavedState: LinearLayoutManager.SavedState

mPendingScrollPosition

val mPendingScrollPosition: Int

mPendingScrollPositionOffset

val mPendingScrollPositionOffset: Int

mPrefetchMaxCountObserved

val mPrefetchMaxCountObserved: Int

mPrefetchMaxObservedInInitialPrefetch

val mPrefetchMaxObservedInInitialPrefetch: Boolean

mRecyclerView

val mRecyclerView: RecyclerView

mRequestedSimpleAnimations

val mRequestedSimpleAnimations: Boolean

mShouldReverseLayout

val mShouldReverseLayout: Boolean

mSmoothScroller

val mSmoothScroller: RecyclerView.SmoothScroller?

mVerticalBoundCheck

val mVerticalBoundCheck: ViewBoundsCheck