NestedScrollView

Artifact: androidx.core:core

View Source

Added in 1.1.0

---

Kotlin |Java

public class NestedScrollView extends FrameLayout implements NestedScrollingParent3, NestedScrollingChild3, ScrollingView

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.core.widget.NestedScrollView

---

NestedScrollView is just like ScrollView, but it supports acting as both a nested scrolling parent and child on both new and old versions of Android. Nested scrolling is enabled by default.

Summary

Nested types
public interface NestedScrollView.OnScrollChangeListener Interface definition for a callback to be invoked when the scroll X or Y positions of a view change.

Public constructors
NestedScrollView(@NonNull Context context)
NestedScrollView(@NonNull Context context, @Nullable AttributeSet attrs)
NestedScrollView(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyleAttr )

Public methods
void	addView(@NonNull View child)
void	addView(View child, int index)
void	addView(View child, ViewGroup.LayoutParams params)
void	addView(View child, int index, ViewGroup.LayoutParams params)
boolean	arrowScroll(int direction) Handle scrolling in response to an up or down arrow click.
void	computeScroll()
boolean	dispatchKeyEvent(KeyEvent event)
boolean	dispatchNestedFling(float velocityX, float velocityY, boolean consumed)
boolean	dispatchNestedPreFling(float velocityX, float velocityY)
boolean	dispatchNestedPreScroll(     int dx,     int dy,     @Nullable int[] consumed,     @Nullable int[] offsetInWindow )
boolean	dispatchNestedPreScroll(     int dx,     int dy,     @Nullable int[] consumed,     @Nullable int[] offsetInWindow,     int type ) Dispatch one step of a nested scroll in progress before this view consumes any portion of it.
boolean	dispatchNestedScroll(     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     @Nullable int[] offsetInWindow )
boolean	dispatchNestedScroll(     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     @Nullable int[] offsetInWindow,     int type ) Dispatch one step of a nested scroll in progress.
void	dispatchNestedScroll(     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     @Nullable int[] offsetInWindow,     int type,     @NonNull int[] consumed ) Dispatch one step of a nested scroll in progress.
void	draw(@NonNull Canvas canvas)
boolean	executeKeyEvent(@NonNull KeyEvent event) 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.
void	fling(int velocityY) Fling the scroll view
boolean	fullScroll(int direction) Handles scrolling in response to a "home/end" shortcut press.
int	getMaxScrollAmount()
int	getNestedScrollAxes()
boolean	hasNestedScrollingParent()
boolean	hasNestedScrollingParent(int type) Returns true if this view has a nested scrolling parent for the given input type.
boolean	isFillViewport() Indicates whether this ScrollView's content is stretched to fill the viewport.
boolean	isNestedScrollingEnabled()
boolean	isSmoothScrollingEnabled()
void	onAttachedToWindow()
boolean	onGenericMotionEvent(@NonNull MotionEvent motionEvent)
boolean	onInterceptTouchEvent(@NonNull MotionEvent ev)
boolean	onNestedFling(     @NonNull View target,     float velocityX,     float velocityY,     boolean consumed )
boolean	onNestedPreFling(@NonNull View target, float velocityX, float velocityY)
void	onNestedPreScroll(     @NonNull View target,     int dx,     int dy,     @NonNull int[] consumed )
void	onNestedPreScroll(     @NonNull View target,     int dx,     int dy,     @NonNull int[] consumed,     int type ) React to a nested scroll in progress before the target view consumes a portion of the scroll.
void	onNestedScroll(     @NonNull View target,     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed )
void	onNestedScroll(     @NonNull View target,     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     int type ) React to a nested scroll in progress.
void	onNestedScroll(     @NonNull View target,     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     int type,     @NonNull int[] consumed ) React to a nested scroll in progress.
void	onNestedScrollAccepted(@NonNull View child, @NonNull View target, int axes)
void	onNestedScrollAccepted(     @NonNull View child,     @NonNull View target,     int axes,     int type ) React to the successful claiming of a nested scroll operation.
boolean	onStartNestedScroll(@NonNull View child, @NonNull View target, int axes)
boolean	onStartNestedScroll(     @NonNull View child,     @NonNull View target,     int axes,     int type ) React to a descendant view initiating a nestable scroll operation, claiming the nested scroll operation if appropriate.
void	onStopNestedScroll(@NonNull View target)
void	onStopNestedScroll(@NonNull View target, int type) React to a nested scroll operation ending.
boolean	onTouchEvent(@NonNull MotionEvent motionEvent)
boolean	pageScroll(int direction) Handles scrolling in response to a "page up/down" shortcut press.
void	requestChildFocus(View child, View focused)
boolean	requestChildRectangleOnScreen(     @NonNull View child,     Rect rectangle,     boolean immediate )
void	requestDisallowInterceptTouchEvent(boolean disallowIntercept)
void	requestLayout()
void	scrollTo(int x, int y) This version also clamps the scrolling to the bounds of our child.
void	setFillViewport(boolean fillViewport) Set whether this ScrollView should stretch its content height to fill the viewport or not.
void	setNestedScrollingEnabled(boolean enabled)
void	setOnScrollChangeListener(     @Nullable NestedScrollView.OnScrollChangeListener l ) Register a callback to be invoked when the scroll X or Y positions of this view change.
void	setSmoothScrollingEnabled(boolean smoothScrollingEnabled) Set whether arrow scrolling will animate its transition.
boolean	shouldDelayChildPressedState()
final void	smoothScrollBy(int dx, int dy) Like scrollBy, but scroll smoothly instead of immediately.
final void	smoothScrollBy(int dx, int dy, int scrollDurationMs) Like scrollBy, but scroll smoothly instead of immediately.
final void	smoothScrollTo(int x, int y) Like scrollTo, but scroll smoothly instead of immediately.
final void	smoothScrollTo(int x, int y, int scrollDurationMs) Like scrollTo, but scroll smoothly instead of immediately.
boolean	startNestedScroll(int axes)
boolean	startNestedScroll(int axes, int type) Begin a nestable scroll operation along the given axes, for the given input type.
void	stopNestedScroll()
void	stopNestedScroll(int type) Stop a nested scroll in progress for the given input type.

