ViewPager2

Artifact: androidx.viewpager2:viewpager2

View Source

Added in 1.0.0

---

Kotlin |Java

public final class ViewPager2 extends ViewGroup

java.lang.Object
↳	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.

A note on WindowInsets: due to a bug in API 29 and before, WindowInsets were incorrectly dispatched to a View's children and siblings. ViewPager2 offers a fix to make sure that all pages receive the correct insets, but it comes at the cost of not dispatching insets to any siblings of ViewPager2 or siblings of its ancestors that haven't received the insets yet. If you want to handle insets on each page separately (instead of on ViewPager2 or one of its parents), you should install a WindowInsetsApplier by calling WindowInsetsApplier.install(viewPager2). If you don't handle insets on any of the pages, we recommend you don't use the WindowInsetsApplier.

See also
ViewPager

Summary

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

Constants
static final int	OFFSCREEN_PAGE_LIMIT_DEFAULT = -1 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 final int	ORIENTATION_HORIZONTAL = 0
static final int	ORIENTATION_VERTICAL = 1
static final int	SCROLL_STATE_DRAGGING = 1 Indicates that the ViewPager2 is currently being dragged by the user, or programmatically via fake drag functionality.
static final int	SCROLL_STATE_IDLE = 0 Indicates that the ViewPager2 is in an idle, settled state.
static final int	SCROLL_STATE_SETTLING = 2 Indicates that the ViewPager2 is in the process of settling to a final position.

Public constructors
ViewPager2(@NonNull Context context)
ViewPager2(@NonNull Context context, @Nullable AttributeSet attrs)
ViewPager2(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyleAttr )
@RequiresApi(value = 21) ViewPager2(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyleAttr,     int defStyleRes )

Public methods
void	addItemDecoration(@NonNull RecyclerView.ItemDecoration decor) Add an ItemDecoration to this ViewPager2.
void	addItemDecoration(@NonNull RecyclerView.ItemDecoration decor, int index) Add an ItemDecoration to this ViewPager2.
boolean	beginFakeDrag() Start a fake drag of the pager.
boolean	canScrollHorizontally(int direction)
boolean	canScrollVertically(int direction)
boolean	endFakeDrag() End a fake drag of the pager.
boolean	fakeDragBy(@Px float offsetPxFloat) Fake drag by an offset in pixels.
CharSequence	@RequiresApi(value = 23) getAccessibilityClassName()
@Nullable RecyclerView.Adapter	getAdapter()
int	getCurrentItem() Returns the currently selected page.
@NonNull RecyclerView.ItemDecoration	getItemDecorationAt(int index) 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.
void	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.
void	onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)
void	onViewAdded(View child)
boolean	performAccessibilityAction(int action, @Nullable Bundle arguments)
void	registerOnPageChangeCallback(     @NonNull ViewPager2.OnPageChangeCallback callback ) Add a callback that will be invoked whenever the page changes or is incrementally scrolled.
void	removeItemDecoration(@NonNull RecyclerView.ItemDecoration decor) Remove an ItemDecoration from this ViewPager2.
void	removeItemDecorationAt(int index) Removes the ItemDecoration associated with the supplied index position.
void	requestTransform() Trigger a call to the registered PageTransformer's transformPage method.
void	setAdapter(@Nullable RecyclerView.Adapter adapter) Set a new adapter to provide page views on demand.
void	setCurrentItem(int item) Set the currently selected page.
void	setCurrentItem(int item, boolean smoothScroll) Set the currently selected page.
void	setLayoutDirection(int layoutDirection)
void	setOffscreenPageLimit(int limit) Set the number of pages that should be retained to either side of the currently visible page(s).
void	setOrientation(int orientation) Sets the orientation of the ViewPager2.
void	setPageTransformer(@Nullable ViewPager2.PageTransformer transformer) Sets a PageTransformer that will be called for each attached page whenever the scroll position is changed.
void	setUserInputEnabled(boolean enabled) Enable or disable user initiated scrolling.
void	unregisterOnPageChangeCallback(     @NonNull ViewPager2.OnPageChangeCallback callback ) Remove a callback that was previously added via registerOnPageChangeCallback.

Protected methods
void	dispatchRestoreInstanceState(SparseArray<Parcelable> container)
void	onLayout(boolean changed, int l, int t, int r, int b)
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void	onRestoreInstanceState(Parcelable state)
@Nullable Parcelable	onSaveInstanceState()

