Skip to content

Most visited

Recently visited

navigation
added in version 22.1.0
belongs to Maven artifact com.android.support:support-core-ui:27.0.0

NestedScrollView

public class NestedScrollView
extends FrameLayout implements NestedScrollingParent, NestedScrollingChild2, ScrollingView

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ android.support.v4.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 classes

interface NestedScrollView.OnScrollChangeListener

Interface definition for a callback to be invoked when the scroll X or Y positions of a view change. 

Inherited constants

From class android.view.ViewGroup
From class android.view.View

Inherited fields

From class android.view.View

Public constructors

NestedScrollView(Context context)
NestedScrollView(Context context, AttributeSet attrs)
NestedScrollView(Context context, AttributeSet attrs, int defStyleAttr)

Public methods

void addView(View child, int index)
void addView(View child, ViewGroup.LayoutParams params)
void addView(View child, int index, ViewGroup.LayoutParams params)
void addView(View child)
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, int[] consumed, int[] offsetInWindow)
boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, 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, int[] offsetInWindow, int type)

Dispatch one step of a nested scroll in progress.

boolean dispatchNestedScroll(int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow)
void draw(Canvas canvas)
boolean executeKeyEvent(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(MotionEvent event)
boolean onInterceptTouchEvent(MotionEvent ev)
boolean onNestedFling(View target, float velocityX, float velocityY, boolean consumed)
boolean onNestedPreFling(View target, float velocityX, float velocityY)
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 nestedScrollAxes)
boolean onStartNestedScroll(View child, View target, int nestedScrollAxes)
void onStopNestedScroll(View target)
boolean onTouchEvent(MotionEvent ev)
boolean pageScroll(int direction)

Handles scrolling in response to a "page up/down" shortcut press.

