NestedScrollingParent和NestedScrollingChild

前言:

NestedScrollingParent和NestedScrollingChild是辅助解决事件冲突出现的.在之前的事件拦截中,就算子View的ACTION_MOVE的事件返回false,父布局也是获取不了该事件的。

NestedScrollingChild的接口定义如下:

  public interface NestedScrollingChild {
    // 参数enabled:true表示view使用嵌套滚动,false表示禁用.
    public void setNestedScrollingEnabled(boolean enabled);

    public boolean isNestedScrollingEnabled();

    // 参数axes:表示滚动的方向如:ViewCompat.SCROLL_AXIS_VERTICAL(垂直方向滚动)和
    // ViewCompat.SCROLL_AXIS_HORIZONTAL(水平方向滚动)
    // 返回值:true表示本次滚动支持嵌套滚动,false不支持
    public boolean startNestedScroll(int axes);

    public void stopNestedScroll();

    public boolean hasNestedScrollingParent();

    // 参数dxConsumed: 表示view消费了x方向的距离长度
    // 参数dyConsumed: 表示view消费了y方向的距离长度
    // 参数dxUnconsumed: 表示滚动产生的x滚动距离还剩下多少没有消费
    // 参数dyUnconsumed: 表示滚动产生的y滚动距离还剩下多少没有消费
    // 参数offsetInWindow: 表示剩下的距离dxUnconsumed和dyUnconsumed使得view在父布局中的位置偏移了多少
    public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed,
            int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow);

    // 参数dx: 表示view本次x方向的滚动的总距离长度
    // 参数dy: 表示view本次y方向的滚动的总距离长度
    // 参数consumed: 表示父布局消费的距离,consumed[0]表示x方向,consumed[1]表示y方向
    // 参数offsetInWindow: 表示剩下的距离dxUnconsumed和dyUnconsumed使得view在父布局中的位置偏移了多少
    public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow);

    // 这个是滑动的就不详细分析了
    public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed);

    public boolean dispatchNestedPreFling(float velocityX, float velocityY);
}
  • setNestedScrollingEnabled 实现该结构的View要调用setNestedScrollingEnabled(true)才可以使用嵌套滚动.

  • isNestedScrollingEnabled判断当前view能否使用嵌套滚动.

  • startNestedScroll和stopNestedScroll.是配对使用的.startNestedScroll表示view开始滚动了,一般是在ACTION_DOWN中调用,如果返回true则表示父布局支持嵌套滚动.在事件结束比如ACTION_UP或者ACTION_CANCLE中调用stopNestedScroll,告诉父布局滚动结束.

  • dispatchNestedScroll,把view消费滚动距离之后,把剩下的滑动距离再次传给父布局.

  • dispatchNestedPreScroll,在view消费滚动距离之前把总得滑动距离传给父布局.

  • dispatchNestedFling和dispatchNestedPreFling就是view传递滑动的信息给父布局的.

NestedScrollingParent接口的定义如下:

public interface NestedScrollingParent {
    /**
     * 有嵌套滑动到来了,问下该父View是否接受嵌套滑动
     * @param child 嵌套滑动对应的父类的子类(因为嵌套滑动对于的父View不一定是一级就能找到的,可能挑了两级父View的父View,child的辈分>=target)
     * @param target 具体嵌套滑动的那个子类
     * @param nestedScrollAxes 支持嵌套滚动轴。水平方向,垂直方向,或者不指定
     * @return 是否接受该嵌套滑动
     */
    public boolean onStartNestedScroll(View child, View target, int nestedScrollAxes);

    /**
     * 该父View接受了嵌套滑动的请求该函数调用。onStartNestedScroll返回true该函数会被调用。
     * 参数和onStartNestedScroll一样
     */
    public void onNestedScrollAccepted(View child, View target, int nestedScrollAxes);

    /**
     * 停止嵌套滑动
     * @param target 具体嵌套滑动的那个子类
     */
    public void onStopNestedScroll(View target);

    /**
     * 嵌套滑动的子View在滑动之后报告过来的滑动情况
     *
     * @param target 具体嵌套滑动的那个子类
     * @param dxConsumed 水平方向嵌套滑动的子View滑动的距离(消耗的距离)
     * @param dyConsumed 垂直方向嵌套滑动的子View滑动的距离(消耗的距离)
     * @param dxUnconsumed 水平方向嵌套滑动的子View未滑动的距离(未消耗的距离)
     * @param dyUnconsumed 垂直方向嵌套滑动的子View未滑动的距离(未消耗的距离)
     */
    public void onNestedScroll(View target, int dxConsumed, int dyConsumed,
                               int dxUnconsumed, int dyUnconsumed);