Inherited Constants
From android.view.View static final int ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0 static final int ACCESSIBILITY_DATA_SENSITIVE_NO = 2 static final int ACCESSIBILITY_DATA_SENSITIVE_YES = 1 static final int ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2 static final int ACCESSIBILITY_LIVE_REGION_NONE = 0 static final int ACCESSIBILITY_LIVE_REGION_POLITE = 1 static final Property<View, Float> ALPHA static final int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1 static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear" static final String AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber" static final String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode" static final String AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress" static final String AUTOFILL_HINT_NAME = "name" static final String AUTOFILL_HINT_PASSWORD = "password" static final String AUTOFILL_HINT_PHONE = "phone" static final String AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress" static final String AUTOFILL_HINT_POSTAL_CODE = "postalCode" static final String AUTOFILL_HINT_USERNAME = "username" static final int AUTOFILL_TYPE_DATE = 4 static final int AUTOFILL_TYPE_LIST = 3 static final int AUTOFILL_TYPE_NONE = 0 static final int AUTOFILL_TYPE_TEXT = 1 static final int AUTOFILL_TYPE_TOGGLE = 2 static final int DRAG_FLAG_ACCESSIBILITY_ACTION = 1024 static final int DRAG_FLAG_GLOBAL = 256 static final int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64 static final int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128 static final int DRAG_FLAG_GLOBAL_URI_READ = 1 static final int DRAG_FLAG_GLOBAL_URI_WRITE = 2 static final int DRAG_FLAG_OPAQUE = 512 static final int DRAWING_CACHE_QUALITY_AUTO = 0 This field is deprecated. static final int DRAWING_CACHE_QUALITY_HIGH = 1048576 This field is deprecated. static final int DRAWING_CACHE_QUALITY_LOW = 524288 This field is deprecated. static final int[] EMPTY_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_SELECTED_STATE_SET static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_STATE_SET static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2 static final int FIND_VIEWS_WITH_TEXT = 1 static final int FOCUSABLE = 1 static final int FOCUSABLES_ALL = 0 static final int FOCUSABLES_TOUCH_MODE = 1 static final int FOCUSABLE_AUTO = 16 static final int[] FOCUSED_SELECTED_STATE_SET static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] FOCUSED_STATE_SET static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET static final int FOCUS_BACKWARD = 1 static final int FOCUS_DOWN = 130 static final int FOCUS_FORWARD = 2 static final int FOCUS_LEFT = 17 static final int FOCUS_RIGHT = 66 static final int FOCUS_UP = 33 static final int GONE = 8 static final int HAPTIC_FEEDBACK_ENABLED = 268435456 static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0 static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 2 static final int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_AUTO = 0 static final int IMPORTANT_FOR_AUTOFILL_NO = 2 static final int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_AUTOFILL_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4 static final int INVISIBLE = 4 static final int KEEP_SCREEN_ON = 67108864 static final int LAYER_TYPE_HARDWARE = 2 static final int LAYER_TYPE_NONE = 0 static final int LAYER_TYPE_SOFTWARE = 1 static final int LAYOUT_DIRECTION_INHERIT = 2 static final int LAYOUT_DIRECTION_LOCALE = 3 static final int LAYOUT_DIRECTION_LTR = 0 static final int LAYOUT_DIRECTION_RTL = 1 static final int MEASURED_HEIGHT_STATE_SHIFT = 16 static final int MEASURED_SIZE_MASK = 16777215 static final int MEASURED_STATE_MASK = -16777216 static final int MEASURED_STATE_TOO_SMALL = 16777216 static final int NOT_FOCUSABLE = 0 static final int NO_ID = -1 static final int OVER_SCROLL_ALWAYS = 0 static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1 static final int OVER_SCROLL_NEVER = 2 static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_STATE_SET static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_SELECTED_STATE_SET static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_STATE_SET static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET static final Property<View, Float> ROTATION static final Property<View, Float> ROTATION_X static final Property<View, Float> ROTATION_Y static final Property<View, Float> SCALE_X static final Property<View, Float> SCALE_Y static final int SCREEN_STATE_OFF = 0 static final int SCREEN_STATE_ON = 1 static final int SCROLLBARS_INSIDE_INSET = 16777216 static final int SCROLLBARS_INSIDE_OVERLAY = 0 static final int SCROLLBARS_OUTSIDE_INSET = 50331648 static final int SCROLLBARS_OUTSIDE_OVERLAY = 33554432 static final int SCROLLBAR_POSITION_DEFAULT = 0 static final int SCROLLBAR_POSITION_LEFT = 1 static final int SCROLLBAR_POSITION_RIGHT = 2 static final int SCROLL_AXIS_HORIZONTAL = 1 static final int SCROLL_AXIS_NONE = 0 static final int SCROLL_AXIS_VERTICAL = 2 static final int SCROLL_CAPTURE_HINT_AUTO = 0 static final int SCROLL_CAPTURE_HINT_EXCLUDE = 1 static final int SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4 static final int SCROLL_CAPTURE_HINT_INCLUDE = 2 static final int SCROLL_INDICATOR_BOTTOM = 2 static final int SCROLL_INDICATOR_END = 32 static final int SCROLL_INDICATOR_LEFT = 4 static final int SCROLL_INDICATOR_RIGHT = 8 static final int SCROLL_INDICATOR_START = 16 static final int SCROLL_INDICATOR_TOP = 1 static final int[] SELECTED_STATE_SET static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET static final int SOUND_EFFECTS_ENABLED = 134217728 static final int STATUS_BAR_HIDDEN = 1 This field is deprecated. static final int STATUS_BAR_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_FLAG_FULLSCREEN = 4 This field is deprecated. static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE = 2048 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 1024 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 512 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 256 This field is deprecated. static final int SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR = 16 This field is deprecated. static final int SYSTEM_UI_FLAG_LIGHT_STATUS_BAR = 8192 This field is deprecated. static final int SYSTEM_UI_FLAG_LOW_PROFILE = 1 This field is deprecated. static final int SYSTEM_UI_FLAG_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_LAYOUT_FLAGS = 1536 This field is deprecated. static final int TEXT_ALIGNMENT_CENTER = 4 static final int TEXT_ALIGNMENT_GRAVITY = 1 static final int TEXT_ALIGNMENT_INHERIT = 0 static final int TEXT_ALIGNMENT_TEXT_END = 3 static final int TEXT_ALIGNMENT_TEXT_START = 2 static final int TEXT_ALIGNMENT_VIEW_END = 6 static final int TEXT_ALIGNMENT_VIEW_START = 5 static final int TEXT_DIRECTION_ANY_RTL = 2 static final int TEXT_DIRECTION_FIRST_STRONG = 1 static final int TEXT_DIRECTION_FIRST_STRONG_LTR = 6 static final int TEXT_DIRECTION_FIRST_STRONG_RTL = 7 static final int TEXT_DIRECTION_INHERIT = 0 static final int TEXT_DIRECTION_LOCALE = 5 static final int TEXT_DIRECTION_LTR = 3 static final int TEXT_DIRECTION_RTL = 4 static final Property<View, Float> TRANSLATION_X static final Property<View, Float> TRANSLATION_Y static final Property<View, Float> TRANSLATION_Z static final String VIEW_LOG_TAG = "View" static final int VISIBLE = 0 static final int[] WINDOW_FOCUSED_STATE_SET static final Property<View, Float> X static final Property<View, Float> Y static final Property<View, Float> Z
From android.view.ViewGroup static final int CLIP_TO_PADDING_MASK = 34 static final int FOCUS_AFTER_DESCENDANTS = 262144 static final int FOCUS_BEFORE_DESCENDANTS = 131072 static final int FOCUS_BLOCK_DESCENDANTS = 393216 static final int LAYOUT_MODE_CLIP_BOUNDS = 0 static final int LAYOUT_MODE_OPTICAL_BOUNDS = 1 static final int PERSISTENT_ALL_CACHES = 3 This field is deprecated. static final int PERSISTENT_ANIMATION_CACHE = 1 This field is deprecated. static final int PERSISTENT_NO_CACHE = 0 This field is deprecated. static final int PERSISTENT_SCROLLING_CACHE = 2 This field is deprecated.

