NestedScrolling 嵌套滑动

1. 实现 NestedScrollingParent

• 嵌套滑动的父 View，需要实现 NestedScrollingParent。
• 有些 View 官方已经实现了，如 NestedScrollView 已经实现了 NestedScrollingParent 和 NestedScrollingChild。RecyclerView 实现了 NestedScrollingChild ，等。
• 在此 View 中，包含一个 NestedScrollingParentHelper 辅助类。NestedScrollingParentHelper 接口的实现，基本上就是调用本 Helper 类的对应的函数即可，因为 Helper 类中已经实现好了 Child 和 Parent 交互的逻辑。原来的 View 的处理 Touch 事件，并实现滑动的逻辑大体上不需要改变。

public class ParentNestedScrollView extends NestedScrollView{

    private NestedScrollingParentHelper mParentHelper;

    public ParentNestedScrollView(Context context) {
        super(context);
        init();
    }

    public ParentNestedScrollView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init();
    }

    public ParentNestedScrollView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
    }

    private void init() {
        mParentHelper = new NestedScrollingParentHelper(this);
    }

    // 被 startNestedScroll触发回调
    @Override
    public boolean onStartNestedScroll(View child, View target, int nestedScrollAxes) {
        return (nestedScrollAxes & ViewCompat.SCROLL_AXIS_VERTICAL) != 0;
    }

    // onStartNestedScroll 后调用接受
    @Override
    public void onNestedScrollAccepted(View child, View target, int nestedScrollAxes) {
        mParentHelper.onNestedScrollAccepted(child, target, nestedScrollAxes);
    }

    // 被 stopNestedScroll 触发回调
    @Override
    public void onStopNestedScroll(View target) {
        mParentHelper.onStopNestedScroll(target);
    }
    
    // 被 dispatchNestedScroll 触发回调
    // target：子 View
    // dxConsumed，dyConsumed：子 View 消耗掉的滑动距离
    // dxUnconsumed，dyUnconsumed：子 View 未消耗，需要父 View 处理的滑动距离
    @Override
    public void onNestedScroll(View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed) {

    }

    // 被 dispatchNestedPreScroll 触发回调
    // target：子 View
    // dx，dy：滑动距离
    // int[] consumed：返回父 View 消耗掉的滑动距离
    @Override
    public void onNestedPreScroll(View target, int dx, int dy, int[] consumed) {

    }

    // 惯性滑动，调用类似 onNestedScroll
    @Override
    public boolean onNestedFling(View target, float velocityX, float velocityY, boolean consumed) {
        return super.onNestedFling(target,velocityX,velocityY,consumed);
    }

    // 惯性滑动，调用类似 onNestedPreScroll
    @Override
    public boolean onNestedPreFling(View target, float velocityX, float velocityY)  {
        return super.onNestedPreFling(target,velocityX,velocityY);
    }

    // 得到嵌套滑动方向
    @Override
    public int getNestedScrollAxes() {
        return mParentHelper.getNestedScrollAxes();
    }

2. 实现 NestedScrollingParent

• 嵌套滑动的子 View，需要实现 NestedScrollingChild。
• 同样包含一个 NestedScrollingChildHelper 辅助类。

public class ChildNestedScrollView extends NestedScrollView {

    private NestedScrollingChildHelper mChildHelper;

    public ChildNestedScrollView(Context context, AttributeSet attrs,
                                 int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
    }