    /**
     * 在嵌套滑动的子View未滑动之前告诉过来的准备滑动的情况
     * @param target 具体嵌套滑动的那个子类
     * @param dx 水平方向嵌套滑动的子View想要变化的距离
     * @param dy 垂直方向嵌套滑动的子View想要变化的距离
     * @param consumed 这个参数要我们在实现这个函数的时候指定,回头告诉子View当前父View消耗的距离 
     *                    consumed[0] 水平消耗的距离,consumed[1] 垂直消耗的距离 好让子view做出相应的调整
     */
    public void onNestedPreScroll(View target, int dx, int dy, int[] consumed);

    /**
     * 嵌套滑动的子View在fling之后报告过来的fling情况
     * @param target 具体嵌套滑动的那个子类
     * @param velocityX 水平方向速度
     * @param velocityY 垂直方向速度
     * @param consumed 子view是否fling了
     * @return true 父View是否消耗了fling
     */
    public boolean onNestedFling(View target, float velocityX, float velocityY, boolean consumed);

    /**
     * 在嵌套滑动的子View未fling之前告诉过来的准备fling的情况
     * @param target 具体嵌套滑动的那个子类
     * @param velocityX 水平方向速度
     * @param velocityY 垂直方向速度
     * @return true 父View是否消耗了fling
     */
    public boolean onNestedPreFling(View target, float velocityX, float velocityY);

    /**
     * 获取嵌套滑动的轴
     * @see ViewCompat#SCROLL_AXIS_HORIZONTAL 垂直
     * @see ViewCompat#SCROLL_AXIS_VERTICAL 水平
     * @see ViewCompat#SCROLL_AXIS_NONE 都支持
     */
    public int getNestedScrollAxes();
}
  • onStartNestedScroll.当子view的调用NestedScrollingChild的方法startNestedScroll时,会调用该方法.

  • onNestedScrollAccepted.如果onStartNestedScroll方法返回的是true的话,那么紧接着就会调用该方法.它是让嵌套滚动在开始滚动之前,让布局容器(viewGroup)或者它的父类执行一些配置的初始化的.下面是原文:
    (It offers an opportunity for the view and its superclasses to perform initial configuration for the nested scroll.)

  • onStopNestedScroll停止滚动了,当子view调用stopNestedScroll时会调用该方法.

  • onNestedScroll,当子view调用dispatchNestedScroll方法时,会调用该方法.

  • onNestedPreScroll,当子view调用dispatchNestedPreScroll方法是,会调用该方法.

  • dispatchNestedFling和dispatchNestedPreFling对应的就是滑动了.

code :

father:
@SuppressLint("NewApi") public class NestScrollingLayout extends FrameLayout implements NestedScrollingParent{
    
    private static final String TAG = "NestScrollingLayout";
    
    private  NestedScrollingParentHelper mParentHelper;
    
    public NestScrollingLayout(Context context, AttributeSet attrs,
            int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
    }

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

    public NestScrollingLayout(Context context) {
        super(context);
        init();
        
    }
    
    
    @SuppressLint("NewApi") private void init() {
         mParentHelper = new NestedScrollingParentHelper(this);
    }
    @Override
    public boolean onStartNestedScroll(View child, View target, int nestedScrollAxes) {
        
        Log.d(TAG, "child==target:" + (child == target));
        
        Log.d(TAG, "----父布局onStartNestedScroll----------------target:" + target + ",----+++this:" + this);
             
         return (nestedScrollAxes & ViewCompat.SCROLL_AXIS_VERTICAL) != 0;
    }
    @SuppressLint("NewApi") @Override
    public void onNestedScrollAccepted(View child, View target, int nestedScrollAxes) {
        
        Log.d(TAG, "----父布局onNestedScrollAccepted---------------");
        
        mParentHelper.onNestedScrollAccepted(child, target, nestedScrollAxes);
    }
    
    @Override
    public void onStopNestedScroll(View target) {       
        Log.d(TAG, "----父布局onStopNestedScroll----------------");
        mParentHelper.onStopNestedScroll(target);
    }
    // 剩余没有消费的
    @Override
    public void onNestedScroll(View target, int dxConsumed, int dyConsumed,
            int dxUnconsumed, int dyUnconsumed) {
        Log.d(TAG, "----父布局onNestedScroll----------------");
    }
    