Inherited methods
From android.view.View void addOnAttachStateChangeListener(     View.OnAttachStateChangeListener listener ) void addOnLayoutChangeListener(View.OnLayoutChangeListener listener) void addOnUnhandledKeyEventListener(     View.OnUnhandledKeyEventListener listener ) ViewPropertyAnimator animate() void announceForAccessibility(CharSequence text) void autofill(AutofillValue value) boolean awakenScrollBars() void bringToFront() void buildDrawingCache() This method is deprecated. void buildLayer() boolean callOnClick() boolean canResolveLayoutDirection() boolean canResolveTextAlignment() boolean canResolveTextDirection() final void cancelDragAndDrop() void cancelLongPress() final void cancelPendingInputEvents() boolean checkInputConnectionProxy(View view) void clearAnimation() void clearViewTranslationCallback() static int combineMeasuredStates(int curState, int newState) int computeHorizontalScrollExtent() int computeHorizontalScrollOffset() int computeHorizontalScrollRange() void computeScroll() WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) int computeVerticalScrollExtent() int computeVerticalScrollOffset() int computeVerticalScrollRange() AccessibilityNodeInfo createAccessibilityNodeInfo() void createContextMenu(ContextMenu menu) void destroyDrawingCache() This method is deprecated. boolean dispatchGenericMotionEvent(MotionEvent event) boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) boolean dispatchNestedPreFling(float velocityX, float velocityY) boolean dispatchNestedPrePerformAccessibilityAction(     int action,     Bundle arguments ) boolean dispatchNestedPreScroll(     int dx,     int dy,     int[] consumed,     int[] offsetInWindow ) boolean dispatchNestedScroll(     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     int[] offsetInWindow ) boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) void draw(Canvas canvas) void drawableHotspotChanged(float x, float y) final OnBackInvokedDispatcher findOnBackInvokedDispatcher() final T <T extends View> findViewById(int id) final T <T extends View> findViewWithTag(Object tag) boolean fitSystemWindows(Rect insets) This method is deprecated. void forceHasOverlappingRendering(boolean hasOverlappingRendering) void forceLayout() void generateDisplayHash(     String hashAlgorithm,     Rect bounds,     Executor executor,     DisplayHashResultCallback callback ) static int generateViewId() View.AccessibilityDelegate getAccessibilityDelegate() int getAccessibilityLiveRegion() AccessibilityNodeProvider getAccessibilityNodeProvider() CharSequence getAccessibilityPaneTitle() int getAccessibilityTraversalAfter() int getAccessibilityTraversalBefore() String getAllowedHandwritingDelegatePackageName() String getAllowedHandwritingDelegatorPackageName() float getAlpha() Animation getAnimation() Matrix getAnimationMatrix() IBinder getApplicationWindowToken() int[] getAttributeResolutionStack(int attribute) Map<Integer, Integer> getAttributeSourceResourceMap() String[] getAutofillHints() final AutofillId getAutofillId() int getAutofillType() AutofillValue getAutofillValue() Drawable getBackground() BlendMode getBackgroundTintBlendMode() ColorStateList getBackgroundTintList() PorterDuff.Mode getBackgroundTintMode() int getBaseline() final int getBottom() float getBottomFadingEdgeStrength() int getBottomPaddingOffset() float getCameraDistance() Rect getClipBounds() boolean getClipBounds(Rect outRect) final boolean getClipToOutline() final ContentCaptureSession getContentCaptureSession() CharSequence getContentDescription() final Context getContext() ContextMenu.ContextMenuInfo getContextMenuInfo() final boolean getDefaultFocusHighlightEnabled() static int getDefaultSize(int size, int measureSpec) Display getDisplay() final int[] getDrawableState() Bitmap getDrawingCache() This method is deprecated. int getDrawingCacheBackgroundColor() This method is deprecated. int getDrawingCacheQuality() This method is deprecated. void getDrawingRect(Rect outRect) long getDrawingTime() float getElevation() int getExplicitStyle() boolean getFilterTouchesWhenObscured() boolean getFitsSystemWindows() int getFocusable() ArrayList<View> getFocusables(int direction) void getFocusedRect(Rect r) Drawable getForeground() int getForegroundGravity() BlendMode getForegroundTintBlendMode() ColorStateList getForegroundTintList() PorterDuff.Mode getForegroundTintMode() boolean getGlobalVisibleRect(Rect r, Point globalOffset) Handler getHandler() float getHandwritingBoundsOffsetBottom() float getHandwritingBoundsOffsetLeft() float getHandwritingBoundsOffsetRight() float getHandwritingBoundsOffsetTop() Runnable getHandwritingDelegatorCallback() final boolean getHasOverlappingRendering() final int getHeight() void getHitRect(Rect outRect) int getHorizontalFadingEdgeLength() int getHorizontalScrollbarHeight() Drawable getHorizontalScrollbarThumbDrawable() Drawable getHorizontalScrollbarTrackDrawable() int getId() int getImportantForAccessibility() int getImportantForAutofill() int getImportantForContentCapture() boolean getKeepScreenOn() KeyEvent.DispatcherState getKeyDispatcherState() int getLabelFor() int getLayerType() int getLayoutDirection() ViewGroup.LayoutParams getLayoutParams() final int getLeft() float getLeftFadingEdgeStrength() int getLeftPaddingOffset() final boolean getLocalVisibleRect(Rect r) void getLocationInSurface(int[] location) void getLocationInWindow(int[] outLocation) void getLocationOnScreen(int[] outLocation) Matrix getMatrix() final int getMeasuredHeight() final int getMeasuredHeightAndState() final int getMeasuredState() final int getMeasuredWidth() final int getMeasuredWidthAndState() int getMinimumHeight() int getMinimumWidth() int getNextClusterForwardId() int getNextFocusDownId() int getNextFocusForwardId() int getNextFocusLeftId() int getNextFocusRightId() int getNextFocusUpId() View.OnFocusChangeListener getOnFocusChangeListener() int getOutlineAmbientShadowColor() ViewOutlineProvider getOutlineProvider() int getOutlineSpotShadowColor() int getOverScrollMode() ViewOverlay getOverlay() int getPaddingBottom() int getPaddingEnd() int getPaddingLeft() int getPaddingRight() int getPaddingStart() int getPaddingTop() final ViewParent getParent() ViewParent getParentForAccessibility() float getPivotX() float getPivotY() PointerIcon getPointerIcon() final List<Rect> getPreferKeepClearRects() String[] getReceiveContentMimeTypes() Resources getResources() final boolean getRevealOnFocusHint() final int getRight() float getRightFadingEdgeStrength() int getRightPaddingOffset() AttachedSurfaceControl getRootSurfaceControl() View getRootView() WindowInsets getRootWindowInsets() float getRotation() float getRotationX() float getRotationY() float getScaleX() float getScaleY() int getScrollBarDefaultDelayBeforeFade() int getScrollBarFadeDuration() int getScrollBarSize() int getScrollBarStyle() int getScrollCaptureHint() int getScrollIndicators() final int getScrollX() final int getScrollY() int getSolidColor() int getSourceLayoutResId() final CharSequence getStateDescription() StateListAnimator getStateListAnimator() int getSuggestedMinimumHeight() int getSuggestedMinimumWidth() List<Rect> getSystemGestureExclusionRects() int getSystemUiVisibility() This method is deprecated. Object getTag() int getTextAlignment() int getTextDirection() CharSequence getTooltipText() final int getTop() float getTopFadingEdgeStrength() int getTopPaddingOffset() TouchDelegate getTouchDelegate() ArrayList<View> getTouchables() float getTransitionAlpha() String getTransitionName() float getTranslationX() float getTranslationY() float getTranslationZ() long getUniqueDrawingId() int getVerticalFadingEdgeLength() int getVerticalScrollbarPosition() Drawable getVerticalScrollbarThumbDrawable() Drawable getVerticalScrollbarTrackDrawable() int getVerticalScrollbarWidth() ViewTranslationResponse getViewTranslationResponse() ViewTreeObserver getViewTreeObserver() int getVisibility() final int getWidth() int getWindowAttachCount() WindowId getWindowId() WindowInsetsController getWindowInsetsController() int getWindowSystemUiVisibility() This method is deprecated. IBinder getWindowToken() int getWindowVisibility() void getWindowVisibleDisplayFrame(Rect outRect) float getX() float getY() float getZ() boolean hasExplicitFocusable() boolean hasFocusable() boolean hasNestedScrollingParent() boolean hasOnClickListeners() boolean hasOnLongClickListeners() boolean hasOverlappingRendering() boolean hasPointerCapture() boolean hasWindowFocus() static View inflate(Context context, int resource, ViewGroup root) void invalidate(Rect dirty) This method is deprecated. void invalidateDrawable(Drawable drawable) void invalidateOutline() boolean isAccessibilityDataSensitive() boolean isAccessibilityFocused() boolean isAccessibilityHeading() boolean isActivated() boolean isAttachedToWindow() boolean isAutoHandwritingEnabled() boolean isClickable() boolean isContextClickable() boolean isCredential() boolean isDirty() boolean isDrawingCacheEnabled() This method is deprecated. boolean isDuplicateParentStateEnabled() boolean isEnabled() final boolean isFocusable() final boolean isFocusableInTouchMode() boolean isFocused() final boolean isFocusedByDefault() boolean isForceDarkAllowed() boolean isHandwritingDelegate() boolean isHapticFeedbackEnabled() boolean isHardwareAccelerated() boolean isHorizontalFadingEdgeEnabled() boolean isHorizontalScrollBarEnabled() boolean isHovered() boolean isImportantForAccessibility() final boolean isImportantForAutofill() final boolean isImportantForContentCapture() boolean isInEditMode() boolean isInLayout() boolean isInTouchMode() final boolean isKeyboardNavigationCluster() boolean isLaidOut() boolean isLayoutDirectionResolved() boolean isLayoutRequested() boolean isLongClickable() boolean isNestedScrollingEnabled() boolean isOpaque() boolean isPaddingOffsetRequired() boolean isPaddingRelative() boolean isPivotSet() final boolean isPreferKeepClear() boolean isPressed() boolean isSaveEnabled() boolean isSaveFromParentEnabled() boolean isScreenReaderFocusable() boolean isScrollContainer() boolean isScrollbarFadingEnabled() boolean isSelected() final boolean isShowingLayoutBounds() boolean isShown() boolean isSoundEffectsEnabled() final boolean isTemporarilyDetached() boolean isTextAlignmentResolved() boolean isTextDirectionResolved() boolean isVerticalFadingEdgeEnabled() boolean isVerticalScrollBarEnabled() boolean isVisibleToUserForAutofill(int virtualId) View keyboardNavigationClusterSearch(View currentCluster, int direction) final void measure(int widthMeasureSpec, int heightMeasureSpec) static int[] mergeDrawableStates(int[] baseState, int[] additionalState) void offsetLeftAndRight(int offset) void offsetTopAndBottom(int offset) void onAnimationEnd() void onAnimationStart() WindowInsets onApplyWindowInsets(WindowInsets insets) void onCancelPendingInputEvents() boolean onCapturedPointerEvent(MotionEvent event) boolean onCheckIsTextEditor() void onConfigurationChanged(Configuration newConfig) void onCreateContextMenu(ContextMenu menu) InputConnection onCreateInputConnection(EditorInfo outAttrs) void onCreateViewTranslationRequest(     int[] supportedFormats,     Consumer<ViewTranslationRequest> requestsCollector ) void onCreateVirtualViewTranslationRequests(     long[] virtualIds,     int[] supportedFormats,     Consumer<ViewTranslationRequest> requestsCollector ) void onDisplayHint(int hint) boolean onDragEvent(DragEvent event) void onDraw(Canvas canvas) void onDrawForeground(Canvas canvas) final void onDrawScrollBars(Canvas canvas) boolean onFilterTouchEventForSecurity(MotionEvent event) void onFinishInflate() void onFinishTemporaryDetach() void onFocusChanged(     boolean gainFocus,     int direction,     Rect previouslyFocusedRect ) boolean onGenericMotionEvent(MotionEvent event) void onHoverChanged(boolean hovered) boolean onHoverEvent(MotionEvent event) void onInitializeAccessibilityEvent(AccessibilityEvent event) boolean onKeyDown(int keyCode, KeyEvent event) boolean onKeyLongPress(int keyCode, KeyEvent event) boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) boolean onKeyPreIme(int keyCode, KeyEvent event) boolean onKeyShortcut(int keyCode, KeyEvent event) boolean onKeyUp(int keyCode, KeyEvent event) void onOverScrolled(     int scrollX,     int scrollY,     boolean clampedX,     boolean clampedY ) void onPointerCaptureChange(boolean hasCapture) void onPopulateAccessibilityEvent(AccessibilityEvent event) void onProvideAutofillStructure(ViewStructure structure, int flags) void onProvideAutofillVirtualStructure(ViewStructure structure, int flags) void onProvideContentCaptureStructure(ViewStructure structure, int flags) void onProvideStructure(ViewStructure structure) void onProvideVirtualStructure(ViewStructure structure) ContentInfo onReceiveContent(ContentInfo payload) void onRtlPropertiesChanged(int layoutDirection) void onScreenStateChanged(int screenState) void onScrollCaptureSearch(     Rect localVisibleRect,     Point windowOffset,     Consumer<ScrollCaptureTarget> targets ) void onScrollChanged(int l, int t, int oldl, int oldt) boolean onSetAlpha(int alpha) void onSizeChanged(int w, int h, int oldw, int oldh) void onStartTemporaryDetach() boolean onTouchEvent(MotionEvent event) boolean onTrackballEvent(MotionEvent event) void onViewTranslationResponse(ViewTranslationResponse response) void onVirtualViewTranslationResponses(     LongSparseArray<ViewTranslationResponse> response ) void onVisibilityAggregated(boolean isVisible) void onVisibilityChanged(View changedView, int visibility) void onWindowFocusChanged(boolean hasWindowFocus) void onWindowSystemUiVisibilityChanged(int visible) This method is deprecated. void onWindowVisibilityChanged(int visibility) boolean overScrollBy(     int deltaX,     int deltaY,     int scrollX,     int scrollY,     int scrollRangeX,     int scrollRangeY,     int maxOverScrollX,     int maxOverScrollY,     boolean isTouchEvent ) boolean performClick() boolean performContextClick(float x, float y) boolean performHapticFeedback(int feedbackConstant) boolean performLongClick() ContentInfo performReceiveContent(ContentInfo payload) void playSoundEffect(int soundConstant) boolean post(Runnable action) boolean postDelayed(Runnable action, long delayMillis) void postInvalidate() void postInvalidateDelayed(long delayMilliseconds) void postInvalidateOnAnimation() void postOnAnimation(Runnable action) void postOnAnimationDelayed(Runnable action, long delayMillis) void refreshDrawableState() void releasePointerCapture() boolean removeCallbacks(Runnable action) void removeOnAttachStateChangeListener(     View.OnAttachStateChangeListener listener ) void removeOnLayoutChangeListener(View.OnLayoutChangeListener listener) void removeOnUnhandledKeyEventListener(     View.OnUnhandledKeyEventListener listener ) void requestApplyInsets() void requestFitSystemWindows() This method is deprecated. final boolean requestFocusFromTouch() void requestLayout() void requestPointerCapture() boolean requestRectangleOnScreen(Rect rectangle) final void requestUnbufferedDispatch(MotionEvent event) final T <T extends View> requireViewById(int id) void resetPivot() static int resolveSize(int size, int measureSpec) static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) void restoreHierarchyState(SparseArray<Parcelable> container) final void saveAttributeDataForStyleable(     Context context,     int[] styleable,     AttributeSet attrs,     TypedArray t,     int defStyleAttr,     int defStyleRes ) void saveHierarchyState(SparseArray<Parcelable> container) void scheduleDrawable(Drawable who, Runnable what, long when) void scrollBy(int x, int y) void scrollTo(int x, int y) void sendAccessibilityEvent(int eventType) void sendAccessibilityEventUnchecked(AccessibilityEvent event) void setAccessibilityDataSensitive(int accessibilityDataSensitive) void setAccessibilityDelegate(View.AccessibilityDelegate delegate) void setAccessibilityHeading(boolean isHeading) void setAccessibilityLiveRegion(int mode) void setAccessibilityPaneTitle(CharSequence accessibilityPaneTitle) void setAccessibilityTraversalAfter(int afterId) void setAccessibilityTraversalBefore(int beforeId) void setActivated(boolean activated) void setAllowClickWhenDisabled(boolean clickableWhenDisabled) void setAllowedHandwritingDelegatePackage(String allowedPackageName) void setAllowedHandwritingDelegatorPackage(String allowedPackageName) void setAlpha(float alpha) void setAnimation(Animation animation) void setAnimationMatrix(Matrix matrix) void setAutoHandwritingEnabled(boolean enabled) void setAutofillHints(String[] autofillHints) void setAutofillId(AutofillId id) void setBackground(Drawable background) void setBackgroundColor(int color) void setBackgroundDrawable(Drawable background) This method is deprecated. void setBackgroundResource(int resid) void setBackgroundTintBlendMode(BlendMode blendMode) void setBackgroundTintList(ColorStateList tint) void setBackgroundTintMode(PorterDuff.Mode tintMode) final void setBottom(int bottom) void setCameraDistance(float distance) void setClickable(boolean clickable) void setClipBounds(Rect clipBounds) void setClipToOutline(boolean clipToOutline) void setContentCaptureSession(ContentCaptureSession contentCaptureSession) void setContentDescription(CharSequence contentDescription) void setContextClickable(boolean contextClickable) void setDefaultFocusHighlightEnabled(boolean defaultFocusHighlightEnabled) void setDrawingCacheBackgroundColor(int color) This method is deprecated. void setDrawingCacheEnabled(boolean enabled) This method is deprecated. void setDrawingCacheQuality(int quality) This method is deprecated. void setDuplicateParentStateEnabled(boolean enabled) void setElevation(float elevation) void setEnabled(boolean enabled) void setFadingEdgeLength(int length) void setFilterTouchesWhenObscured(boolean enabled) void setFitsSystemWindows(boolean fitSystemWindows) void setFocusable(boolean focusable) void setFocusableInTouchMode(boolean focusableInTouchMode) void setFocusedByDefault(boolean isFocusedByDefault) void setForceDarkAllowed(boolean allow) void setForeground(Drawable foreground) void setForegroundGravity(int gravity) void setForegroundTintBlendMode(BlendMode blendMode) void setForegroundTintList(ColorStateList tint) void setForegroundTintMode(PorterDuff.Mode tintMode) void setHandwritingBoundsOffsets(     float offsetLeft,     float offsetTop,     float offsetRight,     float offsetBottom ) void setHandwritingDelegatorCallback(Runnable callback) void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) void setHasTransientState(boolean hasTransientState) void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) void setHorizontalScrollbarThumbDrawable(Drawable drawable) void setHorizontalScrollbarTrackDrawable(Drawable drawable) void setHovered(boolean hovered) void setId(int id) void setImportantForAccessibility(int mode) void setImportantForAutofill(int mode) void setImportantForContentCapture(int mode) void setIsCredential(boolean isCredential) void setIsHandwritingDelegate(boolean isHandwritingDelegate) void setKeepScreenOn(boolean keepScreenOn) void setKeyboardNavigationCluster(boolean isCluster) void setLabelFor(int id) void setLayerPaint(Paint paint) void setLayerType(int layerType, Paint paint) void setLayoutParams(ViewGroup.LayoutParams params) final void setLeft(int left) final void setLeftTopRightBottom(int left, int top, int right, int bottom) void setLongClickable(boolean longClickable) final void setMeasuredDimension(int measuredWidth, int measuredHeight) void setMinimumHeight(int minHeight) void setMinimumWidth(int minWidth) void setNestedScrollingEnabled(boolean enabled) void setNextClusterForwardId(int nextClusterForwardId) void setNextFocusDownId(int nextFocusDownId) void setNextFocusForwardId(int nextFocusForwardId) void setNextFocusLeftId(int nextFocusLeftId) void setNextFocusRightId(int nextFocusRightId) void setNextFocusUpId(int nextFocusUpId) void setOnApplyWindowInsetsListener(     View.OnApplyWindowInsetsListener listener ) void setOnCapturedPointerListener(View.OnCapturedPointerListener l) void setOnClickListener(View.OnClickListener l) void setOnContextClickListener(View.OnContextClickListener l) void setOnCreateContextMenuListener(View.OnCreateContextMenuListener l) void setOnDragListener(View.OnDragListener l) void setOnFocusChangeListener(View.OnFocusChangeListener l) void setOnGenericMotionListener(View.OnGenericMotionListener l) void setOnHoverListener(View.OnHoverListener l) void setOnKeyListener(View.OnKeyListener l) void setOnLongClickListener(View.OnLongClickListener l) void setOnReceiveContentListener(     String[] mimeTypes,     OnReceiveContentListener listener ) void setOnScrollChangeListener(View.OnScrollChangeListener l) void setOnSystemUiVisibilityChangeListener(     View.OnSystemUiVisibilityChangeListener l ) This method is deprecated. void setOnTouchListener(View.OnTouchListener l) void setOutlineAmbientShadowColor(int color) void setOutlineProvider(ViewOutlineProvider provider) void setOutlineSpotShadowColor(int color) void setOverScrollMode(int overScrollMode) void setPadding(int left, int top, int right, int bottom) void setPaddingRelative(int start, int top, int end, int bottom) void setPivotX(float pivotX) void setPivotY(float pivotY) void setPointerIcon(PointerIcon pointerIcon) final void setPreferKeepClear(boolean preferKeepClear) final void setPreferKeepClearRects(List<Rect> rects) void setPressed(boolean pressed) void setRenderEffect(RenderEffect renderEffect) final void setRevealOnFocusHint(boolean revealOnFocus) final void setRight(int right) void setRotation(float rotation) void setRotationX(float rotationX) void setRotationY(float rotationY) void setSaveEnabled(boolean enabled) void setSaveFromParentEnabled(boolean enabled) void setScaleX(float scaleX) void setScaleY(float scaleY) void setScreenReaderFocusable(boolean screenReaderFocusable) void setScrollBarDefaultDelayBeforeFade(     int scrollBarDefaultDelayBeforeFade ) void setScrollBarFadeDuration(int scrollBarFadeDuration) void setScrollBarSize(int scrollBarSize) void setScrollBarStyle(int style) final void setScrollCaptureCallback(ScrollCaptureCallback callback) void setScrollCaptureHint(int hint) void setScrollContainer(boolean isScrollContainer) void setScrollIndicators(int indicators) void setScrollX(int value) void setScrollY(int value) void setScrollbarFadingEnabled(boolean fadeScrollbars) void setSelected(boolean selected) void setSoundEffectsEnabled(boolean soundEffectsEnabled) void setStateDescription(CharSequence stateDescription) void setStateListAnimator(StateListAnimator stateListAnimator) void setSystemGestureExclusionRects(List<Rect> rects) void setSystemUiVisibility(int visibility) This method is deprecated. void setTag(Object tag) void setTextAlignment(int textAlignment) void setTextDirection(int textDirection) void setTooltipText(CharSequence tooltipText) final void setTop(int top) void setTouchDelegate(TouchDelegate delegate) void setTransitionAlpha(float alpha) final void setTransitionName(String transitionName) void setTransitionVisibility(int visibility) void setTranslationX(float translationX) void setTranslationY(float translationY) void setTranslationZ(float translationZ) void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) void setVerticalScrollbarPosition(int position) void setVerticalScrollbarThumbDrawable(Drawable drawable) void setVerticalScrollbarTrackDrawable(Drawable drawable) void setViewTranslationCallback(ViewTranslationCallback callback) void setVisibility(int visibility) void setWillNotCacheDrawing(boolean willNotCacheDrawing) This method is deprecated. void setWillNotDraw(boolean willNotDraw) void setX(float x) void setY(float y) void setZ(float z) boolean showContextMenu() ActionMode startActionMode(ActionMode.Callback callback) void startAnimation(Animation animation) final boolean startDrag(     ClipData data,     View.DragShadowBuilder shadowBuilder,     Object myLocalState,     int flags ) This method is deprecated. final boolean startDragAndDrop(     ClipData data,     View.DragShadowBuilder shadowBuilder,     Object myLocalState,     int flags ) boolean startNestedScroll(int axes) void stopNestedScroll() String toString() void transformMatrixToGlobal(Matrix matrix) void transformMatrixToLocal(Matrix matrix) void unscheduleDrawable(Drawable who, Runnable what) final void updateDragShadow(View.DragShadowBuilder shadowBuilder) boolean verifyDrawable(Drawable who) boolean willNotCacheDrawing() This method is deprecated. boolean willNotDraw()
From android.view.ViewGroup void addChildrenForAccessibility(ArrayList<View> outChildren) void addExtraDataToAccessibilityNodeInfo(     AccessibilityNodeInfo info,     String extraDataKey,     Bundle arguments ) void addFocusables(ArrayList<View> views, int direction, int focusableMode) void addKeyboardNavigationClusters(Collection<View> views, int direction) boolean addStatesFromChildren() void addTouchables(ArrayList<View> views) void addView(View child) boolean addViewInLayout(View child, int index, ViewGroup.LayoutParams params) void attachLayoutAnimationParameters(     View child,     ViewGroup.LayoutParams params,     int index,     int count ) void attachViewToParent(View child, int index, ViewGroup.LayoutParams params) void bringChildToFront(View child) boolean canAnimate() boolean checkLayoutParams(ViewGroup.LayoutParams p) void childDrawableStateChanged(View child) void childHasTransientStateChanged(     View child,     boolean childHasTransientState ) void cleanupLayoutState(View child) void clearChildFocus(View child) void clearDisappearingChildren() void clearFocus() void debug(int depth) void detachAllViewsFromParent() void detachViewFromParent(View child) void detachViewsFromParent(int start, int count) WindowInsets dispatchApplyWindowInsets(WindowInsets insets) boolean dispatchCapturedPointerEvent(MotionEvent event) void dispatchConfigurationChanged(Configuration newConfig) void dispatchCreateViewTranslationRequest(     Map<AutofillId, long[]> viewIds,     int[] supportedFormats,     TranslationCapability capability,     List<ViewTranslationRequest> requests ) void dispatchDisplayHint(int hint) boolean dispatchDragEvent(DragEvent event) void dispatchDraw(Canvas canvas) void dispatchDrawableHotspotChanged(float x, float y) void dispatchFinishTemporaryDetach() void dispatchFreezeSelfOnly(SparseArray<Parcelable> container) boolean dispatchGenericFocusedEvent(MotionEvent event) boolean dispatchGenericPointerEvent(MotionEvent event) boolean dispatchHoverEvent(MotionEvent event) boolean dispatchKeyEvent(KeyEvent event) boolean dispatchKeyEventPreIme(KeyEvent event) boolean dispatchKeyShortcutEvent(KeyEvent event) void dispatchPointerCaptureChanged(boolean hasCapture) void dispatchProvideAutofillStructure(ViewStructure structure, int flags) void dispatchProvideStructure(ViewStructure structure) void dispatchSaveInstanceState(SparseArray<Parcelable> container) void dispatchScrollCaptureSearch(     Rect localVisibleRect,     Point windowOffset,     Consumer<ScrollCaptureTarget> targets ) void dispatchSetActivated(boolean activated) void dispatchSetPressed(boolean pressed) void dispatchSetSelected(boolean selected) void dispatchStartTemporaryDetach() void dispatchSystemUiVisibilityChanged(int visible) This method is deprecated. void dispatchThawSelfOnly(SparseArray<Parcelable> container) boolean dispatchTouchEvent(MotionEvent ev) boolean dispatchTrackballEvent(MotionEvent event) boolean dispatchUnhandledMove(View focused, int direction) void dispatchVisibilityChanged(View changedView, int visibility) void dispatchWindowFocusChanged(boolean hasFocus) void dispatchWindowInsetsAnimationEnd(WindowInsetsAnimation animation) void dispatchWindowInsetsAnimationPrepare(WindowInsetsAnimation animation) WindowInsets dispatchWindowInsetsAnimationProgress(     WindowInsets insets,     List<WindowInsetsAnimation> runningAnimations ) WindowInsetsAnimation.Bounds dispatchWindowInsetsAnimationStart(     WindowInsetsAnimation animation,     WindowInsetsAnimation.Bounds bounds ) void dispatchWindowSystemUiVisiblityChanged(int visible) This method is deprecated. void dispatchWindowVisibilityChanged(int visibility) boolean drawChild(Canvas canvas, View child, long drawingTime) void drawableStateChanged() void endViewTransition(View view) View findFocus() OnBackInvokedDispatcher findOnBackInvokedDispatcherForChild(View child, View requester) void findViewsWithText(     ArrayList<View> outViews,     CharSequence text,     int flags ) View focusSearch(View focused, int direction) void focusableViewAvailable(View v) boolean gatherTransparentRegion(Region region) ViewGroup.LayoutParams generateDefaultLayoutParams() ViewGroup.LayoutParams generateLayoutParams(AttributeSet attrs) View getChildAt(int index) int getChildCount() int getChildDrawingOrder(int childCount, int drawingPosition) static int getChildMeasureSpec(int spec, int padding, int childDimension) boolean getChildStaticTransformation(View child, Transformation t) boolean getChildVisibleRect(View child, Rect r, Point offset) boolean getClipChildren() boolean getClipToPadding() int getDescendantFocusability() View getFocusedChild() LayoutAnimationController getLayoutAnimation() Animation.AnimationListener getLayoutAnimationListener() int getLayoutMode() LayoutTransition getLayoutTransition() int getNestedScrollAxes() ViewGroupOverlay getOverlay() int getPersistentDrawingCache() This method is deprecated. boolean getTouchscreenBlocksFocus() boolean hasFocus() boolean hasTransientState() int indexOfChild(View child) final void invalidateChild(View child, Rect dirty) This method is deprecated. ViewParent invalidateChildInParent(int[] location, Rect dirty) This method is deprecated. boolean isAlwaysDrawnWithCacheEnabled() This method is deprecated. boolean isAnimationCacheEnabled() This method is deprecated. boolean isChildrenDrawingOrderEnabled() boolean isChildrenDrawnWithCacheEnabled() This method is deprecated. boolean isLayoutSuppressed() boolean isMotionEventSplittingEnabled() boolean isTransitionGroup() void jumpDrawablesToCurrentState() final void layout(int l, int t, int r, int b) void measureChild(     View child,     int parentWidthMeasureSpec,     int parentHeightMeasureSpec ) void measureChildWithMargins(     View child,     int parentWidthMeasureSpec,     int widthUsed,     int parentHeightMeasureSpec,     int heightUsed ) void measureChildren(int widthMeasureSpec, int heightMeasureSpec) void notifySubtreeAccessibilityStateChanged(     View child,     View source,     int changeType ) final void offsetDescendantRectToMyCoords(View descendant, Rect rect) final void offsetRectIntoDescendantCoords(View descendant, Rect rect) void onAttachedToWindow() int[] onCreateDrawableState(int extraSpace) void onDescendantInvalidated(View child, View target) void onDetachedFromWindow() boolean onInterceptHoverEvent(MotionEvent event) boolean onInterceptTouchEvent(MotionEvent ev) boolean onNestedFling(     View target,     float velocityX,     float velocityY,     boolean consumed ) boolean onNestedPreFling(View target, float velocityX, float velocityY) boolean onNestedPrePerformAccessibilityAction(     View target,     int action,     Bundle args ) void onNestedPreScroll(View target, int dx, int dy, int[] consumed) void onNestedScroll(     View target,     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed ) void onNestedScrollAccepted(View child, View target, int axes) boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) boolean onRequestSendAccessibilityEvent(View child, AccessibilityEvent event) PointerIcon onResolvePointerIcon(MotionEvent event, int pointerIndex) boolean onStartNestedScroll(View child, View target, int nestedScrollAxes) void onStopNestedScroll(View child) void onViewRemoved(View child) void recomputeViewAttributes(View child) void removeAllViews() void removeAllViewsInLayout() void removeDetachedView(View child, boolean animate) void removeView(View view) void removeViewAt(int index) void removeViewInLayout(View view) void removeViews(int start, int count) void removeViewsInLayout(int start, int count) void requestChildFocus(View child, View focused) boolean requestChildRectangleOnScreen(     View child,     Rect rectangle,     boolean immediate ) void requestDisallowInterceptTouchEvent(boolean disallowIntercept) boolean requestFocus(int direction, Rect previouslyFocusedRect) boolean requestSendAccessibilityEvent(View child, AccessibilityEvent event) void requestTransparentRegion(View child) boolean restoreDefaultFocus() void scheduleLayoutAnimation() void setAddStatesFromChildren(boolean addsStates) void setAlwaysDrawnWithCacheEnabled(boolean always) This method is deprecated. void setAnimationCacheEnabled(boolean enabled) This method is deprecated. void setChildrenDrawingCacheEnabled(boolean enabled) This method is deprecated. void setChildrenDrawingOrderEnabled(boolean enabled) void setChildrenDrawnWithCacheEnabled(boolean enabled) This method is deprecated. void setClipChildren(boolean clipChildren) void setClipToPadding(boolean clipToPadding) void setDescendantFocusability(int focusability) void setLayoutAnimation(LayoutAnimationController controller) void setLayoutAnimationListener(     Animation.AnimationListener animationListener ) void setLayoutMode(int layoutMode) void setLayoutTransition(LayoutTransition transition) void setMotionEventSplittingEnabled(boolean split) void setOnHierarchyChangeListener(     ViewGroup.OnHierarchyChangeListener listener ) void setPersistentDrawingCache(int drawingCacheToKeep) This method is deprecated. void setStaticTransformationsEnabled(boolean enabled) void setTouchscreenBlocksFocus(boolean touchscreenBlocksFocus) void setTransitionGroup(boolean isTransitionGroup) void setWindowInsetsAnimationCallback(     WindowInsetsAnimation.Callback callback ) boolean shouldDelayChildPressedState() boolean showContextMenuForChild(View originalView) ActionMode startActionModeForChild(     View originalView,     ActionMode.Callback callback ) void startLayoutAnimation() void startViewTransition(View view) void suppressLayout(boolean suppress) void updateViewLayout(View view, ViewGroup.LayoutParams params)

