ViewPager.OnPageChangeListener

interface ViewPager.OnPageChangeListener

Known direct subclasses
ViewPager.SimpleOnPageChangeListener

Simple implementation of the OnPageChangeListener interface with stub implementations of each method.

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

Summary

Public functions
Unit

Called when the scroll state changes.
Unit
onPageScrolled(
    position: Int,
    positionOffset: Float,
    positionOffsetPixels: @Px 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.
Unit
onPageSelected(position: Int)

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

Public functions

onPageScrollStateChanged

Added in 1.1.0-rc01
fun onPageScrollStateChanged(state: Int): Unit

Called when the scroll state changes. Useful for discovering when the user begins dragging, when the pager is automatically settling to the current page, or when it is fully stopped/idle.

Parameters
state: Int

The new scroll state.
See also
SCROLL_STATE_IDLE
SCROLL_STATE_DRAGGING
SCROLL_STATE_SETTLING

onPageScrolled

Added in 1.1.0-rc01
fun onPageScrolled(
    position: Int,
    positionOffset: Float,
    positionOffsetPixels: @Px 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: Float

Value from [0, 1) indicating the offset from the page at position.
positionOffsetPixels: @Px Int

Value in pixels indicating the offset from position.

onPageSelected

Added in 1.1.0-rc01
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.