ViewPager2

Kotlin |Java

class ViewPager2 : ViewGroup

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.viewpager2.widget.ViewPager2

ViewPager2 replaces androidx.viewpager.widget.ViewPager, addressing most of its predecessor’s pain-points, including right-to-left layout support, vertical orientation, modifiable Fragment collections, etc.

Summary

Nested classes
abstract	`OnPageChangeCallback` Callback interface for responding to changing state of the selected page.
abstract	`PageTransformer` A PageTransformer is invoked whenever a visible/attached page is scrolled.

Constants
static Int	`OFFSCREEN_PAGE_LIMIT_DEFAULT` Value to indicate that the default caching mechanism of RecyclerView should be used instead of explicitly prefetch and retain pages to either side of the current page.
static Int	`ORIENTATION_HORIZONTAL`
static Int	`ORIENTATION_VERTICAL`
static Int	`SCROLL_STATE_DRAGGING` Indicates that the ViewPager2 is currently being dragged by the user, or programmatically via fake drag functionality.
static Int	`SCROLL_STATE_IDLE` Indicates that the ViewPager2 is in an idle, settled state.
static Int	`SCROLL_STATE_SETTLING` Indicates that the ViewPager2 is in the process of settling to a final position.

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

Public methods
Unit	`addItemDecoration(@NonNull decor: RecyclerView.ItemDecoration)` Add an `ItemDecoration` to this ViewPager2.
Unit	`addItemDecoration(@NonNull decor: RecyclerView.ItemDecoration, index: Int)` Add an `ItemDecoration` to this ViewPager2.
Boolean	`beginFakeDrag()` Start a fake drag of the pager.
Boolean	`canScrollHorizontally(direction: Int)`
Boolean	`canScrollVertically(direction: Int)`
Boolean	`endFakeDrag()` End a fake drag of the pager.
Boolean	`fakeDragBy(@Px offsetPxFloat: Float)` Fake drag by an offset in pixels.
CharSequence!	`getAccessibilityClassName()`
RecyclerView.Adapter<RecyclerView.ViewHolder!>?	`getAdapter()`
Int	`getCurrentItem()` Returns the currently selected page.
RecyclerView.ItemDecoration	`getItemDecorationAt(index: Int)` Returns an `ItemDecoration` previously added to this ViewPager2.
Int	`getItemDecorationCount()` Returns the number of `ItemDecoration` currently added to this ViewPager2.
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.
Int	`getOrientation()`
Int	`getScrollState()` Returns the current scroll state of the ViewPager2.
Unit	`invalidateItemDecorations()` Invalidates all ItemDecorations.
Boolean	`isFakeDragging()` Returns `true` if a fake drag is in progress.
Boolean	`isUserInputEnabled()` Returns if user initiated scrolling between pages is enabled.
Unit	`onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo!)`
Unit	`onViewAdded(child: View!)`