Constants

OFFSCREEN_PAGE_LIMIT_DEFAULT

Added in 1.0.0

public static final int OFFSCREEN_PAGE_LIMIT_DEFAULT = -1

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.

See also
setOffscreenPageLimit

ORIENTATION_HORIZONTAL

Added in 1.0.0

public static final int ORIENTATION_HORIZONTAL = 0

ORIENTATION_VERTICAL

Added in 1.0.0

public static final int ORIENTATION_VERTICAL = 1

SCROLL_STATE_DRAGGING

Added in 1.0.0

public static final int SCROLL_STATE_DRAGGING = 1

Indicates that the ViewPager2 is currently being dragged by the user, or programmatically via fake drag functionality.

SCROLL_STATE_IDLE

Added in 1.0.0

public static final int SCROLL_STATE_IDLE = 0

Indicates that the ViewPager2 is in an idle, settled state. The current page is fully in view and no animation is in progress.

SCROLL_STATE_SETTLING

Added in 1.0.0

public static final int SCROLL_STATE_SETTLING = 2

Indicates that the ViewPager2 is in the process of settling to a final position.

Public constructors

ViewPager2

Added in 1.0.0

public ViewPager2(@NonNull Context context)

ViewPager2

Added in 1.0.0

public ViewPager2(@NonNull Context context, @Nullable AttributeSet attrs)