    public ChildNestedScrollView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init();
    }

    public ChildNestedScrollView(Context context) {
        super(context);
        init();
    }

    private void init() {
        mChildHelper = new NestedScrollingChildHelper(this);
        setNestedScrollingEnabled(true);
    }

    @Override
    public void setNestedScrollingEnabled(boolean enabled) {
        // 这里不判断 null 可能会出错
        if (mChildHelper != null) {
            mChildHelper.setNestedScrollingEnabled(enabled);
        }
    }

    @Override
    public boolean isNestedScrollingEnabled() {
        return mChildHelper.isNestedScrollingEnabled();
    }

    @Override
    public boolean hasNestedScrollingParent() {
        return mChildHelper.hasNestedScrollingParent();
    }

    // 回调父 View 的 onStartNestedScroll
    // 一般在重写 onTouchEvent() 的 case ACTION_DOWN 时调用
    @Override
    public boolean startNestedScroll(int axes) {
        return mChildHelper.startNestedScroll(axes);
    }

    // 回调父 View 的 onStopNestedScroll
    // 一般在重写 onTouchEvent() 的 case ACTION_UP 时调用
    @Override
    public void stopNestedScroll() {
        mChildHelper.stopNestedScroll();
    }

    // 回调父 View 的 onNestedScroll
    // 一般在重写 onTouchEvent() 的 case ACTION_MOVE 时调用
    // 一般在子 view 处理 scroll “之后” 调用
    // dxConsumed，dyConsumed：子 View 消耗掉的滑动距离
    // dxUnconsumed，dyUnconsumed：子 View 未消耗，需要父 View 去处理的滑动距离
    // offsetInWindow：是个输出参数，表示子 View 相对父 View 的偏移
    @Override
    public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed,  int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) {
        return mChildHelper.dispatchNestedScroll(dxConsumed, dyConsumed,
                dxUnconsumed, dyUnconsumed, offsetInWindow);
    }

    // 回调父 View 的 onNestedPreScroll
    // 一般在重写 onTouchEvent() 的 case ACTION_MOVE 时调用
    // 一般在子 view 处理 scroll “之前” 调用
    // dx，dy：需要父 View 去处理的滑动距离
    // consumed：是个输出参数，表示父 View 消耗掉的滑动距离
    // offsetInWindow：是个输出参数，表示子 View 相对父 View 的偏移
    @Override
    public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) {
        return mChildHelper.dispatchNestedPreScroll(dx, dy,
                consumed, offsetInWindow);
    }

    // 惯性滑动，调用类似 dispatchNestedScroll
    @Override
    public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) {
        return mChildHelper.dispatchNestedFling(velocityX, velocityY,
                consumed);
    }

    // 惯性滑动，调用类似 dispatchNestedPreScroll
    @Override
    public boolean dispatchNestedPreFling(float velocityX, float velocityY) {
        return mChildHelper.dispatchNestedPreFling(velocityX, velocityY);
    }

3. 一般流程

4. 示例

在 limitY 之前父子一起滑动，limitY 之后，父 View 停止，子 View 自己滑动。再回到 limitY 之前，父子 View 继续一起滑动。

• 存在一个问题，只能处理滑动，不能进行 fling 惯性滑动。

父 View：

package com.ttt.nestedscrolltest;

import android.content.Context;
import android.support.v4.view.NestedScrollingParentHelper;
import android.support.v4.view.ViewCompat;
import android.support.v4.widget.NestedScrollView;
import android.util.AttributeSet;
import android.view.View;

public class ParentNestedScrollView extends NestedScrollView{

    private NestedScrollingParentHelper mParentHelper;
    private int limitY=500;
    private int moveY=0;
    private int[] outLocation=new int[2];

    public ParentNestedScrollView(Context context) {
        super(context);
        init();
    }

    public ParentNestedScrollView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init();
    }

    public ParentNestedScrollView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
    }

    private void init() {
        mParentHelper = new NestedScrollingParentHelper(this);
    }

    @Override
    public boolean onStartNestedScroll(View child, View target, int nestedScrollAxes) {
        return (nestedScrollAxes & ViewCompat.SCROLL_AXIS_VERTICAL) != 0;
    }
    @Override
    public void onNestedScrollAccepted(View child, View target, int nestedScrollAxes) {
        mParentHelper.onNestedScrollAccepted(child, target, nestedScrollAxes);
    }

    @Override
    public void onStopNestedScroll(View target) {
        mParentHelper.onStopNestedScroll(target);
    }

    @Override
    public void onNestedScroll(View target, int dxConsumed, int dyConsumed,
                               int dxUnconsumed, int dyUnconsumed) {

    }

    @Override
    public void onNestedPreScroll(View target, int dx, int dy, int[] consumed) {
        target.getLocationOnScreen(outLocation);
        moveY=outLocation[1];
        if(moveY-dy>=limitY){
            scrollBy(0, dy);
        }else {
            scrollBy(0, moveY-limitY);
        }
    }

    @Override
    public boolean onNestedFling(View target, float velocityX, float velocityY, boolean consumed) {
        return super.onNestedFling(target,velocityX,velocityY,consumed);
    }
    @Override
    public boolean onNestedPreFling(View target, float velocityX, float velocityY)  {
        return super.onNestedPreFling(target,velocityX,velocityY);
    }
    @Override
    public int getNestedScrollAxes() {
        return mParentHelper.getNestedScrollAxes();
    }
}