Protected methods
int	computeScrollDeltaToGetChildRectOnScreen(Rect rect) Compute the amount to scroll in the Y direction in order to get a rectangle completely on the screen (or, if taller than the screen, at least the first screen size chunk of it).
float	getBottomFadingEdgeStrength()
float	getTopFadingEdgeStrength()
void	measureChild(     @NonNull View child,     int parentWidthMeasureSpec,     int parentHeightMeasureSpec )
void	measureChildWithMargins(     View child,     int parentWidthMeasureSpec,     int widthUsed,     int parentHeightMeasureSpec,     int heightUsed )
void	onLayout(boolean changed, int l, int t, int r, int b)
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void	onOverScrolled(     int scrollX,     int scrollY,     boolean clampedX,     boolean clampedY )
boolean	onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) When looking for focus in children of a scroll view, need to be a little more careful not to give focus to something that is scrolled off screen.
void	onRestoreInstanceState(Parcelable state)
@NonNull Parcelable	onSaveInstanceState()
void	onScrollChanged(int l, int t, int oldl, int oldt)
void	onSizeChanged(int w, int h, int oldw, int oldh)

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 CONTENT_SENSITIVITY_AUTO = 0 static final int CONTENT_SENSITIVITY_NOT_SENSITIVE = 2 static final int CONTENT_SENSITIVITY_SENSITIVE = 1 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_SAME_APPLICATION = 4096 static final int DRAG_FLAG_GLOBAL_URI_READ = 1 static final int DRAG_FLAG_GLOBAL_URI_WRITE = 2 static final int DRAG_FLAG_HIDE_CALLING_TASK_ON_DRAG_START = 16384 static final int DRAG_FLAG_OPAQUE = 512 static final int DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG = 8192 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 float REQUESTED_FRAME_RATE_CATEGORY_DEFAULT static final float REQUESTED_FRAME_RATE_CATEGORY_HIGH = -4.0f static final float REQUESTED_FRAME_RATE_CATEGORY_LOW = -2.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NORMAL = -3.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE = -1.0f 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&