ViewPager2

Added in 1.0.0

public ViewPager2(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr
)

ViewPager2

Added in 1.0.0

@RequiresApi(value = 21)
public ViewPager2(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr,
    int defStyleRes
)

Public methods

addItemDecoration

Added in 1.0.0

public void addItemDecoration(@NonNull RecyclerView.ItemDecoration decor)

Add an ItemDecoration to this ViewPager2. Item decorations can affect both measurement and drawing of individual item views.

Item decorations are ordered. Decorations placed earlier in the list will be run/queried/drawn first for their effects on item views. Padding added to views will be nested; a padding added by an earlier decoration will mean further item decorations in the list will be asked to draw/pad within the previous decoration's given area.

Parameters
@NonNull RecyclerView.ItemDecoration decor	Decoration to add

addItemDecoration

Added in 1.0.0

public void addItemDecoration(@NonNull RecyclerView.ItemDecoration decor, int index)

Add an ItemDecoration to this ViewPager2. Item decorations can affect both measurement and drawing of individual item views.

Item decorations are ordered. Decorations placed earlier in the list will be run/queried/drawn first for their effects on item views. Padding added to views will be nested; a padding added by an earlier decoration will mean further item decorations in the list will be asked to draw/pad within the previous decoration's given area.

Parameters
@NonNull RecyclerView.ItemDecoration decor	Decoration to add
int index	Position in the decoration chain to insert this decoration at. If this value is negative the decoration will be added at the end.

