AppBarLayout.java revision 72a0913607198c5ce3fa351242ccbdfb3b93f178
1a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes/* 2a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Copyright (C) 2015 The Android Open Source Project 3a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 4a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Licensed under the Apache License, Version 2.0 (the "License"); 5a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * you may not use this file except in compliance with the License. 6a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * You may obtain a copy of the License at 7a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 8a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * http://www.apache.org/licenses/LICENSE-2.0 9a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 10a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Unless required by applicable law or agreed to in writing, software 11a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * distributed under the License is distributed on an "AS IS" BASIS, 12a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * See the License for the specific language governing permissions and 14a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * limitations under the License. 15a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 16a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 17a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banespackage android.support.design.widget; 18a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 19a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.content.Context; 20a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.content.res.TypedArray; 21e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banesimport android.os.Parcel; 22e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banesimport android.os.Parcelable; 2350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banesimport android.support.annotation.IntDef; 2472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banesimport android.support.annotation.NonNull; 2572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banesimport android.support.annotation.Nullable; 26a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.support.design.R; 27a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.support.v4.view.ViewCompat; 286ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banesimport android.support.v4.view.WindowInsetsCompat; 29a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.util.AttributeSet; 30a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.view.View; 31a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.view.ViewGroup; 32a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.view.animation.Interpolator; 33a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport android.widget.LinearLayout; 34a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 3550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banesimport java.lang.annotation.Retention; 3650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banesimport java.lang.annotation.RetentionPolicy; 37d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banesimport java.lang.ref.WeakReference; 38631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banesimport java.util.ArrayList; 39a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banesimport java.util.List; 40a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 41a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes/** 42a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * AppBarLayout is a vertical {@link LinearLayout} which implements many of the features of 439fb154338a62edc2c57dc036895199d6f1769400Chris Banes * material designs app bar concept, namely scrolling gestures. 44a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <p> 45a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Children should provide their desired scrolling behavior through 46a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * {@link LayoutParams#setScrollFlags(int)} and the associated layout xml attribute: 47a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * {@code app:layout_scrollFlags}. 48a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 49a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <p> 50a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * This view depends heavily on being used as a direct child within a {@link CoordinatorLayout}. 51a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * If you use AppBarLayout within a different {@link ViewGroup}, most of it's functionality will 52a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * not work. 53a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <p> 549fb154338a62edc2c57dc036895199d6f1769400Chris Banes * AppBarLayout also requires a separate scrolling sibling in order to know when to scroll. 559fb154338a62edc2c57dc036895199d6f1769400Chris Banes * The binding is done through the {@link ScrollingViewBehavior} behavior class, meaning that you 569fb154338a62edc2c57dc036895199d6f1769400Chris Banes * should set your scrolling view's behavior to be an instance of {@link ScrollingViewBehavior}. 579fb154338a62edc2c57dc036895199d6f1769400Chris Banes * A string resource containing the full class name is available. 58a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 59a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <pre> 60a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <android.support.design.widget.CoordinatorLayout 61a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * xmlns:android="http://schemas.android.com/apk/res/android" 62a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * xmlns:app="http://schemas.android.com/apk/res-auto" 63a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * android:layout_width="match_parent" 64a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * android:layout_height="match_parent"> 65a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 66a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <android.support.v4.widget.NestedScrollView 67a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * android:layout_width="match_parent" 68a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * android:layout_height="match_parent" 69a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * app:layout_behavior="@string/appbar_scrolling_view_behavior"> 70a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 71a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <!-- Your scrolling content --> 72a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 73a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * </android.support.v4.widget.NestedScrollView> 74a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 75a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <android.support.design.widget.AppBarLayout 76a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * android:layout_height="wrap_content" 77a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * android:layout_width="match_parent"> 78a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 79a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <android.support.v7.widget.Toolbar 80a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * ... 81a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * app:layout_scrollFlags="scroll|enterAlways"/> 82a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 83a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * <android.support.design.widget.TabLayout 84a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * ... 85a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * app:layout_scrollFlags="scroll|enterAlways"/> 86a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 87a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * </android.support.design.widget.AppBarLayout> 88a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 89a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * </android.support.design.widget.CoordinatorLayout> 90a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * </pre> 91a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 92a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see <a href="http://www.google.com/design/spec/layout/structure.html#structure-app-bar"> 93a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * http://www.google.com/design/spec/layout/structure.html#structure-app-bar</a> 94a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 95a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes@CoordinatorLayout.DefaultBehavior(AppBarLayout.Behavior.class) 96a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banespublic class AppBarLayout extends LinearLayout { 97a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 989995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes private static final int PENDING_ACTION_NONE = 0x0; 999995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes private static final int PENDING_ACTION_EXPANDED = 0x1; 1009995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes private static final int PENDING_ACTION_COLLAPSED = 0x2; 1019995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes private static final int PENDING_ACTION_ANIMATE_ENABLED = 0x4; 1029995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 103a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 104631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * Interface definition for a callback to be invoked when an {@link AppBarLayout}'s vertical 105631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * offset changes. 106a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 107631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public interface OnOffsetChangedListener { 108a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 109a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Called when the {@link AppBarLayout}'s layout offset has been changed. This allows 110a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * child views to implement custom behavior based on the offset (for instance pinning a 111a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * view at a certain y value). 112a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 113631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * @param appBarLayout the {@link AppBarLayout} which offset has changed 11450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes * @param verticalOffset the vertical offset for the parent {@link AppBarLayout}, in px 115a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 116631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes void onOffsetChanged(AppBarLayout appBarLayout, int verticalOffset); 117a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 118a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 119a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes private static final int INVALID_SCROLL_RANGE = -1; 120a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 121a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes private int mTotalScrollRange = INVALID_SCROLL_RANGE; 122a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes private int mDownPreScrollRange = INVALID_SCROLL_RANGE; 123a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes private int mDownScrollRange = INVALID_SCROLL_RANGE; 124a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 125a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes boolean mHaveChildWithInterpolator; 126a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 12750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes private float mTargetElevation; 12850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 1299995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes private int mPendingAction = PENDING_ACTION_NONE; 1309995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 1316ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes private WindowInsetsCompat mLastInsets; 1326ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes 1336f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes private final List<OnOffsetChangedListener> mListeners; 134631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 135a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public AppBarLayout(Context context) { 136a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes this(context, null); 137a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 138a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 139a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public AppBarLayout(Context context, AttributeSet attrs) { 140a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(context, attrs); 141a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes setOrientation(VERTICAL); 14250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 143809bb62055ad42b88f3a69308be222801b89fbd9Chris Banes ThemeUtils.checkAppCompatTheme(context); 144809bb62055ad42b88f3a69308be222801b89fbd9Chris Banes 14550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.AppBarLayout, 14650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 0, R.style.Widget_Design_AppBarLayout); 14750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes mTargetElevation = a.getDimensionPixelSize(R.styleable.AppBarLayout_elevation, 0); 14881520564f3dd783136e025174021ba4eabd6ff3cChris Banes setBackgroundDrawable(a.getDrawable(R.styleable.AppBarLayout_android_background)); 1499995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes if (a.hasValue(R.styleable.AppBarLayout_expanded)) { 1509995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes setExpanded(a.getBoolean(R.styleable.AppBarLayout_expanded, false)); 1519995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 15250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes a.recycle(); 15350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 15450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // Use the bounds view outline provider so that we cast a shadow, even without a background 15550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes ViewUtils.setBoundsViewOutlineProvider(this); 156631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 157631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mListeners = new ArrayList<>(); 158631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 159631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes ViewCompat.setElevation(this, mTargetElevation); 1606ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes 1616ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes ViewCompat.setOnApplyWindowInsetsListener(this, 1626ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes new android.support.v4.view.OnApplyWindowInsetsListener() { 1636ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes @Override 1646ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes public WindowInsetsCompat onApplyWindowInsets(View v, 1656ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes WindowInsetsCompat insets) { 1666ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes setWindowInsets(insets); 1676ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes return insets.consumeSystemWindowInsets(); 1686ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes } 1696ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes }); 170631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 171631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 172631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes /** 173631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * Add a listener that will be called when the offset of this {@link AppBarLayout} changes. 174631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * 175631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * @param listener The listener that will be called when the offset changes.] 176631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * 177631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * @see #removeOnOffsetChangedListener(OnOffsetChangedListener) 178631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes */ 179631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public void addOnOffsetChangedListener(OnOffsetChangedListener listener) { 1806f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes if (listener != null && !mListeners.contains(listener)) { 1816f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes mListeners.add(listener); 182631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 183631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 184631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 185631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes /** 186631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * Remove the previously added {@link OnOffsetChangedListener}. 187631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * 188631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * @param listener the listener to remove. 189631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes */ 190631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public void removeOnOffsetChangedListener(OnOffsetChangedListener listener) { 1916f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes if (listener != null) { 1926f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes mListeners.remove(listener); 193631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 194a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 195a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 196a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 197ea004a01f44aaf36212120c936952c1742d03d30Chris Banes protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 198ea004a01f44aaf36212120c936952c1742d03d30Chris Banes super.onMeasure(widthMeasureSpec, heightMeasureSpec); 199ea004a01f44aaf36212120c936952c1742d03d30Chris Banes invalidateScrollRanges(); 200ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 201ea004a01f44aaf36212120c936952c1742d03d30Chris Banes 202ea004a01f44aaf36212120c936952c1742d03d30Chris Banes @Override 203a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes protected void onLayout(boolean changed, int l, int t, int r, int b) { 204a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super.onLayout(changed, l, t, r, b); 20579aa418487cdefb85d3c1fac32d6403a1ac6057dChris Banes invalidateScrollRanges(); 206a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 207a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mHaveChildWithInterpolator = false; 208a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes for (int i = 0, z = getChildCount(); i < z; i++) { 209a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final View child = getChildAt(i); 210a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final LayoutParams childLp = (LayoutParams) child.getLayoutParams(); 211a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final Interpolator interpolator = childLp.getScrollInterpolator(); 212a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 213a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (interpolator != null) { 214a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mHaveChildWithInterpolator = true; 215a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes break; 216a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 217a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 218a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 219a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 220ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private void invalidateScrollRanges() { 221ea004a01f44aaf36212120c936952c1742d03d30Chris Banes // Invalidate the scroll ranges 222ea004a01f44aaf36212120c936952c1742d03d30Chris Banes mTotalScrollRange = INVALID_SCROLL_RANGE; 223ea004a01f44aaf36212120c936952c1742d03d30Chris Banes mDownPreScrollRange = INVALID_SCROLL_RANGE; 224ea004a01f44aaf36212120c936952c1742d03d30Chris Banes mDownScrollRange = INVALID_SCROLL_RANGE; 225ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 226ea004a01f44aaf36212120c936952c1742d03d30Chris Banes 227a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 228a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public void setOrientation(int orientation) { 229a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (orientation != VERTICAL) { 230a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes throw new IllegalArgumentException("AppBarLayout is always vertical and does" 231a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes + " not support horizontal orientation"); 232a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 233a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super.setOrientation(orientation); 234a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 235a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 2369995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes /** 2379995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * Sets whether this {@link AppBarLayout} is expanded or not, animating if it has already 2389995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * been laid out. 2399995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * 2409995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * <p>As with {@link AppBarLayout}'s scrolling, this method relies on this layout being a 2419995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * direct child of a {@link CoordinatorLayout}.</p> 2429995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * 2439995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * @param expanded true if the layout should be fully expanded, false if it should 2449995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * be fully collapsed 2459995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * 2469995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * @attr ref android.support.design.R.styleable#AppBarLayout_expanded 2479995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes */ 2489995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes public void setExpanded(boolean expanded) { 2499995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes setExpanded(expanded, ViewCompat.isLaidOut(this)); 2509995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 2519995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 2529995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes /** 2539995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * Sets whether this {@link AppBarLayout} is expanded or not. 2549995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * 2559995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * <p>As with {@link AppBarLayout}'s scrolling, this method relies on this layout being a 2569995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * direct child of a {@link CoordinatorLayout}.</p> 2579995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * 2589995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * @param expanded true if the layout should be fully expanded, false if it should 2599995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * be fully collapsed 2609995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * @param animate Whether to animate to the new state 2619995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * 2629995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes * @attr ref android.support.design.R.styleable#AppBarLayout_expanded 2639995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes */ 2649995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes public void setExpanded(boolean expanded, boolean animate) { 2659995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes mPendingAction = (expanded ? PENDING_ACTION_EXPANDED : PENDING_ACTION_COLLAPSED) 2669995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes | (animate ? PENDING_ACTION_ANIMATE_ENABLED : 0); 2679995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes requestLayout(); 2689995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 2699995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 270a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 271a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes protected boolean checkLayoutParams(ViewGroup.LayoutParams p) { 272a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return p instanceof LayoutParams; 273a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 274a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 275a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 276a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes protected LayoutParams generateDefaultLayoutParams() { 277a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.WRAP_CONTENT); 278a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 279a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 280a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 281a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams generateLayoutParams(AttributeSet attrs) { 282a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return new LayoutParams(getContext(), attrs); 283a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 284a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 285a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 286a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes protected LayoutParams generateLayoutParams(ViewGroup.LayoutParams p) { 287a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (p instanceof LinearLayout.LayoutParams) { 288a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return new LayoutParams((LinearLayout.LayoutParams) p); 289a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } else if (p instanceof MarginLayoutParams) { 290a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return new LayoutParams((MarginLayoutParams) p); 291a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 292a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return new LayoutParams(p); 293a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 294a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 295ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private boolean hasChildWithInterpolator() { 296a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mHaveChildWithInterpolator; 297a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 298a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 299a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 3006ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes * Returns the scroll range of all children. 301a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 302a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @return the scroll range in px 303a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 3046ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes public final int getTotalScrollRange() { 305a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (mTotalScrollRange != INVALID_SCROLL_RANGE) { 306a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mTotalScrollRange; 307a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 308a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 309a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int range = 0; 310a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes for (int i = 0, z = getChildCount(); i < z; i++) { 311a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final View child = getChildAt(i); 312a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final LayoutParams lp = (LayoutParams) child.getLayoutParams(); 313ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final int childHeight = child.getMeasuredHeight(); 314a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final int flags = lp.mScrollFlags; 315a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 316a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_SCROLL) != 0) { 317a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // We're set to scroll so add the child's height 318b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes range += childHeight + lp.topMargin + lp.bottomMargin; 319a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 320a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_EXIT_UNTIL_COLLAPSED) != 0) { 321a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // For a collapsing scroll, we to take the collapsed height into account. 3226ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes // We also break straight away since later views can't scroll beneath 323a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // us 3246ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes range -= ViewCompat.getMinimumHeight(child); 3256ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes break; 326a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 327a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } else { 328a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // As soon as a view doesn't have the scroll flag, we end the range calculation. 329a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // This is because views below can not scroll under a fixed view. 330a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes break; 331a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 332a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 3334832063daa6620f0ad51c4a16f31502dab1adc89Chris Banes return mTotalScrollRange = Math.max(0, range - getTopInset()); 334a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 335a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 336ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private boolean hasScrollableChildren() { 337a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return getTotalScrollRange() != 0; 338a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 339a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 340a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 341a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Return the scroll range when scrolling up from a nested pre-scroll. 342a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 343ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private int getUpNestedPreScrollRange() { 34450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes return getTotalScrollRange(); 345a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 346a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 347a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 348a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Return the scroll range when scrolling down from a nested pre-scroll. 349a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 350ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private int getDownNestedPreScrollRange() { 351a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (mDownPreScrollRange != INVALID_SCROLL_RANGE) { 352a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // If we already have a valid value, return it 353a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mDownPreScrollRange; 354a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 355a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 356a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int range = 0; 357a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes for (int i = getChildCount() - 1; i >= 0; i--) { 358a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final View child = getChildAt(i); 359a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final LayoutParams lp = (LayoutParams) child.getLayoutParams(); 360ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final int childHeight = child.getMeasuredHeight(); 361a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final int flags = lp.mScrollFlags; 362a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 363a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if ((flags & LayoutParams.FLAG_QUICK_RETURN) == LayoutParams.FLAG_QUICK_RETURN) { 364b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes // First take the margin into account 365b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes range += lp.topMargin + lp.bottomMargin; 366a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // The view has the quick return flag combination... 367a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED) != 0) { 368a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // If they're set to enter collapsed, use the minimum height 369a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes range += ViewCompat.getMinimumHeight(child); 370a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } else { 371a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // Else use the full height 372a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes range += childHeight; 373a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 374a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } else if (range > 0) { 375a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // If we've hit an non-quick return scrollable view, and we've already hit a 376a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // quick return view, return now 377a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes break; 378a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 379a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 380a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mDownPreScrollRange = range; 381a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 382a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 383a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 384a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Return the scroll range when scrolling down from a nested scroll. 385a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 386ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private int getDownNestedScrollRange() { 387a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (mDownScrollRange != INVALID_SCROLL_RANGE) { 388a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // If we already have a valid value, return it 389a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mDownScrollRange; 390a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 391a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 392a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int range = 0; 393c1ce4f6cf4d99d6856c4259bf1bb1cb56f604737Chris Banes for (int i = 0, z = getChildCount(); i < z; i++) { 394a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final View child = getChildAt(i); 395a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final LayoutParams lp = (LayoutParams) child.getLayoutParams(); 396ea004a01f44aaf36212120c936952c1742d03d30Chris Banes int childHeight = child.getMeasuredHeight(); 397b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes childHeight += lp.topMargin + lp.bottomMargin; 398a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 399a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final int flags = lp.mScrollFlags; 400a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 401a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_SCROLL) != 0) { 402a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // We're set to scroll so add the child's height 403a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes range += childHeight; 404a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 405a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_EXIT_UNTIL_COLLAPSED) != 0) { 406a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // For a collapsing exit scroll, we to take the collapsed height into account. 4074832063daa6620f0ad51c4a16f31502dab1adc89Chris Banes // We also break the range straight away since later views can't scroll 408a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // beneath us 4094832063daa6620f0ad51c4a16f31502dab1adc89Chris Banes range -= ViewCompat.getMinimumHeight(child) + getTopInset(); 4104832063daa6620f0ad51c4a16f31502dab1adc89Chris Banes break; 411a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 412a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } else { 413a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // As soon as a view doesn't have the scroll flag, we end the range calculation. 414a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // This is because views below can not scroll under a fixed view. 415a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes break; 416a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 417a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 4184832063daa6620f0ad51c4a16f31502dab1adc89Chris Banes return mDownScrollRange = Math.max(0, range - getTopInset()); 419a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 420a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 42150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final int getMinimumHeightForVisibleOverlappingContent() { 4226ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes final int topInset = mLastInsets != null ? mLastInsets.getSystemWindowInsetTop() : 0; 42350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final int minHeight = ViewCompat.getMinimumHeight(this); 42450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if (minHeight != 0) { 42550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // If this layout has a min height, use it (doubled) 4266ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes return (minHeight * 2) + topInset; 42750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 42850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 42950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // Otherwise, we'll use twice the min height of our last child 43050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final int childCount = getChildCount(); 43150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes return childCount >= 1 4326ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes ? (ViewCompat.getMinimumHeight(getChildAt(childCount - 1)) * 2) + topInset 43350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes : 0; 43450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 43550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 43650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes /** 437631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * Set the elevation value to use when this {@link AppBarLayout} should be elevated 438631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * above content. 439631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * <p> 440631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * This method does not do anything itself. A typical use for this method is called from within 441631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * an {@link OnOffsetChangedListener} when the offset has changed in such a way to require an 442631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * elevation change. 443631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * 444631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * @param elevation the elevation value to use. 445631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * 446631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * @see ViewCompat#setElevation(View, float) 44750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes */ 448631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public void setTargetElevation(float elevation) { 449631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mTargetElevation = elevation; 450631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 451631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 452631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes /** 453631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * Returns the elevation value to use when this {@link AppBarLayout} should be elevated 454631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes * above content. 455631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes */ 456631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public float getTargetElevation() { 45750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes return mTargetElevation; 45850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 45950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 460ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private int getPendingAction() { 4619995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes return mPendingAction; 4629995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 4639995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 464ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private void resetPendingAction() { 4659995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes mPendingAction = PENDING_ACTION_NONE; 4669995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 4679995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 468ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private int getTopInset() { 469ea004a01f44aaf36212120c936952c1742d03d30Chris Banes return mLastInsets != null ? mLastInsets.getSystemWindowInsetTop() : 0; 470ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 471ea004a01f44aaf36212120c936952c1742d03d30Chris Banes 4726ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes private void setWindowInsets(WindowInsetsCompat insets) { 4736ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes // Invalidate the total scroll range... 4746ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes mTotalScrollRange = INVALID_SCROLL_RANGE; 4756ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes mLastInsets = insets; 4766ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes 4776ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes // Now dispatch them to our children 4786ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes for (int i = 0, z = getChildCount(); i < z; i++) { 4796ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes final View child = getChildAt(i); 4806ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes insets = ViewCompat.dispatchApplyWindowInsets(child, insets); 4816ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes if (insets.isConsumed()) { 4826ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes break; 4836ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes } 4846ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes } 4856ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes } 4866ba61c5c79fe025036593c9daf79cb65299bb0b6Chris Banes 487a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public static class LayoutParams extends LinearLayout.LayoutParams { 48850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 48950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes /** @hide */ 49050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes @IntDef(flag=true, value={ 49150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes SCROLL_FLAG_SCROLL, 49250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes SCROLL_FLAG_EXIT_UNTIL_COLLAPSED, 49350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes SCROLL_FLAG_ENTER_ALWAYS, 494bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED, 495bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes SCROLL_FLAG_SNAP 49650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes }) 49750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes @Retention(RetentionPolicy.SOURCE) 49850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes public @interface ScrollFlags {} 49950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 500a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 501a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * The view will be scroll in direct relation to scroll events. This flag needs to be 502a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * set for any of the other flags to take effect. If any sibling views 503a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * before this one do not have this flag, then this value has no effect. 504a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 505a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public static final int SCROLL_FLAG_SCROLL = 0x1; 506a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 507a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 508a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * When exiting (scrolling off screen) the view will be scrolled until it is 509a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 'collapsed'. The collapsed height is defined by the view's minimum height. 510a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 511a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see ViewCompat#getMinimumHeight(View) 512a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see View#setMinimumHeight(int) 513a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 514a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public static final int SCROLL_FLAG_EXIT_UNTIL_COLLAPSED = 0x2; 515a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 516a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 517a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * When entering (scrolling on screen) the view will scroll on any downwards 518a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * scroll event, regardless of whether the scrolling view is also scrolling. This 519a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * is commonly referred to as the 'quick return' pattern. 520a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 521a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public static final int SCROLL_FLAG_ENTER_ALWAYS = 0x4; 522a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 523a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 524a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * An additional flag for 'enterAlways' which modifies the returning view to 525a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * only initially scroll back to it's collapsed height. Once the scrolling view has 526a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * reached the end of it's scroll range, the remainder of this view will be scrolled 527a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * into view. The collapsed height is defined by the view's minimum height. 528a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 529a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see ViewCompat#getMinimumHeight(View) 530a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see View#setMinimumHeight(int) 531a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 532a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public static final int SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED = 0x8; 533a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 534a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 535bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * Upon a scroll ending, if the view is only partially visible then it will be snapped 536bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * and scrolled to it's closest edge. For example, if the view only has it's bottom 25% 537bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * displayed, it will be scrolled off screen completely. Conversely, if it's bottom 75% 538bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * is visible then it will be scrolled fully into view. 539bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes */ 540bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes public static final int SCROLL_FLAG_SNAP = 0x10; 541bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes 542bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes /** 543bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * Internal flags which allows quick checking features 544a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 545a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes static final int FLAG_QUICK_RETURN = SCROLL_FLAG_SCROLL | SCROLL_FLAG_ENTER_ALWAYS; 546bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes static final int FLAG_SNAP = SCROLL_FLAG_SCROLL | SCROLL_FLAG_SNAP; 547a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 548a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int mScrollFlags = SCROLL_FLAG_SCROLL; 549a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes Interpolator mScrollInterpolator; 550a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 551a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(Context c, AttributeSet attrs) { 552a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(c, attrs); 553a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes TypedArray a = c.obtainStyledAttributes(attrs, R.styleable.AppBarLayout_LayoutParams); 554a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mScrollFlags = a.getInt(R.styleable.AppBarLayout_LayoutParams_layout_scrollFlags, 0); 555a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (a.hasValue(R.styleable.AppBarLayout_LayoutParams_layout_scrollInterpolator)) { 556a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int resId = a.getResourceId( 557a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes R.styleable.AppBarLayout_LayoutParams_layout_scrollInterpolator, 0); 558a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mScrollInterpolator = android.view.animation.AnimationUtils.loadInterpolator( 559a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes c, resId); 560a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 561a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes a.recycle(); 562a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 563a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 564a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(int width, int height) { 565a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(width, height); 566a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 567a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 568a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(int width, int height, float weight) { 569a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(width, height, weight); 570a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 571a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 572a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(ViewGroup.LayoutParams p) { 573a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(p); 574a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 575a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 576a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(MarginLayoutParams source) { 577a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(source); 578a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 579a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 580a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(LinearLayout.LayoutParams source) { 581a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(source); 582a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 583a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 584a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public LayoutParams(LayoutParams source) { 585a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(source); 586a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mScrollFlags = source.mScrollFlags; 587a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mScrollInterpolator = source.mScrollInterpolator; 588a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 589a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 590a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 591a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Set the scrolling flags. 592a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 593a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @param flags bitwise int of {@link #SCROLL_FLAG_SCROLL}, 594bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * {@link #SCROLL_FLAG_EXIT_UNTIL_COLLAPSED}, {@link #SCROLL_FLAG_ENTER_ALWAYS}, 595bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes * {@link #SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED} and {@link #SCROLL_FLAG_SNAP }. 596a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 597a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see #getScrollFlags() 598a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 599149689d3a0b4165577470d7152112674d1d7f87cChris Banes * @attr ref android.support.design.R.styleable#AppBarLayout_LayoutParams_layout_scrollFlags 600a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 60150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes public void setScrollFlags(@ScrollFlags int flags) { 602a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mScrollFlags = flags; 603a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 604a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 605a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 606a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Returns the scrolling flags. 607a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 608a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see #setScrollFlags(int) 609a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 610149689d3a0b4165577470d7152112674d1d7f87cChris Banes * @attr ref android.support.design.R.styleable#AppBarLayout_LayoutParams_layout_scrollFlags 611a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 61250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes @ScrollFlags 613a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public int getScrollFlags() { 614a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mScrollFlags; 615a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 616a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 617a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 618a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Set the interpolator to when scrolling the view associated with this 619a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * {@link LayoutParams}. 620a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 621a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @param interpolator the interpolator to use, or null to use normal 1-to-1 scrolling. 622a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 623149689d3a0b4165577470d7152112674d1d7f87cChris Banes * @attr ref android.support.design.R.styleable#AppBarLayout_LayoutParams_layout_scrollInterpolator 624a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see #getScrollInterpolator() 625a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 626a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public void setScrollInterpolator(Interpolator interpolator) { 627a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mScrollInterpolator = interpolator; 628a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 629a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 630a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 631a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Returns the {@link Interpolator} being used for scrolling the view associated with this 632a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * {@link LayoutParams}. Null indicates 'normal' 1-to-1 scrolling. 633a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 634149689d3a0b4165577470d7152112674d1d7f87cChris Banes * @attr ref android.support.design.R.styleable#AppBarLayout_LayoutParams_layout_scrollInterpolator 635a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @see #setScrollInterpolator(Interpolator) 636a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 637a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public Interpolator getScrollInterpolator() { 638a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mScrollInterpolator; 639a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 640a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 641a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 642a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 643a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * The default {@link Behavior} for {@link AppBarLayout}. Implements the necessary nested 644a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * scroll handling with offsetting. 645a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 646ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor public static class Behavior extends HeaderBehavior<AppBarLayout> { 647e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes private static final int INVALID_POSITION = -1; 648e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 64972a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes /** 65072a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * Callback to allow control over any {@link AppBarLayout} dragging. 65172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes */ 65272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes public static abstract class DragCallback { 65372a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes /** 65472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * Allows control over whether the given {@link AppBarLayout} can be dragged or not. 65572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * 65672a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * <p>Dragging is defined as a direct touch on the AppBarLayout with movement. This 65772a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * call does not affect any nested scrolling.</p> 65872a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * 65972a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * @return true if we are in a position to scroll the AppBarLayout via a drag, false 66072a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * if not. 66172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes */ 66272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes public abstract boolean canDrag(@NonNull AppBarLayout appBarLayout); 66372a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes } 66472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes 665e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes private int mOffsetDelta; 666a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 66750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes private boolean mSkipNestedPreScroll; 668bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes private boolean mWasFlung; 669631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 670631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes private ValueAnimatorCompat mAnimator; 67150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 672e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes private int mOffsetToChildIndexOnLayout = INVALID_POSITION; 673e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes private boolean mOffsetToChildIndexOnLayoutIsMinHeight; 674e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes private float mOffsetToChildIndexOnLayoutPerc; 675e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 676d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes private WeakReference<View> mLastNestedScrollingChildRef; 67772a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes private DragCallback mOnDragCallback; 678d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes 679a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public Behavior() {} 680a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 681a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public Behavior(Context context, AttributeSet attrs) { 682a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(context, attrs); 683a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 684a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 685a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 686ab809dd75ef2f73b312038f2c10473cfa5885a58Chris Banes public boolean onStartNestedScroll(CoordinatorLayout parent, AppBarLayout child, 687a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes View directTargetChild, View target, int nestedScrollAxes) { 688f57cd2fd5059c43d77bdfec57edfd5a217533103Chris Banes // Return true if we're nested scrolling vertically, and we have scrollable children 689f57cd2fd5059c43d77bdfec57edfd5a217533103Chris Banes // and the scrolling view is big enough to scroll 690631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes final boolean started = (nestedScrollAxes & ViewCompat.SCROLL_AXIS_VERTICAL) != 0 691f57cd2fd5059c43d77bdfec57edfd5a217533103Chris Banes && child.hasScrollableChildren() 692ab809dd75ef2f73b312038f2c10473cfa5885a58Chris Banes && parent.getHeight() - directTargetChild.getHeight() <= child.getHeight(); 693631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 694631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes if (started && mAnimator != null) { 695631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // Cancel any offset animation 696631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator.cancel(); 697631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 698631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 699d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes // A new nested scroll has started so clear out the previous ref 700d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes mLastNestedScrollingChildRef = null; 701d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes 702631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes return started; 703a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 704a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 705a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 706a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public void onNestedPreScroll(CoordinatorLayout coordinatorLayout, AppBarLayout child, 707a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes View target, int dx, int dy, int[] consumed) { 70850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if (dy != 0 && !mSkipNestedPreScroll) { 70950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes int min, max; 71050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if (dy < 0) { 71150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // We're scrolling down 71250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes min = -child.getTotalScrollRange(); 71350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes max = min + child.getDownNestedPreScrollRange(); 71450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } else { 71550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // We're scrolling up 71650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes min = -child.getUpNestedPreScrollRange(); 71750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes max = 0; 71850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 71950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes consumed[1] = scroll(coordinatorLayout, child, dy, min, max); 720a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 721a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 722a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 723a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 724a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public void onNestedScroll(CoordinatorLayout coordinatorLayout, AppBarLayout child, 725a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes View target, int dxConsumed, int dyConsumed, 726a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int dxUnconsumed, int dyUnconsumed) { 72750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if (dyUnconsumed < 0) { 72850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // If the scrolling view is scrolling down but not consuming, it's probably be at 72950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // the top of it's content 73050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes scroll(coordinatorLayout, child, dyUnconsumed, 73150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes -child.getDownNestedScrollRange(), 0); 73250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // Set the expanding flag so that onNestedPreScroll doesn't handle any events 73350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes mSkipNestedPreScroll = true; 73450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } else { 73550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // As we're no longer handling nested scrolls, reset the skip flag 73650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes mSkipNestedPreScroll = false; 737a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 73850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 739a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 74050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes @Override 741bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes public void onStopNestedScroll(CoordinatorLayout coordinatorLayout, AppBarLayout abl, 74250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes View target) { 743bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes if (!mWasFlung) { 744bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // If we haven't been flung then let's see if the current view has been set to snap 745bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes snapToChildIfNeeded(coordinatorLayout, abl); 746bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 747bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes 748bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // Reset the flags 74950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes mSkipNestedPreScroll = false; 750bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes mWasFlung = false; 751d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes // Keep a reference to the previous nested scrolling child 752d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes mLastNestedScrollingChildRef = new WeakReference<>(target); 753d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes } 754d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes 755d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes @Override 756631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public boolean onNestedFling(final CoordinatorLayout coordinatorLayout, 757631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes final AppBarLayout child, View target, float velocityX, float velocityY, 758631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes boolean consumed) { 759bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes boolean flung = false; 760bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes 761631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes if (!consumed) { 762631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // It has been consumed so let's fling ourselves 763bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes flung = fling(coordinatorLayout, child, -child.getTotalScrollRange(), 764bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes 0, -velocityY); 765631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } else { 766631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // If we're scrolling up and the child also consumed the fling. We'll fake scroll 767631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // upto our 'collapsed' offset 768631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes if (velocityY < 0) { 769631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // We're scrolling down 770bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final int targetScroll = -child.getTotalScrollRange() 771631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes + child.getDownNestedPreScrollRange(); 772bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes if (getTopBottomOffsetForScrollingSibling() < targetScroll) { 773bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // If we're currently not expanded more than the target scroll, we'll 774bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // animate a fling 775bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes animateOffsetTo(coordinatorLayout, child, targetScroll); 776bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes flung = true; 777631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 778631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } else { 779631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // We're scrolling up 780bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final int targetScroll = -child.getUpNestedPreScrollRange(); 781bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes if (getTopBottomOffsetForScrollingSibling() > targetScroll) { 782bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // If we're currently not expanded less than the target scroll, we'll 783bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // animate a fling 784bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes animateOffsetTo(coordinatorLayout, child, targetScroll); 785bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes flung = true; 786631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 787631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 788631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 789631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 790bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes mWasFlung = flung; 791bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes return flung; 792631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 793631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 79472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes /** 79572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * Set a callback to control any {@link AppBarLayout} dragging. 79672a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * 79772a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes * @param callback the callback to use, or {@code null} to use the default behavior. 79872a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes */ 79972a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes public void setDragCallback(@Nullable DragCallback callback) { 80072a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes mOnDragCallback = callback; 80172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes } 80272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes 803631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes private void animateOffsetTo(final CoordinatorLayout coordinatorLayout, 804631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes final AppBarLayout child, int offset) { 805631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes if (mAnimator == null) { 806631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator = ViewUtils.createAnimator(); 807631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator.setInterpolator(AnimationUtils.DECELERATE_INTERPOLATOR); 808631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator.setUpdateListener(new ValueAnimatorCompat.AnimatorUpdateListener() { 809631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes @Override 810631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes public void onAnimationUpdate(ValueAnimatorCompat animator) { 811ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor setHeaderTopBottomOffset(coordinatorLayout, child, 812631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes animator.getAnimatedIntValue()); 813631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 814631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes }); 815631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } else { 816631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator.cancel(); 817631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 818631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 819631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator.setIntValues(getTopBottomOffsetForScrollingSibling(), offset); 820631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes mAnimator.start(); 821631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes } 822631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 823bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes private View getChildOnOffset(AppBarLayout abl, final int offset) { 824bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes for (int i = 0, count = abl.getChildCount(); i < count; i++) { 825bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes View child = abl.getChildAt(i); 826bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes if (child.getTop() <= -offset && child.getBottom() >= -offset) { 827bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes return child; 828bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 829bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 830bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes return null; 831bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 832bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes 833bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes private void snapToChildIfNeeded(CoordinatorLayout coordinatorLayout, AppBarLayout abl) { 834bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final int offset = getTopBottomOffsetForScrollingSibling(); 835bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final View offsetChild = getChildOnOffset(abl, offset); 836bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes if (offsetChild != null) { 837bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final LayoutParams lp = (LayoutParams) offsetChild.getLayoutParams(); 838bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes if ((lp.getScrollFlags() & LayoutParams.FLAG_SNAP) == LayoutParams.FLAG_SNAP) { 839bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes // We're set the snap, so animate the offset to the nearest edge 840bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final int childTop = -offsetChild.getTop(); 841bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes final int childBottom = -offsetChild.getBottom(); 842bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes animateOffsetTo(coordinatorLayout, abl, 843bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes offset < (childBottom + childTop) / 2 ? childBottom : childTop); 844bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 845bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 846bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes } 847bc22c4fd37e99643b3e7b87e2849a9e63fb8c5fcChris Banes 848631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes @Override 8499995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes public boolean onLayoutChild(CoordinatorLayout parent, AppBarLayout abl, 85050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes int layoutDirection) { 8519995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes boolean handled = super.onLayoutChild(parent, abl, layoutDirection); 8529995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes 8539995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes final int pendingAction = abl.getPendingAction(); 8549995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes if (pendingAction != PENDING_ACTION_NONE) { 8559995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes final boolean animate = (pendingAction & PENDING_ACTION_ANIMATE_ENABLED) != 0; 8569995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes if ((pendingAction & PENDING_ACTION_COLLAPSED) != 0) { 8579995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes final int offset = -abl.getUpNestedPreScrollRange(); 8589995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes if (animate) { 8599995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes animateOffsetTo(parent, abl, offset); 8609995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } else { 861ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor setHeaderTopBottomOffset(parent, abl, offset); 8629995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 8639995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } else if ((pendingAction & PENDING_ACTION_EXPANDED) != 0) { 8649995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes if (animate) { 8659995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes animateOffsetTo(parent, abl, 0); 8669995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } else { 867ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor setHeaderTopBottomOffset(parent, abl, 0); 8689995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 8699995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } 8709995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes } else if (mOffsetToChildIndexOnLayout >= 0) { 8719995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes View child = abl.getChildAt(mOffsetToChildIndexOnLayout); 872e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes int offset = -child.getBottom(); 873e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes if (mOffsetToChildIndexOnLayoutIsMinHeight) { 874e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes offset += ViewCompat.getMinimumHeight(child); 875e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } else { 876e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes offset += Math.round(child.getHeight() * mOffsetToChildIndexOnLayoutPerc); 877e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 878e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes setTopAndBottomOffset(offset); 879e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 88050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 88179aa418487cdefb85d3c1fac32d6403a1ac6057dChris Banes // Finally reset any pending states 88279aa418487cdefb85d3c1fac32d6403a1ac6057dChris Banes abl.resetPendingAction(); 88379aa418487cdefb85d3c1fac32d6403a1ac6057dChris Banes mOffsetToChildIndexOnLayout = INVALID_POSITION; 88479aa418487cdefb85d3c1fac32d6403a1ac6057dChris Banes 88550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // Make sure we update the elevation 8869995f7bdb02dbe16155661545fd64046ad3d56c2Chris Banes dispatchOffsetUpdates(abl); 88750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 88850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes return handled; 889a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 890a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 89172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes @Override 89272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes boolean canDragView(AppBarLayout view) { 89372a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes if (mOnDragCallback != null) { 89472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes // If there is a drag callback set, it's in control 89572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes return mOnDragCallback.canDrag(view); 89672a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes } 89772a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes 89872a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes // Else we'll use the default behaviour of seeing if it can scroll down 899d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes if (mLastNestedScrollingChildRef != null) { 90072a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes // If we have a reference to a scrolling view, check it 90172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes final View scrollingView = mLastNestedScrollingChildRef.get(); 90272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes return scrollingView != null && scrollingView.isShown() 90372a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes && !ViewCompat.canScrollVertically(scrollingView, -1); 90472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes } else { 90572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes // Otherwise we assume that the scrolling view hasn't been scrolled and can drag. 90672a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes return true; 907d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes } 908d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes } 909d4c72f08279df548fbc4d556fe1a8b3500fafdbcChris Banes 910ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor @Override 91172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes int getMaxDragOffset(AppBarLayout view) { 91272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes return -view.getDownNestedScrollRange(); 91372a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes } 91472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes 91572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes @Override 91672a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes int getScrollRangeForDragFling(AppBarLayout view) { 91772a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes return view.getTotalScrollRange(); 91872a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes } 91972a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes 92072a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes @Override 92172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes int setHeaderTopBottomOffset(CoordinatorLayout coordinatorLayout, 92272a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes AppBarLayout header, int newOffset, int minOffset, int maxOffset) { 923e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final int curOffset = getTopBottomOffsetForScrollingSibling(); 924a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes int consumed = 0; 925a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 92672a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes if (minOffset != 0 && curOffset >= minOffset 927ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor && curOffset <= maxOffset) { 928631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // If we have some scrolling range, and we're currently within the min and max 929631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // offsets, calculate a new offset 93050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes newOffset = MathUtils.constrain(newOffset, minOffset, maxOffset); 931ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor AppBarLayout appBarLayout = (AppBarLayout) header; 932a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (curOffset != newOffset) { 933e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final int interpolatedOffset = appBarLayout.hasChildWithInterpolator() 934e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes ? interpolateOffset(appBarLayout, newOffset) 935e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes : newOffset; 936e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 937e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes boolean offsetChanged = setTopAndBottomOffset(interpolatedOffset); 938631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes 939a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // Update how much dy we have consumed 940a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes consumed = curOffset - newOffset; 941a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // Update the stored sibling offset 942e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes mOffsetDelta = newOffset - interpolatedOffset; 943a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 944a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (!offsetChanged && appBarLayout.hasChildWithInterpolator()) { 945a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // If the offset hasn't changed and we're using an interpolated scroll 946a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // then we need to keep any dependent views updated. CoL will do this for 947a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // us when we move, but we need to do it manually when we don't (as an 948a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // interpolated scroll may finish early). 949a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes coordinatorLayout.dispatchDependentViewsChanged(appBarLayout); 950a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 951a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 952631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // Dispatch the updates to any listeners 953631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes dispatchOffsetUpdates(appBarLayout); 954a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 955a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 956a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 957a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return consumed; 958a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 959a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 960631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes private void dispatchOffsetUpdates(AppBarLayout layout) { 9616f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes final List<OnOffsetChangedListener> listeners = layout.mListeners; 96250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 963631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // Iterate backwards through the list so that most recently added listeners 964631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes // get the first chance to decide 965631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes for (int i = 0, z = listeners.size(); i < z; i++) { 9666f730c0acfb10a929172ea2981a1aded0e39f5c7Chris Banes final OnOffsetChangedListener listener = listeners.get(i); 967631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes if (listener != null) { 968631f64ec9c6255f38a7f746d7949b6a537c1180fChris Banes listener.onOffsetChanged(layout, getTopAndBottomOffset()); 969a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 970a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 971a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 972a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 973a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes private int interpolateOffset(AppBarLayout layout, final int offset) { 974a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final int absOffset = Math.abs(offset); 975a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 976a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes for (int i = 0, z = layout.getChildCount(); i < z; i++) { 977a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final View child = layout.getChildAt(i); 978a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final AppBarLayout.LayoutParams childLp = (LayoutParams) child.getLayoutParams(); 97950dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final Interpolator interpolator = childLp.getScrollInterpolator(); 980a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 98150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if (absOffset >= child.getTop() && absOffset <= child.getBottom()) { 982a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (interpolator != null) { 98350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes int childScrollableHeight = 0; 98450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final int flags = childLp.getScrollFlags(); 98550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_SCROLL) != 0) { 986b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes // We're set to scroll so add the child's height plus margin 987b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes childScrollableHeight += child.getHeight() + childLp.topMargin 988b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes + childLp.bottomMargin; 989b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes 99050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if ((flags & LayoutParams.SCROLL_FLAG_EXIT_UNTIL_COLLAPSED) != 0) { 991b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes // For a collapsing scroll, we to take the collapsed height 992b263b91ba75dc1a7855186e8b0e9cf75d46a6b8dChris Banes // into account. 99350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes childScrollableHeight -= ViewCompat.getMinimumHeight(child); 99450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 99550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 99650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 997ea004a01f44aaf36212120c936952c1742d03d30Chris Banes if (ViewCompat.getFitsSystemWindows(child)) { 998ea004a01f44aaf36212120c936952c1742d03d30Chris Banes childScrollableHeight -= layout.getTopInset(); 999ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 1000ea004a01f44aaf36212120c936952c1742d03d30Chris Banes 100150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes if (childScrollableHeight > 0) { 100250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final int offsetForView = absOffset - child.getTop(); 100350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes final int interpolatedDiff = Math.round(childScrollableHeight * 100450dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes interpolator.getInterpolation( 100550dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes offsetForView / (float) childScrollableHeight)); 100650dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 100750dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes return Integer.signum(offset) * (child.getTop() + interpolatedDiff); 100850dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes } 1009a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 101050dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes 101150dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // If we get to here then the view on the offset isn't suitable for interpolated 101250dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes // scrolling. So break out of the loop 101350dfc33a565c4aefe6d5e844c93aa24a74cb80b3Chris Banes break; 1014a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1015a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1016a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1017a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return offset; 1018a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1019a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1020ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor @Override 102172a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes int getTopBottomOffsetForScrollingSibling() { 1022e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes return getTopAndBottomOffset() + mOffsetDelta; 1023e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1024e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1025e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes @Override 1026e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public Parcelable onSaveInstanceState(CoordinatorLayout parent, AppBarLayout appBarLayout) { 1027e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final Parcelable superState = super.onSaveInstanceState(parent, appBarLayout); 1028e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final int offset = getTopAndBottomOffset(); 1029e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1030e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes // Try and find the first visible child... 1031e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes for (int i = 0, count = appBarLayout.getChildCount(); i < count; i++) { 1032e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes View child = appBarLayout.getChildAt(i); 1033e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final int visBottom = child.getBottom() + offset; 1034e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1035e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes if (child.getTop() + offset <= 0 && visBottom >= 0) { 1036e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final SavedState ss = new SavedState(superState); 1037e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes ss.firstVisibleChildIndex = i; 1038e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes ss.firstVisibileChildAtMinimumHeight = 1039e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes visBottom == ViewCompat.getMinimumHeight(child); 1040e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes ss.firstVisibileChildPercentageShown = visBottom / (float) child.getHeight(); 1041e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes return ss; 1042e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1043e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1044e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1045e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes // Else we'll just return the super state 1046e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes return superState; 1047e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1048e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1049e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes @Override 1050e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public void onRestoreInstanceState(CoordinatorLayout parent, AppBarLayout appBarLayout, 1051e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes Parcelable state) { 1052e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes if (state instanceof SavedState) { 1053e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes final SavedState ss = (SavedState) state; 1054e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes super.onRestoreInstanceState(parent, appBarLayout, ss.getSuperState()); 1055e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes mOffsetToChildIndexOnLayout = ss.firstVisibleChildIndex; 1056e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes mOffsetToChildIndexOnLayoutPerc = ss.firstVisibileChildPercentageShown; 1057e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes mOffsetToChildIndexOnLayoutIsMinHeight = ss.firstVisibileChildAtMinimumHeight; 1058e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } else { 1059e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes super.onRestoreInstanceState(parent, appBarLayout, state); 1060e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes mOffsetToChildIndexOnLayout = INVALID_POSITION; 1061e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1062e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1063e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1064e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes protected static class SavedState extends View.BaseSavedState { 1065e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes int firstVisibleChildIndex; 1066e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes float firstVisibileChildPercentageShown; 1067e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes boolean firstVisibileChildAtMinimumHeight; 1068e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1069e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public SavedState(Parcel source) { 1070e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes super(source); 1071e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes firstVisibleChildIndex = source.readInt(); 1072e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes firstVisibileChildPercentageShown = source.readFloat(); 1073e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes firstVisibileChildAtMinimumHeight = source.readByte() != 0; 1074e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1075e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1076e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public SavedState(Parcelable superState) { 1077e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes super(superState); 1078e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1079e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1080e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes @Override 1081e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public void writeToParcel(Parcel dest, int flags) { 1082e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes super.writeToParcel(dest, flags); 1083e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes dest.writeInt(firstVisibleChildIndex); 1084e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes dest.writeFloat(firstVisibileChildPercentageShown); 1085e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes dest.writeByte((byte) (firstVisibileChildAtMinimumHeight ? 1 : 0)); 1086e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1087e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1088e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public static final Parcelable.Creator<SavedState> CREATOR = 1089e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes new Parcelable.Creator<SavedState>() { 1090e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes @Override 1091e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public SavedState createFromParcel(Parcel source) { 1092e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes return new SavedState(source); 1093e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1094e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes 1095e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes @Override 1096e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes public SavedState[] newArray(int size) { 1097e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes return new SavedState[size]; 1098e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes } 1099e52e16988e2500e20052ddd70920f950f4eb4f79Chris Banes }; 1100a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1101a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1102a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1103a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 1104a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Behavior which should be used by {@link View}s which can scroll vertically and support 1105a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * nested scrolling to automatically scroll any {@link AppBarLayout} siblings. 1106a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 1107ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor public static class ScrollingViewBehavior extends HeaderScrollingViewBehavior { 1108a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes private int mOverlayTop; 1109a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1110a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public ScrollingViewBehavior() {} 1111a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1112a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public ScrollingViewBehavior(Context context, AttributeSet attrs) { 1113a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes super(context, attrs); 1114a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1115a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes TypedArray a = context.obtainStyledAttributes(attrs, 1116a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes R.styleable.ScrollingViewBehavior_Params); 1117a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mOverlayTop = a.getDimensionPixelSize( 1118a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes R.styleable.ScrollingViewBehavior_Params_behavior_overlapTop, 0); 1119a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes a.recycle(); 1120a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1121a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1122a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 1123a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public boolean layoutDependsOn(CoordinatorLayout parent, View child, View dependency) { 1124a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // We depend on any AppBarLayouts 1125a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return dependency instanceof AppBarLayout; 1126a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1127a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1128a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes @Override 11290d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes public boolean onLayoutChild(CoordinatorLayout parent, View child, int layoutDirection) { 11300d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes // First lay out the child as normal 11310d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes super.onLayoutChild(parent, child, layoutDirection); 11320d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes 11330d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes // Now offset us correctly to be in the correct position. This is important for things 11340d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes // like activity transitions which rely on accurate positioning after the first layout. 11350d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes final List<View> dependencies = parent.getDependencies(child); 11360d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes for (int i = 0, z = dependencies.size(); i < z; i++) { 11370d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes if (updateOffset(parent, child, dependencies.get(i))) { 11380d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes // If we updated the offset, break out of the loop now 11390d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes break; 11400d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes } 11410d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes } 11420d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes return true; 11430d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes } 11440d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes 11450d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes @Override 1146a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public boolean onDependentViewChanged(CoordinatorLayout parent, View child, 1147a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes View dependency) { 11480d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes updateOffset(parent, child, dependency); 11490d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes return false; 11500d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes } 11510d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes 11520d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes private boolean updateOffset(CoordinatorLayout parent, View child, View dependency) { 1153a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes final CoordinatorLayout.Behavior behavior = 1154a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes ((CoordinatorLayout.LayoutParams) dependency.getLayoutParams()).getBehavior(); 1155a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (behavior instanceof Behavior) { 1156a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes // Offset the child so that it is below the app-bar (with any overlap) 1157ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final int offset = ((Behavior) behavior).getTopBottomOffsetForScrollingSibling(); 1158ea004a01f44aaf36212120c936952c1742d03d30Chris Banes setTopAndBottomOffset(dependency.getHeight() + offset 1159ea004a01f44aaf36212120c936952c1742d03d30Chris Banes - getOverlapForOffset(dependency, offset)); 11600d2f46331a9fc3b21597e926ba2e061af7c00708Chris Banes return true; 1161ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 1162ea004a01f44aaf36212120c936952c1742d03d30Chris Banes return false; 1163ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 1164ea004a01f44aaf36212120c936952c1742d03d30Chris Banes 1165ea004a01f44aaf36212120c936952c1742d03d30Chris Banes private int getOverlapForOffset(final View dependency, final int offset) { 1166ea004a01f44aaf36212120c936952c1742d03d30Chris Banes if (mOverlayTop != 0 && dependency instanceof AppBarLayout) { 1167ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final AppBarLayout abl = (AppBarLayout) dependency; 1168ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final int totalScrollRange = abl.getTotalScrollRange(); 1169ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final int preScrollDown = abl.getDownNestedPreScrollRange(); 1170a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1171ea004a01f44aaf36212120c936952c1742d03d30Chris Banes if (preScrollDown != 0 && (totalScrollRange + offset) <= preScrollDown) { 1172ea004a01f44aaf36212120c936952c1742d03d30Chris Banes // If we're in a pre-scroll down. Don't use the offset at all. 1173ea004a01f44aaf36212120c936952c1742d03d30Chris Banes return 0; 1174a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } else { 1175ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final int availScrollRange = totalScrollRange - preScrollDown; 1176ea004a01f44aaf36212120c936952c1742d03d30Chris Banes if (availScrollRange == 0) { 1177ea004a01f44aaf36212120c936952c1742d03d30Chris Banes // Else we'll use a interpolated ratio of the overlap, depending on offset 1178ea004a01f44aaf36212120c936952c1742d03d30Chris Banes final float percScrolled = offset / (float) availScrollRange; 1179ea004a01f44aaf36212120c936952c1742d03d30Chris Banes return MathUtils.constrain( 1180ea004a01f44aaf36212120c936952c1742d03d30Chris Banes Math.round((1f + percScrolled) * mOverlayTop), 0, mOverlayTop); 1181ea004a01f44aaf36212120c936952c1742d03d30Chris Banes } 1182a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1183a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1184ea004a01f44aaf36212120c936952c1742d03d30Chris Banes return mOverlayTop; 1185a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1186a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1187a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 1188a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Set the distance that this view should overlap any {@link AppBarLayout}. 1189a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * 1190a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * @param overlayTop the distance in px 1191a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 1192a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public void setOverlayTop(int overlayTop) { 1193a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes mOverlayTop = overlayTop; 1194a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1195a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1196a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes /** 1197a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes * Returns the distance that this view should overlap any {@link AppBarLayout}. 1198a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes */ 1199a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes public int getOverlayTop() { 1200a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return mOverlayTop; 1201a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1202a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes 1203ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor @Override 120472a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes View findFirstDependency(List<View> views) { 1205a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes for (int i = 0, z = views.size(); i < z; i++) { 1206a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes View view = views.get(i); 1207a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes if (view instanceof AppBarLayout) { 120872a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes return view; 1209a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1210a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1211a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes return null; 1212a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1213ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor 1214ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor @Override 121572a0913607198c5ce3fa351242ccbdfb3b93f178Chris Banes int getScrollRange(View v) { 1216ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor if (v instanceof AppBarLayout) { 1217ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor return ((AppBarLayout) v).getTotalScrollRange(); 1218ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor } else { 1219ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor return super.getScrollRange(v); 1220ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor } 1221ec161ac1da9c8ca0e942b01e037ceb1cc51a2f3cMady Mellor } 1222a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes } 1223a6a508b2296730ca6954aaebcca52a9962a5cb55Chris Banes} 1224