OnPageChangeCallback

abstract class OnPageChangeCallback
kotlin.Any
   ↳ androidx.viewpager2.widget.ViewPager2.OnPageChangeCallback

Callback interface for responding to changing state of the selected page.

Summary

Public constructors

Callback interface for responding to changing state of the selected page.

Public methods

open Unit

Called when the scroll state changes.

open Unit
onPageScrolled(position: Int, positionOffset: Float, @Px positionOffsetPixels: Int)

This method will be invoked when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll.

open Unit
onPageSelected(position: Int)

This method will be invoked when a new page becomes selected.

Public constructors

<init>

OnPageChangeCallback()

Callback interface for responding to changing state of the selected page.

Public methods

onPageScrollStateChanged

open fun onPageScrollStateChanged(state: Int): Unit

Called when the scroll state changes. Useful for discovering when the user begins dragging, when a fake drag is started, when the pager is automatically settling to the current page, or when it is fully stopped/idle. state can be one of , SCROLL_STATE_DRAGGING or SCROLL_STATE_SETTLING.

onPageScrolled

open fun onPageScrolled(position: Int, positionOffset: Float, @Px positionOffsetPixels: Int): Unit

This method will be invoked when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll.

Parameters
position Int: Position index of the first page currently being displayed. Page position+1 will be visible if positionOffset is nonzero.
positionOffset Int: Value from [0, 1) indicating the offset from the page at position.
positionOffsetPixels Int: Value in pixels indicating the offset from position.

onPageSelected

open fun onPageSelected(position: Int): Unit

This method will be invoked when a new page becomes selected. Animation is not necessarily complete.

Parameters
position Int: Position index of the new selected page.