Throws
java.lang.IndexOutOfBoundsException	on indexes larger than getItemDecorationCount

beginFakeDrag

Added in 1.0.0

public boolean beginFakeDrag()

Start a fake drag of the pager.

A fake drag can be useful if you want to synchronize the motion of the ViewPager2 with the touch scrolling of another view, while still letting the ViewPager2 control the snapping motion and fling behavior. (e.g. parallax-scrolling tabs.) Call fakeDragBy to simulate the actual drag motion. Call endFakeDrag to complete the fake drag and fling as necessary.

A fake drag can be interrupted by a real drag. From that point on, all calls to fakeDragBy and endFakeDrag will be ignored until the next fake drag is started by calling beginFakeDrag. If you need the ViewPager2 to ignore touch events and other user input during a fake drag, use setUserInputEnabled. If a real or fake drag is already in progress, this method will return false.

Returns
boolean	true if the fake drag began successfully, false if it could not be started

See also
fakeDragBy
endFakeDrag
isFakeDragging

canScrollHorizontally

public boolean canScrollHorizontally(int direction)

canScrollVertically

public boolean canScrollVertically(int direction)

endFakeDrag

Added in 1.0.0

public boolean endFakeDrag()

End a fake drag of the pager.

Returns
boolean	true if the fake drag was ended. If false is returned, it means there was no fake drag to end.