    @Override
    public void onNestedPreScroll(View target, int dx, int dy, int[] consumed) {
        // 这里要消费的
        
        scrollBy(0, -dy);
        
        consumed[0] = 0;
        
        consumed[1] = 10;
        Log.d(TAG, "----父布局onNestedPreScroll----------------");
    }
    
    @Override
    public boolean onNestedFling(View target, float velocityX, float velocityY, boolean consumed) {
        Log.d(TAG, "----父布局onNestedFling----------------");
        return true;
    }
    @Override
    public boolean onNestedPreFling(View target, float velocityX, float velocityY)  {
        Log.d(TAG, "----父布局onNestedPreFling----------------");
        return true;
    }
    @Override
    public int getNestedScrollAxes() {
        Log.d(TAG, "----父布局getNestedScrollAxes----------------");
         return mParentHelper.getNestedScrollAxes();
    }
    
}
children:
public class NestScrollingView extends View implements NestedScrollingChild{

    private static final String TAG = "NestScrollingView";
    
    private NestedScrollingChildHelper mChildHelper;
    
    private int[] mConsumed = new int[2];
    
    private int[] mOffset = new int[2];
    
    public NestScrollingView(Context context, AttributeSet attrs,
            int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
        
    }
    
    public NestScrollingView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init();
    }

    public NestScrollingView(Context context) {
        super(context);
        init();
        

    }
    
    private void init() {
        mChildHelper = new NestedScrollingChildHelper(this);
        setNestedScrollingEnabled(true);
    }
    
    @Override
    public void setNestedScrollingEnabled(boolean enabled) {
        mChildHelper.setNestedScrollingEnabled(enabled);
    }
    @Override
    public boolean isNestedScrollingEnabled() {
        return mChildHelper.isNestedScrollingEnabled();
    }
    @Override
    public boolean startNestedScroll(int axes) {
        Log.d(TAG, "-----------startNestedScroll 子View开始滚动---------------");
        return mChildHelper.startNestedScroll(axes);
    }
    @Override
    public void stopNestedScroll() {
        Log.d(TAG, "-----------stopNestedScroll 子View停止滚动---------------");
        mChildHelper.stopNestedScroll();
    }
    @Override
    public boolean hasNestedScrollingParent() {
        return mChildHelper.hasNestedScrollingParent();
    }
    @Override
     public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed,
                int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) {
        Log.d(TAG, "-----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------");
        
        return mChildHelper.dispatchNestedScroll(dxConsumed,dyConsumed,
                dxUnconsumed,dyUnconsumed,offsetInWindow);
    }
    @Override
     public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) {
        Log.d(TAG, "-----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------");
        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);
            break;
        case MotionEvent.ACTION_MOVE:
            
            dispatchNestedPreScroll(0,20,mConsumed,mOffset);

            Log.d(TAG, "offset--x:" + mOffset[0] + ",offset--y:" + mOffset[1]);
            dispatchNestedScroll(50,50,50,50,mOffset);
                    
            break;
        case MotionEvent.ACTION_UP:
            stopNestedScroll();
            break;
        default:
            break;
        }
        return true;
    }
    
}
log:
D/NestScrollingView(12088): -----------stopNestedScroll 子View停止滚动---------------
D/NestScrollingView(12088): -----------startNestedScroll 子View开始滚动---------------
D/NestScrollingLayout(12088): child==target:true
D/NestScrollingLayout(12088): ----父布局onStartNestedScroll----------------target:com.yluo.testnestscrolling.NestScrollingView
D/NestScrollingLayout(12088): ----父布局onNestedScrollAccepted---------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------dispatchNestedPreScroll 子View把总的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedPreScroll----------------
D/NestScrollingView(12088): offset--x:0,offset--y:20
D/NestScrollingView(12088): -----------dispatchNestedScroll 子View把剩余的滚动距离传给父布局---------------
D/NestScrollingLayout(12088): ----父布局onNestedScroll----------------
D/NestScrollingView(12088): -----------stopNestedScroll 子View停止滚动---------------
D/NestScrollingLayout(12088): ----父布局onStopNestedScroll----------------
D/NestScrollingView(12088): -----------stopNestedScroll 子View停止滚动---------------

result:
--------------子View开始滚动------------------
----父布局onStartNestedScroll----------------
----父布局onNestedScrollAccepted---------------
-----------子View把总的滚动距离传给父布局--------
----父布局onNestedPreScroll----------------
---offset--x:0,offset--y:20
-----------子View把剩余的滚动距离传给父布局-------
----父布局onNestedScroll----------------
-----------子View停止滚动---------------
----父布局onStopNestedScroll----------------

你可能感兴趣的:(NestedScrollingParent和NestedScrollingChild)