ViewPager

Kotlin |Java

open class ViewPager : ViewGroup

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.viewpager.widget.ViewPager

Known Direct Subclasses LeanbackViewPager LeanbackViewPager A viewpager with touch and key event handling disabled by default.

Layout manager that allows the user to flip left and right through pages of data. You supply an implementation of a PagerAdapter to generate the pages that the view shows.

ViewPager is most often used in conjunction with android.app.Fragment, which is a convenient way to supply and manage the lifecycle of each page. There are standard adapters implemented for using fragments with the ViewPager, which cover the most common use cases. These are androidx.fragment.app.FragmentPagerAdapter and androidx.fragment.app.FragmentStatePagerAdapter; each of these classes have simple code showing how to build a full user interface with them.

Views which are annotated with the DecorView annotation are treated as part of the view pagers 'decor'. Each decor view's position can be controlled via its android:layout_gravity attribute. For example:

<androidx.viewpager.widget.ViewPager
      android:layout_width="match_parent"
      android:layout_height="match_parent">
 
      <androidx.viewpager.widget.PagerTitleStrip
          android:layout_width="match_parent"
          android:layout_height="wrap_content"
          android:layout_gravity="top" />
 
  </androidx.viewpager.widget.ViewPager>
  

For more information about how to use ViewPager, read Creating Swipe Views with Tabs.

You can find examples of using ViewPager in the API 4+ Support Demos and API 13+ Support Demos sample code.

Summary

Nested classes
	DecorView Annotation which allows marking of views to be decoration views when added to a view pager.
open	LayoutParams Layout parameters that should be supplied for views added to a ViewPager.
abstract	OnAdapterChangeListener Callback interface for responding to adapter changes.
abstract	OnPageChangeListener Callback interface for responding to changing state of the selected page.
abstract	PageTransformer A PageTransformer is invoked whenever a visible/attached page is scrolled.
open	SavedState This is the persistent state that is saved by ViewPager.
open	SimpleOnPageChangeListener Simple implementation of the OnPageChangeListener interface with stub implementations of each method.

Constants
static Int	SCROLL_STATE_DRAGGING Indicates that the pager is currently being dragged by the user.
static Int	SCROLL_STATE_IDLE Indicates that the pager is in an idle, settled state.
static Int	SCROLL_STATE_SETTLING Indicates that the pager is in the process of settling to a final position.

Public constructors
<init>(@NonNull context: Context)
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?)

Public methods
open Unit	addFocusables(views: ArrayList<View!>!, direction: Int, focusableMode: Int) We only want the current page that is being shown to be focusable.
open Unit	addOnAdapterChangeListener(@NonNull listener: ViewPager.OnAdapterChangeListener) Add a listener that will be invoked whenever the adapter for this ViewPager changes.
open Unit	addOnPageChangeListener(@NonNull listener: ViewPager.OnPageChangeListener) Add a listener that will be invoked whenever the page changes or is incrementally scrolled.
open Unit	addTouchables(views: ArrayList<View!>!) We only want the current page that is being shown to be touchable.
open Unit	addView(child: View!, index: Int, params: LayoutParams!)
open Boolean	arrowScroll(direction: Int) Handle scrolling in response to a left or right arrow click.
open Boolean	beginFakeDrag() Start a fake drag of the pager.
open Boolean	canScrollHorizontally(direction: Int) Check if this ViewPager can be scrolled horizontally in a certain direction.
open Unit	clearOnPageChangeListeners() Remove all listeners that are notified of any changes in scroll state or position.
open Unit	computeScroll()
open Boolean	dispatchKeyEvent(event: KeyEvent!)
open Boolean	dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!)
open Unit	draw(canvas: Canvas!)
open Unit	endFakeDrag() End a fake drag of the pager.
open Boolean	executeKeyEvent(@NonNull event: KeyEvent) You can call this function yourself to have the scroll view perform scrolling from a key event, just as if the event had been dispatched to it by the view hierarchy.
open Unit	fakeDragBy(xOffset: Float) Fake drag by an offset in pixels.
open LayoutParams!	generateLayoutParams(attrs: AttributeSet!)
open PagerAdapter?	getAdapter() Retrieve the current adapter supplying pages.
open Int	getCurrentItem()
open Int	getOffscreenPageLimit() Returns the number of pages that will be retained to either side of the current page in the view hierarchy in an idle state.
open Int	getPageMargin() Return the margin between pages.
open Boolean	isFakeDragging() Returns true if a fake drag is in progress.
open Boolean	onInterceptTouchEvent(ev: MotionEvent!)
open Unit	onRestoreInstanceState(state: Parcelable!)
open Parcelable?	onSaveInstanceState()
open Boolean	onTouchEvent(ev: MotionEvent!)
open Unit	removeOnAdapterChangeListener(@NonNull listener: ViewPager.OnAdapterChangeListener) Remove a listener that was previously added via addOnAdapterChangeListener(OnAdapterChangeListener).
open Unit	removeOnPageChangeListener(@NonNull listener: ViewPager.OnPageChangeListener) Remove a listener that was previously added via addOnPageChangeListener(OnPageChangeListener).
open Unit	removeView(view: View!)
open Unit	setAdapter(@Nullable adapter: PagerAdapter?) Set a PagerAdapter that will supply views for this pager as needed.
open Unit	setCurrentItem(item: Int) Set the currently selected page.
open Unit	setCurrentItem(item: Int, smoothScroll: Boolean) Set the currently selected page.
open Unit	setOffscreenPageLimit(limit: Int) Set the number of pages that should be retained to either side of the current page in the view hierarchy in an idle state.
open Unit	setOnPageChangeListener(listener: ViewPager.OnPageChangeListener!) Set a listener that will be invoked whenever the page changes or is incrementally scrolled.
open Unit	setPageMargin(marginPixels: Int) Set the margin between pages.
open Unit	setPageMarginDrawable(@Nullable d: Drawable?) Set a drawable that will be used to fill the margin between pages.
open Unit	setPageMarginDrawable(@DrawableRes resId: Int) Set a drawable that will be used to fill the margin between pages.
open Unit	setPageTransformer(reverseDrawingOrder: Boolean, @Nullable transformer: ViewPager.PageTransformer?) Sets a PageTransformer that will be called for each attached page whenever the scroll position is changed.
open Unit	setPageTransformer(