See also
beginFakeDrag
fakeDragBy
isFakeDragging

fakeDragBy

Added in 1.0.0

public boolean fakeDragBy(@Px float offsetPxFloat)

Fake drag by an offset in pixels. You must have called beginFakeDrag first. Drag happens in the direction of the orientation. Positive offsets will drag to the previous page, negative values to the next page, with one exception: if layout direction is set to RTL and the ViewPager2's orientation is horizontal, then the behavior will be inverted. This matches the deltas of touch events that would cause the same real drag.

If the pager is not in the fake dragging state anymore, it ignores this call and returns false.

Parameters
@Px float offsetPxFloat	Offset in pixels to drag by

Returns
boolean	true if the fake drag was executed. If false is returned, it means there was no fake drag to end.

See also
beginFakeDrag
endFakeDrag
isFakeDragging

getAccessibilityClassName

@RequiresApi(value = 23)
public CharSequence getAccessibilityClassName()

getAdapter

Added in 1.0.0

public @Nullable RecyclerView.Adapter getAdapter()

getCurrentItem

Added in 1.0.0

public int getCurrentItem()

Returns the currently selected page. If no page can sensibly be selected because there is no adapter or the adapter is empty, returns 0.

Returns
int	Currently selected page

getItemDecorationAt

Added in 1.0.0

public @NonNull RecyclerView.ItemDecoration getItemDecorationAt(int index)

Returns an ItemDecoration previously added to this ViewPager2.

Parameters
int index	The index position of the desired ItemDecoration.

Returns
@NonNull RecyclerView.ItemDecoration	the ItemDecoration at index position

Throws
java.lang.IndexOutOfBoundsException	on invalid index

getItemDecorationCount

Added in 1.0.0

public int getItemDecorationCount()

Returns the number of ItemDecoration currently added to this ViewPager2.

Returns
int	number of ItemDecorations currently added added to this ViewPager2.

getOffscreenPageLimit

Added in 1.0.0

public 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. Defaults to OFFSCREEN_PAGE_LIMIT_DEFAULT.

Returns
int	How many pages will be kept offscreen on either side

See also
setOffscreenPageLimit

getOrientation

Added in 1.0.0

public int getOrientation()