void requestChildFocus(View child, View focused)
boolean requestChildRectangleOnScreen(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(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(int, int), but scroll smoothly instead of immediately.

final void smoothScrollTo(int x, int y)

Like scrollTo(int, int), but scroll smoothly instead of immediately.

boolean startNestedScroll(int axes, int type)

Begin a nestable scroll operation along the given axes, for the given input type.

boolean startNestedScroll(int axes)
void stopNestedScroll(int type)

Stop a nested scroll in progress for the given input type.

void stopNestedScroll()

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(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)
Parcelable onSaveInstanceState()
void onScrollChanged(int l, int t, int oldl, int oldt)
void onSizeChanged(int w, int h, int oldw, int oldh)

Inherited methods

From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.view.ViewParent
From interface android.view.ViewManager
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource
From interface android.support.v4.view.NestedScrollingParent
From interface android.support.v4.view.NestedScrollingChild2
From interface android.support.v4.view.ScrollingView
From interface android.support.v4.view.NestedScrollingChild

Public constructors

NestedScrollView

added in version 22.1.0
NestedScrollView (Context context)

Parameters
context Context

NestedScrollView

added in version 22.1.0
NestedScrollView (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

NestedScrollView

added in version 22.1.0
NestedScrollView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

Public methods

addView

void addView (View child, 
                int index)

Parameters
child View

index int

addView

void addView (View child, 
                ViewGroup.LayoutParams params)

Parameters
child View

params ViewGroup.LayoutParams

addView

void addView (View child, 
                int index, 
                ViewGroup.LayoutParams params)

Parameters
child View

index int

params ViewGroup.LayoutParams

addView

void addView (View child)

Parameters
child View

arrowScroll

added in version 22.1.0
boolean arrowScroll (int direction)

Handle scrolling in response to an up or down arrow click.

Parameters
direction int: The direction corresponding to the arrow key that was pressed

Returns
boolean True if we consumed the event, false otherwise

computeScroll

void computeScroll ()

dispatchKeyEvent

boolean dispatchKeyEvent (KeyEvent event)

Parameters
event KeyEvent

Returns
boolean

dispatchNestedFling

boolean dispatchNestedFling (float velocityX, 
                float velocityY, 
                boolean consumed)

Parameters
velocityX float

velocityY float

consumed boolean

Returns
boolean

dispatchNestedPreFling

boolean dispatchNestedPreFling (float velocityX, 
                float velocityY)

Parameters
velocityX float

velocityY float

Returns
boolean

dispatchNestedPreScroll

boolean dispatchNestedPreScroll (int dx, 
                int dy, 
                int[] consumed, 
                int[] offsetInWindow)

Parameters
dx int

dy int

consumed int

offsetInWindow int

Returns
boolean

dispatchNestedPreScroll

added in version 26.1.0
boolean dispatchNestedPreScroll (int dx, 
                int dy, 
                int[] consumed, 
                int[] offsetInWindow, 
                int type)

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.

Nested pre-scroll events are to nested scroll events what touch intercept is to touch. dispatchNestedPreScroll offers an opportunity for the parent view in a nested scrolling operation to consume some or all of the scroll operation before the child view consumes it.

Parameters
dx int: Horizontal scroll distance in pixels

dy int: Vertical scroll distance in pixels

consumed int: Output. If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy.

offsetInWindow int: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.

type int: the type of input which cause this scroll event

Returns
boolean true if the parent consumed some or all of the scroll delta

dispatchNestedScroll

added in version 26.1.0
boolean dispatchNestedScroll (int dxConsumed, 
                int dyConsumed, 
                int dxUnconsumed, 
                int dyUnconsumed, 
                int[] offsetInWindow, 
                int type)

Dispatch one step of a nested scroll in progress.

Implementations of views that support nested scrolling should call this to report info about a scroll in progress to the current nested scrolling parent. If a nested scroll is not currently in progress or nested scrolling is not enabled for this view this method does nothing.

Compatible View implementations should also call dispatchNestedPreScroll before consuming a component of the scroll event themselves.

Parameters
dxConsumed int: Horizontal distance in pixels consumed by this view during this scroll step

dyConsumed int: Vertical distance in pixels consumed by this view during this scroll step

dxUnconsumed int: Horizontal scroll distance in pixels not consumed by this view

dyUnconsumed int: Horizontal scroll distance in pixels not consumed by this view

offsetInWindow int: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.

type int: the type of input which cause this scroll event

Returns
boolean true if the event was dispatched, false if it could not be dispatched.

dispatchNestedScroll

boolean dispatchNestedScroll (int dxConsumed, 
                int dyConsumed, 
                int dxUnconsumed, 
                int dyUnconsumed, 
                int[] offsetInWindow)

Parameters
dxConsumed int

dyConsumed int

dxUnconsumed int

dyUnconsumed int

offsetInWindow int

Returns
boolean

draw

void draw (Canvas canvas)

Parameters
canvas Canvas

executeKeyEvent

added in version 22.1.0
boolean executeKeyEvent (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.

Parameters
event KeyEvent: The key event to execute.

Returns
boolean Return true if the event was handled, else false.

fling

added in version 22.1.0
void fling (int velocityY)

Fling the scroll view

Parameters
velocityY int: The initial velocity in the Y direction. Positive numbers mean that the finger/cursor is moving down the screen, which means we want to scroll towards the top.

fullScroll

added in version 22.1.0
boolean fullScroll (int direction)

Handles scrolling in response to a "home/end" shortcut press. This method will scroll the view to the top or bottom and give the focus to the topmost/bottommost component in the new visible area. If no component is a good candidate for focus, this scrollview reclaims the focus.

Parameters
direction int: the scroll direction: FOCUS_UP to go the top of the view or FOCUS_DOWN to go the bottom

Returns
boolean true if the key event is consumed by this method, false otherwise

getMaxScrollAmount

added in version 22.1.0
int getMaxScrollAmount ()

Returns
int The maximum amount this scroll view will scroll in response to an arrow event.

getNestedScrollAxes

int getNestedScrollAxes ()

Returns
int

hasNestedScrollingParent

boolean hasNestedScrollingParent ()

Returns
boolean

hasNestedScrollingParent

added in version 26.1.0
boolean hasNestedScrollingParent (int type)

Returns true if this view has a nested scrolling parent for the given input type.

The presence of a nested scrolling parent indicates that this view has initiated a nested scroll and it was accepted by an ancestor view further up the view hierarchy.

Parameters
type int: the type of input which cause this scroll event

Returns
boolean whether this view has a nested scrolling parent

isFillViewport

added in version 22.1.0
boolean isFillViewport ()

Indicates whether this ScrollView's content is stretched to fill the viewport.

Returns
boolean True if the content fills the viewport, false otherwise.

isNestedScrollingEnabled

boolean isNestedScrollingEnabled ()

Returns
boolean

isSmoothScrollingEnabled

added in version 22.1.0
boolean isSmoothScrollingEnabled ()

Returns
boolean Whether arrow scrolling will animate its transition.

onAttachedToWindow

added in version 22.1.0
void onAttachedToWindow ()

onGenericMotionEvent

boolean onGenericMotionEvent (MotionEvent event)

Parameters
event MotionEvent

Returns
boolean

onInterceptTouchEvent

boolean onInterceptTouchEvent (MotionEvent ev)

Parameters
ev MotionEvent

Returns
boolean

onNestedFling

boolean onNestedFling (View target, 
                float velocityX, 
                float velocityY, 
                boolean consumed)

Parameters
target View

velocityX float

velocityY float

consumed boolean

Returns
boolean

onNestedPreFling

boolean onNestedPreFling (View target, 
                float velocityX, 
                float velocityY)

Parameters
target View

velocityX float

velocityY float

Returns
boolean

onNestedPreScroll

void onNestedPreScroll (View target, 
                int dx, 
                int dy, 
                int[] consumed)

Parameters
target View

dx int

dy int

consumed int

onNestedScroll

void onNestedScroll (View target, 
                int dxConsumed, 
                int dyConsumed, 
                int dxUnconsumed, 
                int dyUnconsumed)

Parameters
target View

dxConsumed int

dyConsumed int

dxUnconsumed int

dyUnconsumed int

onNestedScrollAccepted

void onNestedScrollAccepted (View child, 
                View target, 
                int nestedScrollAxes)

Parameters
child View

target View

nestedScrollAxes int

onStartNestedScroll

boolean onStartNestedScroll (View child, 
                View target, 
                int nestedScrollAxes)

Parameters
child View

target View

nestedScrollAxes int

Returns
boolean

onStopNestedScroll

void onStopNestedScroll (View target)

Parameters
target View

onTouchEvent

boolean onTouchEvent (MotionEvent ev)

Parameters
ev MotionEvent

Returns
boolean

pageScroll

added in version 22.1.0
boolean pageScroll (int direction)

Handles scrolling in response to a "page up/down" shortcut press. This method will scroll the view by one page up or down and give the focus to the topmost/bottommost component in the new visible area. If no component is a good candidate for focus, this scrollview reclaims the focus.

Parameters
direction int: the scroll direction: FOCUS_UP to go one page up or FOCUS_DOWN to go one page down

Returns
boolean true if the key event is consumed by this method, false otherwise

requestChildFocus

void requestChildFocus (View child, 
                View focused)

Parameters
child View

focused View

requestChildRectangleOnScreen

boolean requestChildRectangleOnScreen (View child, 
                Rect rectangle, 
                boolean immediate)

Parameters
child View

rectangle Rect

immediate boolean

Returns
boolean

requestDisallowInterceptTouchEvent

void requestDisallowInterceptTouchEvent (boolean disallowIntercept)

Parameters
disallowIntercept boolean

requestLayout

void requestLayout ()

scrollTo

void scrollTo (int x, 
                int y)

This version also clamps the scrolling to the bounds of our child.

Parameters
x int

y int

setFillViewport

added in version 22.1.0
void setFillViewport (boolean fillViewport)

Set whether this ScrollView should stretch its content height to fill the viewport or not.

Parameters
fillViewport boolean: True to stretch the content's height to the viewport's boundaries, false otherwise.

setNestedScrollingEnabled

void setNestedScrollingEnabled (boolean enabled)

Parameters
enabled boolean

setOnScrollChangeListener

added in version 24.1.0
void setOnScrollChangeListener (NestedScrollView.OnScrollChangeListener l)

Register a callback to be invoked when the scroll X or Y positions of this view change.

This version of the method works on all versions of Android, back to API v4.

Parameters
l NestedScrollView.OnScrollChangeListener: The listener to notify when the scroll X or Y position changes.

See also:

setSmoothScrollingEnabled

added in version 22.1.0
void setSmoothScrollingEnabled (boolean smoothScrollingEnabled)

Set whether arrow scrolling will animate its transition.

Parameters
smoothScrollingEnabled boolean: whether arrow scrolling will animate its transition

shouldDelayChildPressedState

boolean shouldDelayChildPressedState ()

Returns
boolean

smoothScrollBy

added in version 22.1.0
void smoothScrollBy (int dx, 
                int dy)

Like scrollBy(int, int), but scroll smoothly instead of immediately.

Parameters
dx int: the number of pixels to scroll by on the X axis

dy int: the number of pixels to scroll by on the Y axis

smoothScrollTo

added in version 22.1.0
void smoothScrollTo (int x, 
                int y)

Like scrollTo(int, int), but scroll smoothly instead of immediately.

Parameters
x int: the position where to scroll on the X axis

y int: the position where to scroll on the Y axis

startNestedScroll

added in version 26.1.0
boolean startNestedScroll (int axes, 
                int type)

Begin a nestable scroll operation along the given axes, for the given input type.

A view starting a nested scroll promises to abide by the following contract:

The view will call startNestedScroll upon initiating a scroll operation. In the case of a touch scroll type this corresponds to the initial ACTION_DOWN. In the case of touch scrolling the nested scroll will be terminated automatically in the same manner as requestDisallowInterceptTouchEvent(boolean). In the event of programmatic scrolling the caller must explicitly call stopNestedScroll(int) to indicate the end of the nested scroll.

If startNestedScroll returns true, a cooperative parent was found. If it returns false the caller may ignore the rest of this contract until the next scroll. Calling startNestedScroll while a nested scroll is already in progress will return true.

At each incremental step of the scroll the caller should invoke dispatchNestedPreScroll once it has calculated the requested scrolling delta. If it returns true the nested scrolling parent at least partially consumed the scroll and the caller should adjust the amount it scrolls by.

After applying the remainder of the scroll delta the caller should invoke dispatchNestedScroll, passing both the delta consumed and the delta unconsumed. A nested scrolling parent may treat these values differently. See onNestedScroll(View, int, int, int, int, int).

Parameters
axes int: Flags consisting of a combination of SCROLL_AXIS_HORIZONTAL and/or SCROLL_AXIS_VERTICAL.

type int: the type of input which cause this scroll event

Returns
boolean true if a cooperative parent was found and nested scrolling has been enabled for the current gesture.

startNestedScroll

boolean startNestedScroll (int axes)

Parameters
axes int

Returns
boolean

stopNestedScroll

added in version 26.1.0
void stopNestedScroll (int type)

Stop a nested scroll in progress for the given input type.

Calling this method when a nested scroll is not currently in progress is harmless.

Parameters
type int: the type of input which cause this scroll event

stopNestedScroll

void stopNestedScroll ()

Protected methods

computeScrollDeltaToGetChildRectOnScreen

added in version 22.1.0
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).

Parameters
rect Rect: The rect.

Returns
int The scroll delta.

getBottomFadingEdgeStrength

float getBottomFadingEdgeStrength ()

Returns
float

getTopFadingEdgeStrength

float getTopFadingEdgeStrength ()

Returns
float

measureChild

void measureChild (View child, 
                int parentWidthMeasureSpec, 
                int parentHeightMeasureSpec)

Parameters
child View

parentWidthMeasureSpec int

parentHeightMeasureSpec int

measureChildWithMargins

void measureChildWithMargins (View child, 
                int parentWidthMeasureSpec, 
                int widthUsed, 
                int parentHeightMeasureSpec, 
                int heightUsed)

Parameters
child View

parentWidthMeasureSpec int

widthUsed int

parentHeightMeasureSpec int

heightUsed int

onLayout

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

Parameters
changed boolean

l int

t int

r int

b int

onMeasure

void onMeasure (int widthMeasureSpec, 
                int heightMeasureSpec)

Parameters
widthMeasureSpec int

heightMeasureSpec int

onOverScrolled

void onOverScrolled (int scrollX, 
                int scrollY, 
                boolean clampedX, 
                boolean clampedY)

Parameters
scrollX int

scrollY int

clampedX boolean

clampedY boolean

onRequestFocusInDescendants

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. This is more expensive than the default ViewGroup implementation, otherwise this behavior might have been made the default.

Parameters
direction int

previouslyFocusedRect Rect

Returns
boolean

onRestoreInstanceState

void onRestoreInstanceState (Parcelable state)

Parameters
state Parcelable

onSaveInstanceState

Parcelable onSaveInstanceState ()

Returns
Parcelable

onScrollChanged

void onScrollChanged (int l, 
                int t, 
                int oldl, 
                int oldt)

Parameters
l int

t int

oldl int

oldt int

onSizeChanged

void onSizeChanged (int w, 
                int h, 
                int oldw, 
                int oldh)

Parameters
w int

h int

oldw int

oldh int

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)