10e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam/* 20e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * Copyright (C) 2016 The Android Open Source Project 30e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * 40e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * Licensed under the Apache License, Version 2.0 (the "License"); 50e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * you may not use this file except in compliance with the License. 60e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * You may obtain a copy of the License at 70e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * 80e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * http://www.apache.org/licenses/LICENSE-2.0 90e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * 100e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * Unless required by applicable law or agreed to in writing, software 110e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * distributed under the License is distributed on an "AS IS" BASIS, 120e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 130e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * See the License for the specific language governing permissions and 140e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * limitations under the License. 150e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam */ 160e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 170e9b312956dd28cef21473337800919eb0a54b2dMaurice Lampackage com.android.setupwizardlib.view; 180e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 190e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.annotation.TargetApi; 200e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.content.Context; 210e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.graphics.Canvas; 220e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.graphics.RectF; 230e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.os.Build; 240e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.util.AttributeSet; 250e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.view.MotionEvent; 260e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.view.View; 270e9b312956dd28cef21473337800919eb0a54b2dMaurice Lamimport android.view.WindowInsets; 280e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 290e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam/** 300e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * This class provides sticky header functionality in a recycler view, to use with 310e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * SetupWizardIllustration. To use this, add a header tagged with "sticky". The header will continue 320e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * to be drawn when the sticky element hits the top of the view. 330e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * 340e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * <p>There are a few things to note: 350e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * <ol> 360e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * <li>The view does not work well with padding. b/16190933 370e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * <li>If fitsSystemWindows is true, then this will offset the sticking position by the height of 380e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * the system decorations at the top of the screen. 390e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam * </ol> 400e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam */ 410e9b312956dd28cef21473337800919eb0a54b2dMaurice Lampublic class StickyHeaderRecyclerView extends HeaderRecyclerView { 420e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 430e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam private View mSticky; 440e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam private int mStatusBarInset = 0; 450e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam private RectF mStickyRect = new RectF(); 460e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 470e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public StickyHeaderRecyclerView(Context context) { 480e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam super(context); 490e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 500e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 510e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public StickyHeaderRecyclerView(Context context, AttributeSet attrs) { 520e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam super(context, attrs); 530e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 540e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 550e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public StickyHeaderRecyclerView(Context context, AttributeSet attrs, int defStyleAttr) { 560e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam super(context, attrs, defStyleAttr); 570e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 580e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 590e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam @Override 600e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam protected void onLayout(boolean changed, int l, int t, int r, int b) { 610e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam super.onLayout(changed, l, t, r, b); 620e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (mSticky == null) { 630e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam updateStickyView(); 640e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 650e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (mSticky != null) { 660e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final View headerView = getHeader(); 670e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (headerView != null && headerView.getHeight() == 0) { 680e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam headerView.layout(0, -headerView.getMeasuredHeight(), 690e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam headerView.getMeasuredWidth(), 0); 700e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 710e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 720e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 730e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 740e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam @Override 750e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam protected void onMeasure(int widthSpec, int heightSpec) { 760e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam super.onMeasure(widthSpec, heightSpec); 770e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (mSticky != null) { 780e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam measureChild(getHeader(), widthSpec, heightSpec); 790e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 800e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 810e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 820e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public void updateStickyView() { 830e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final View header = getHeader(); 840e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (header != null) { 850e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam mSticky = header.findViewWithTag("sticky"); 860e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 870e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 880e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 890e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam @Override 900e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public void draw(Canvas canvas) { 910e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam super.draw(canvas); 920e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (mSticky != null) { 930e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final View headerView = getHeader(); 940e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final int saveCount = canvas.save(); 950e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam // The view to draw when sticking to the top 960e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final View drawTarget = headerView != null ? headerView : mSticky; 970e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam // The offset to draw the view at when sticky 980e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final int drawOffset = headerView != null ? mSticky.getTop() : 0; 990e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam // Position of the draw target, relative to the outside of the scrollView 1000e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam final int drawTop = drawTarget.getTop(); 1010e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (drawTop + drawOffset < mStatusBarInset || !drawTarget.isShown()) { 1020e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam // RecyclerView does not translate the canvas, so we can simply draw at the top 1030e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam mStickyRect.set(0, -drawOffset + mStatusBarInset, drawTarget.getWidth(), 1040e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam drawTarget.getHeight() - drawOffset + mStatusBarInset); 1050e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam canvas.translate(0, mStickyRect.top); 1060e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam canvas.clipRect(0, 0, drawTarget.getWidth(), drawTarget.getHeight()); 1070e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam drawTarget.draw(canvas); 1080e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } else { 1090e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam mStickyRect.setEmpty(); 1100e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1110e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam canvas.restoreToCount(saveCount); 1120e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1130e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1140e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 1150e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam @Override 1160e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam @TargetApi(Build.VERSION_CODES.LOLLIPOP) 1170e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public WindowInsets onApplyWindowInsets(WindowInsets insets) { 1180e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (getFitsSystemWindows()) { 1190e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam mStatusBarInset = insets.getSystemWindowInsetTop(); 1200e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam insets.replaceSystemWindowInsets( 1210e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam insets.getSystemWindowInsetLeft(), 1220e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 0, /* top */ 1230e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam insets.getSystemWindowInsetRight(), 1240e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam insets.getSystemWindowInsetBottom() 1250e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam ); 1260e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1270e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam return insets; 1280e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1290e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam 1300e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam @Override 1310e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam public boolean dispatchTouchEvent(MotionEvent ev) { 1320e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam if (mStickyRect.contains(ev.getX(), ev.getY())) { 1330e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam ev.offsetLocation(-mStickyRect.left, -mStickyRect.top); 1340e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam return getHeader().dispatchTouchEvent(ev); 1350e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } else { 1360e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam return super.dispatchTouchEvent(ev); 1370e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1380e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam } 1390e9b312956dd28cef21473337800919eb0a54b2dMaurice Lam} 140