getScrollState

Added in 1.0.0

public int getScrollState()

Returns the current scroll state of the ViewPager2. Returned value is one of can be one of SCROLL_STATE_IDLE, SCROLL_STATE_DRAGGING or SCROLL_STATE_SETTLING.

Returns
int	The scroll state that was last dispatched to onPageScrollStateChanged

invalidateItemDecorations

Added in 1.0.0

public void invalidateItemDecorations()

Invalidates all ItemDecorations. If ViewPager2 has item decorations, calling this method will trigger a requestLayout call.

isFakeDragging

Added in 1.0.0

public boolean isFakeDragging()

Returns true if a fake drag is in progress.

Returns
boolean	true if currently in a fake drag, false otherwise.

See also
beginFakeDrag
fakeDragBy
endFakeDrag

isUserInputEnabled

Added in 1.0.0

public boolean isUserInputEnabled()

Returns if user initiated scrolling between pages is enabled. Enabled by default.

Returns
boolean	true if users can scroll the ViewPager2, false otherwise

See also
setUserInputEnabled

onInitializeAccessibilityNodeInfo

public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)

onViewAdded

public void onViewAdded(View child)

performAccessibilityAction

public boolean performAccessibilityAction(int action, @Nullable Bundle arguments)

registerOnPageChangeCallback

Added in 1.0.0

public void registerOnPageChangeCallback(
    @NonNull ViewPager2.OnPageChangeCallback callback
)

Add a callback that will be invoked whenever the page changes or is incrementally scrolled. See OnPageChangeCallback.

Components that add a callback should take care to remove it when finished.

Parameters
@NonNull ViewPager2.OnPageChangeCallback callback	callback to add

removeItemDecoration

Added in 1.0.0

public void removeItemDecoration(@NonNull RecyclerView.ItemDecoration decor)

Remove an ItemDecoration from this ViewPager2.

The given decoration will no longer impact the measurement and drawing of item views.

Parameters
@NonNull RecyclerView.ItemDecoration decor	Decoration to remove

See also
addItemDecoration

removeItemDecorationAt

Added in 1.0.0

public void removeItemDecorationAt(int index)

Removes the ItemDecoration associated with the supplied index position.

Parameters
int index	The index position of the ItemDecoration to be removed.

Throws
java.lang.IndexOutOfBoundsException	on invalid index

requestTransform

Added in 1.0.0

public void requestTransform()

Trigger a call to the registered PageTransformer's transformPage method. Call this when something has changed which has invalidated the transformations defined by the PageTransformer that did not trigger a page scroll.

setAdapter

Added in 1.0.0

public void setAdapter(@Nullable RecyclerView.Adapter adapter)

Set a new adapter to provide page views on demand.

If you're planning to use Fragments as pages, implement FragmentStateAdapter. If your pages are Views, implement RecyclerView.Adapter as usual.

If your pages contain LayoutTransitions, then those LayoutTransitions must have animateParentHierarchy set to false. Note that if you have a ViewGroup with animateLayoutChanges="true" in your layout xml file, a LayoutTransition is added automatically to that ViewGroup. You will need to manually call getLayoutTransition().setAnimateParentHierarchy(false) on that ViewGroup after you inflated the xml layout, like this:

View view = layoutInflater.inflate(R.layout.page, parent, false);
ViewGroup viewGroup = view.findViewById(R.id.animated_viewgroup);
viewGroup.getLayoutTransition().setAnimateParentHierarchy(false);

Parameters
@Nullable RecyclerView.Adapter adapter	The adapter to use, or null to remove the current adapter

See also
FragmentStateAdapter
setAdapter

setCurrentItem

Added in 1.0.0

public void setCurrentItem(int item)

Set the currently selected page. If the ViewPager has already been through its first layout with its current adapter there will be a smooth animated transition between the current item and the specified item. Silently ignored if the adapter is not set or empty. Clamps item to the bounds of the adapter.

Parameters
int item	Item index to select

setCurrentItem

Added in 1.0.0

public void setCurrentItem(int item, boolean smoothScroll)

Set the currently selected page. If smoothScroll = true, will perform a smooth animation from the current item to the new item. Silently ignored if the adapter is not set or empty. Clamps item to the bounds of the adapter.

Parameters
int item	Item index to select
boolean smoothScroll	True to smoothly scroll to the new item, false to transition immediately

setLayoutDirection

public void setLayoutDirection(int layoutDirection)

setOffscreenPageLimit

Added in 1.0.0

public void setOffscreenPageLimit(int limit)

Set the number of pages that should be retained to either side of the currently visible page(s). Pages beyond this limit will be recreated from the adapter when needed. Set this to OFFSCREEN_PAGE_LIMIT_DEFAULT to use RecyclerView's caching strategy. The given value must either be larger than 0, or #OFFSCREEN_PAGE_LIMIT_DEFAULT.

Pages within limit pages away from the current page are created and added to the view hierarchy, even though they are not visible on the screen. Pages outside this limit will be removed from the view hierarchy, but the ViewHolders will be recycled as usual by RecyclerView.

This is offered as an optimization. If you know in advance the number of pages you will need to support or have lazy-loading mechanisms in place on your pages, tweaking this setting can have benefits in perceived smoothness of paging animations and interaction. If you have a small number of pages (3-4) that you can keep active all at once, less time will be spent in layout for newly created view subtrees as the user pages back and forth.

You should keep this limit low, especially if your pages have complex layouts. By default it is set to OFFSCREEN_PAGE_LIMIT_DEFAULT.

Parameters
int limit	How many pages will be kept offscreen on either side. Valid values are all values >= 1 and OFFSCREEN_PAGE_LIMIT_DEFAULT

Throws
java.lang.IllegalArgumentException	If the given limit is invalid

See also
getOffscreenPageLimit

setOrientation

Added in 1.0.0

public void setOrientation(int orientation)

Sets the orientation of the ViewPager2.

Parameters
int orientation	ORIENTATION_HORIZONTAL or ORIENTATION_VERTICAL

setPageTransformer

Added in 1.0.0

public void setPageTransformer(@Nullable ViewPager2.PageTransformer transformer)

Sets a PageTransformer that will be called for each attached page whenever the scroll position is changed. This allows the application to apply custom property transformations to each page, overriding the default sliding behavior.

Note: setting a PageTransformer disables data-set change animations to prevent conflicts between the two animation systems. Setting a null transformer will restore data-set change animations.

Parameters
@Nullable ViewPager2.PageTransformer transformer	PageTransformer that will modify each page's animation properties

See also
MarginPageTransformer
CompositePageTransformer

setUserInputEnabled

Added in 1.0.0

public void setUserInputEnabled(boolean enabled)

Enable or disable user initiated scrolling. This includes touch input (scroll and fling gestures) and accessibility input. Disabling keyboard input is not yet supported. When user initiated scrolling is disabled, programmatic scrolls through setCurrentItem still work. By default, user initiated scrolling is enabled.

Parameters
boolean enabled	true to allow user initiated scrolling, false to block user initiated scrolling

See also
isUserInputEnabled

unregisterOnPageChangeCallback

Added in 1.0.0

public void unregisterOnPageChangeCallback(
    @NonNull ViewPager2.OnPageChangeCallback callback
)

Remove a callback that was previously added via registerOnPageChangeCallback.

Parameters
@NonNull ViewPager2.OnPageChangeCallback callback	callback to remove

Protected methods

dispatchRestoreInstanceState

protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container)

onLayout

protected void onLayout(boolean changed, int l, int t, int r, int b)

onMeasure

protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

onRestoreInstanceState

protected void onRestoreInstanceState(Parcelable state)

onSaveInstanceState

protected @Nullable Parcelable onSaveInstanceState()