子 View：

package com.ttt.nestedscrolltest;

import android.content.Context;
import android.support.v4.view.NestedScrollingChildHelper;
import android.support.v4.view.ViewCompat;
import android.support.v4.widget.NestedScrollView;
import android.util.AttributeSet;
import android.util.Log;
import android.view.MotionEvent;

public class ChildNestedScrollView extends NestedScrollView {

    private NestedScrollingChildHelper mChildHelper;
    private int[] mConsumed = new int[2];
    private int[] mOffset = new int[2];
    private int[] outLocation = new int[2];
    private int startY;
    private int limitY = 500;
    private int moveY;
    private Boolean nestOn = true;


    public ChildNestedScrollView(Context context, AttributeSet attrs,
                                 int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
    }

    public ChildNestedScrollView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init();
    }

    public ChildNestedScrollView(Context context) {
        super(context);
        init();
    }

    private void init() {
        mChildHelper = new NestedScrollingChildHelper(this);
        setNestedScrollingEnabled(true);
    }

    @Override
    public void setNestedScrollingEnabled(boolean enabled) {
        if (mChildHelper != null) {
            mChildHelper.setNestedScrollingEnabled(enabled);
        }
    }

    @Override
    public boolean isNestedScrollingEnabled() {
        return mChildHelper.isNestedScrollingEnabled();
    }

    @Override
    public boolean startNestedScroll(int axes) {
        return mChildHelper.startNestedScroll(axes);
    }

    @Override
    public void stopNestedScroll() {
        mChildHelper.stopNestedScroll();
    }

    @Override
    public boolean hasNestedScrollingParent() {
        return mChildHelper.hasNestedScrollingParent();
    }

    @Override
    public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed,
                                        int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) {
        return mChildHelper.dispatchNestedScroll(dxConsumed, dyConsumed,
                dxUnconsumed, dyUnconsumed, offsetInWindow);
    }

    @Override
    public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) {
        return mChildHelper.dispatchNestedPreScroll(dx, dy,
                consumed, offsetInWindow);
    }

    @Override
    public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) {
        return mChildHelper.dispatchNestedFling(velocityX, velocityY,
                consumed);
    }

    @Override
    public boolean dispatchNestedPreFling(float velocityX, float velocityY) {
        return mChildHelper.dispatchNestedPreFling(velocityX, velocityY);
    }

    @Override
    public boolean onTouchEvent(MotionEvent event) {
        switch (event.getAction()) {
            case MotionEvent.ACTION_DOWN:
                startNestedScroll(ViewCompat.SCROLL_AXIS_VERTICAL);
                startY = (int) event.getRawY();
                break;
            case MotionEvent.ACTION_MOVE:
                int dY = startY - (int) event.getRawY();
                startY = (int) event.getRawY();
                getLocationOnScreen(outLocation);
                moveY = outLocation[1] - getScrollY();
                if (moveY > limitY) {
                    dispatchNestedPreScroll(0, dY, mConsumed, mOffset);
                } else if (moveY == limitY) {
                    nestOn = !nestOn;
                    if (nestOn) dispatchNestedPreScroll(0, dY, mConsumed, mOffset);
                    else scrollBy(0, dY);
                } else if (moveY < limitY) {
                    scrollBy(0, dY);
                }
                break;
            case MotionEvent.ACTION_UP:
                stopNestedScroll();
                break;
            default:
                break;
        }
        return true;
    }
}