Fixes up, down, spacebar and key variation keyboard actions with NestedScrollView and CoordinatorLayout.
Bug: 243555083
Test: Added tests
Change-Id: I216f42029674cc8210907eb6591dc9584b000c75
diff --git a/coordinatorlayout/coordinatorlayout/build.gradle b/coordinatorlayout/coordinatorlayout/build.gradle
index 8b23b1a..bc110f8 100644
--- a/coordinatorlayout/coordinatorlayout/build.gradle
+++ b/coordinatorlayout/coordinatorlayout/build.gradle
@@ -15,6 +15,7 @@
androidTestImplementation(libs.testCore)
androidTestImplementation(libs.testRunner)
androidTestImplementation(libs.testRules)
+ androidTestImplementation(libs.material)
androidTestImplementation(libs.espressoCore, excludes.espresso)
androidTestImplementation(libs.bundles.espressoContrib, excludes.espresso)
androidTestImplementation(libs.mockitoCore, excludes.bytebuddy)
@@ -38,6 +39,11 @@
defaultConfig {
multiDexEnabled = true
}
+
+ testOptions {
+ animationsDisabled = true
+ }
+
namespace "androidx.coordinatorlayout"
}
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/AndroidManifest.xml b/coordinatorlayout/coordinatorlayout/src/androidTest/AndroidManifest.xml
index b183770..0dedce5 100644
--- a/coordinatorlayout/coordinatorlayout/src/androidTest/AndroidManifest.xml
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/AndroidManifest.xml
@@ -14,7 +14,8 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest
+ xmlns:android="http://schemas.android.com/apk/res/android">
<application
android:supportsRtl="true"
@@ -22,6 +23,12 @@
<activity android:name="androidx.coordinatorlayout.widget.CoordinatorLayoutActivity"/>
+ <activity
+ android:exported="true"
+ android:theme="@style/Theme.AppCompat.Light"
+ android:name="androidx.coordinatorlayout.widget.CoordinatorWithNestedScrollViewsActivity"
+ />
+
<activity android:name="androidx.coordinatorlayout.widget.DynamicCoordinatorLayoutActivity"/>
</application>
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/testutils/AppBarStateChangedListener.java b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/testutils/AppBarStateChangedListener.java
new file mode 100644
index 0000000..dad1a24
--- /dev/null
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/testutils/AppBarStateChangedListener.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.coordinatorlayout.testutils;
+
+import com.google.android.material.appbar.AppBarLayout;
+/**
+ * Allows tests to determine if an AppBarLayout with a CollapsingToolbarLayout is expanded,
+ * animating, or collapsed.
+ */
+public abstract class AppBarStateChangedListener implements AppBarLayout.OnOffsetChangedListener {
+ public enum State { UNKNOWN, ANIMATING, EXPANDED, COLLAPSED }
+
+ private State mExistingState = State.UNKNOWN;
+
+ @Override
+ public final void onOffsetChanged(AppBarLayout appBarLayout, int verticalOffset) {
+ // Collapsed
+ if (Math.abs(verticalOffset) >= appBarLayout.getTotalScrollRange()) {
+ setStateAndNotify(appBarLayout, State.COLLAPSED);
+
+ // Expanded
+ } else if (verticalOffset == 0) {
+ setStateAndNotify(appBarLayout, State.EXPANDED);
+
+ // Animating
+ } else {
+ setStateAndNotify(appBarLayout, State.ANIMATING);
+ }
+ }
+
+ private void setStateAndNotify(AppBarLayout appBarLayout, State state) {
+ if (mExistingState != state) {
+ onStateChanged(appBarLayout, state);
+ }
+ mExistingState = state;
+ }
+
+ public abstract void onStateChanged(AppBarLayout appBarLayout, State state);
+}
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/testutils/NestedScrollViewActions.java b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/testutils/NestedScrollViewActions.java
new file mode 100644
index 0000000..8c18bb9
--- /dev/null
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/testutils/NestedScrollViewActions.java
@@ -0,0 +1,110 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.coordinatorlayout.testutils;
+
+import static androidx.test.espresso.matcher.ViewMatchers.isAssignableFrom;
+import static androidx.test.espresso.matcher.ViewMatchers.isDescendantOfA;
+import static androidx.test.espresso.matcher.ViewMatchers.isDisplayingAtLeast;
+import static androidx.test.espresso.matcher.ViewMatchers.withEffectiveVisibility;
+
+import android.util.Log;
+import android.view.View;
+import android.view.ViewParent;
+
+import androidx.core.widget.NestedScrollView;
+import androidx.test.espresso.PerformException;
+import androidx.test.espresso.UiController;
+import androidx.test.espresso.ViewAction;
+import androidx.test.espresso.matcher.ViewMatchers;
+import androidx.test.espresso.util.HumanReadables;
+
+import org.hamcrest.Matcher;
+import org.hamcrest.Matchers;
+
+/**
+ * Supports scrolling with the NestedScrollView in Espresso.
+ */
+public final class NestedScrollViewActions {
+ private static final String TAG = NestedScrollViewActions.class.getSimpleName();
+
+ public static ViewAction scrollToTop() {
+ return new ViewAction() {
+ @Override
+ public Matcher<View> getConstraints() {
+ return Matchers.allOf(
+ isDescendantOfA(isAssignableFrom(NestedScrollView.class)),
+ withEffectiveVisibility(ViewMatchers.Visibility.VISIBLE)
+ );
+ }
+
+ @Override
+ public String getDescription() {
+ return "Find the first NestedScrollView parent (of the matched view) and "
+ + "scroll to it.";
+ }
+
+ @Override
+ public void perform(UiController uiController, View view) {
+ if (isDisplayingAtLeast(90).matches(view)) {
+ Log.i(TAG, "View is already completely displayed at top. Returning.");
+ return;
+ }
+ try {
+ NestedScrollView nestedScrollView = findFirstNestedScrollViewParent(view);
+
+ if (nestedScrollView != null) {
+ nestedScrollView.scrollTo(0, view.getTop());
+ } else {
+ throw new Exception("Can not find NestedScrollView parent.");
+ }
+
+ } catch (Exception exception) {
+ throw new PerformException.Builder()
+ .withActionDescription(this.getDescription())
+ .withViewDescription(HumanReadables.describe(view))
+ .withCause(exception)
+ .build();
+ }
+ uiController.loopMainThreadUntilIdle();
+
+ if (!isDisplayingAtLeast(90).matches(view)) {
+ throw new PerformException.Builder()
+ .withActionDescription(this.getDescription())
+ .withViewDescription(HumanReadables.describe(view))
+ .withCause(
+ new RuntimeException(
+ "Scrolling to view was attempted, but the view is"
+ + "not displayed"))
+ .build();
+ }
+ }
+ };
+ }
+
+ private static NestedScrollView findFirstNestedScrollViewParent(View view) {
+ ViewParent viewParent = view.getParent();
+
+ while (viewParent != null && !(viewParent.getClass() == NestedScrollView.class)) {
+ viewParent = viewParent.getParent();
+ }
+
+ if (viewParent == null) {
+ return null;
+ } else {
+ return (NestedScrollView) viewParent;
+ }
+ }
+}
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/widget/CoordinatorLayoutKeyEventTest.java b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/widget/CoordinatorLayoutKeyEventTest.java
new file mode 100644
index 0000000..d31a488
--- /dev/null
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/widget/CoordinatorLayoutKeyEventTest.java
@@ -0,0 +1,139 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.coordinatorlayout.widget;
+
+import static androidx.test.espresso.Espresso.onView;
+import static androidx.test.espresso.action.ViewActions.pressKey;
+import static androidx.test.espresso.action.ViewActions.swipeUp;
+import static androidx.test.espresso.assertion.ViewAssertions.matches;
+import static androidx.test.espresso.matcher.ViewMatchers.isCompletelyDisplayed;
+import static androidx.test.espresso.matcher.ViewMatchers.withId;
+
+import static org.junit.Assert.assertEquals;
+
+import android.view.KeyEvent;
+
+import androidx.coordinatorlayout.test.R;
+import androidx.coordinatorlayout.testutils.AppBarStateChangedListener;
+import androidx.coordinatorlayout.testutils.NestedScrollViewActions;
+import androidx.test.ext.junit.rules.ActivityScenarioRule;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.filters.LargeTest;
+import androidx.test.platform.app.InstrumentationRegistry;
+import androidx.testutils.PollingCheck;
+
+import com.google.android.material.appbar.AppBarLayout;
+
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+@SuppressWarnings({"unchecked", "rawtypes"})
+@LargeTest
+@RunWith(AndroidJUnit4.class)
+public class CoordinatorLayoutKeyEventTest {
+
+ // test rule
+ @Rule
+ public ActivityScenarioRule<CoordinatorWithNestedScrollViewsActivity> mActivityScenarioRule =
+ new ActivityScenarioRule(CoordinatorWithNestedScrollViewsActivity.class);
+
+ private AppBarLayout mAppBarLayout;
+ private AppBarStateChangedListener.State mAppBarState =
+ AppBarStateChangedListener.State.UNKNOWN;
+
+ @Before
+ public void setup() {
+ mActivityScenarioRule.getScenario().onActivity(activity -> {
+ mAppBarLayout = activity.mAppBarLayout;
+ mAppBarLayout.addOnOffsetChangedListener(new AppBarStateChangedListener() {
+ @Override
+ public void onStateChanged(AppBarLayout appBarLayout, State state) {
+ mAppBarState = state;
+ }
+ });
+ });
+ InstrumentationRegistry.getInstrumentation().waitForIdleSync();
+ }
+
+ /*** Tests ***/
+ @Test
+ @LargeTest
+ public void isCollapsingToolbarExpanded_swipeDownMultipleKeysUp_isExpanded() {
+
+ onView(withId(R.id.top_nested_text)).check(matches(isCompletelyDisplayed()));
+
+ // Scrolls down content and collapses the CollapsingToolbarLayout in the AppBarLayout.
+ onView(withId(R.id.top_nested_text)).perform(swipeUp());
+ InstrumentationRegistry.getInstrumentation().waitForIdleSync();
+
+ // Espresso doesn't properly support swipeUp() with a CoordinatorLayout,
+ // AppBarLayout/CollapsingToolbarLayout, and NestedScrollView. From testing, it only
+ // handles waiting until the AppBarLayout/CollapsingToolbarLayout is finished with its
+ // transition, NOT waiting until the NestedScrollView is finished with its scrolling.
+ // This PollingCheck waits until the scroll is finished in the NestedScrollView.
+ AtomicInteger previousScroll = new AtomicInteger();
+ PollingCheck.waitFor(() -> {
+ AtomicInteger currentScroll = new AtomicInteger();
+
+ mActivityScenarioRule.getScenario().onActivity(activity -> {
+ currentScroll.set(activity.mNestedScrollView.getScrollY());
+ });
+
+ boolean isDone = currentScroll.get() == previousScroll.get();
+ previousScroll.set(currentScroll.get());
+
+ return isDone;
+ });
+
+ // Verifies the CollapsingToolbarLayout in the AppBarLayout is collapsed.
+ assertEquals(mAppBarState, AppBarStateChangedListener.State.COLLAPSED);
+
+ // Scrolls up to the top element in the NestedScrollView.
+ // NOTE: NestedScrollView requires a custom Action to work properly and the scroll does NOT
+ // impact the CoordinatorLayout's CollapsingToolbarLayout (which stays collapsed).
+ onView(withId(R.id.top_nested_text)).perform(NestedScrollViewActions.scrollToTop());
+ InstrumentationRegistry.getInstrumentation().waitForIdleSync();
+ onView(withId(R.id.top_nested_text)).check(matches(isCompletelyDisplayed()));
+
+ // First up keystroke gains focus (doesn't move any content).
+ onView(withId(R.id.top_nested_text)).perform(pressKey(KeyEvent.KEYCODE_DPAD_UP));
+ InstrumentationRegistry.getInstrumentation().waitForIdleSync();
+ onView(withId(R.id.top_nested_text)).check(matches(isCompletelyDisplayed()));
+
+ // This is a fail-safe in case the DPAD UP isn't making any changes, we break out of the
+ // loop.
+ float previousAppBarLayoutY = 0.0f;
+
+ // Performs a key press until the app bar is either expanded completely or no changes are
+ // made in the app bar between the previous call and the current call (failure case).
+ while (mAppBarState != AppBarStateChangedListener.State.EXPANDED
+ && (mAppBarLayout.getY() != previousAppBarLayoutY)
+ ) {
+ previousAppBarLayoutY = mAppBarLayout.getY();
+
+ // Partially expands the CollapsingToolbarLayout.
+ onView(withId(R.id.top_nested_text)).perform(pressKey(KeyEvent.KEYCODE_DPAD_UP));
+ InstrumentationRegistry.getInstrumentation().waitForIdleSync();
+ }
+
+ // Checks CollapsingToolbarLayout (in the AppBarLayout) is fully expanded.
+ assertEquals(mAppBarState, AppBarStateChangedListener.State.EXPANDED);
+ }
+}
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/widget/CoordinatorWithNestedScrollViewsActivity.java b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/widget/CoordinatorWithNestedScrollViewsActivity.java
new file mode 100644
index 0000000..a8961bd
--- /dev/null
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/java/androidx/coordinatorlayout/widget/CoordinatorWithNestedScrollViewsActivity.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.coordinatorlayout.widget;
+
+import androidx.coordinatorlayout.BaseTestActivity;
+import androidx.coordinatorlayout.test.R;
+import androidx.core.widget.NestedScrollView;
+
+import com.google.android.material.appbar.AppBarLayout;
+import com.google.android.material.appbar.CollapsingToolbarLayout;
+
+public class CoordinatorWithNestedScrollViewsActivity extends BaseTestActivity {
+ AppBarLayout mAppBarLayout;
+ NestedScrollView mNestedScrollView;
+
+ @Override
+ protected int getContentViewLayoutResId() {
+ return R.layout.activity_coordinator_with_nested_scroll_views;
+ }
+
+ @Override
+ protected void onContentViewSet() {
+ mAppBarLayout = findViewById(R.id.app_bar_layout);
+ mNestedScrollView = findViewById(R.id.top_nested_scroll_view);
+
+ CollapsingToolbarLayout collapsingToolbarLayout =
+ findViewById(R.id.collapsing_toolbar_layout);
+
+ collapsingToolbarLayout.setTitle("Collapsing Bar Test");
+ }
+}
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/res/layout/activity_coordinator_with_nested_scroll_views.xml b/coordinatorlayout/coordinatorlayout/src/androidTest/res/layout/activity_coordinator_with_nested_scroll_views.xml
new file mode 100644
index 0000000..f463373
--- /dev/null
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/res/layout/activity_coordinator_with_nested_scroll_views.xml
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Copyright 2022 The Android Open Source Project
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<androidx.coordinatorlayout.widget.CoordinatorLayout
+ xmlns:android="http://schemas.android.com/apk/res/android"
+ xmlns:app="http://schemas.android.com/apk/res-auto"
+ android:id="@+id/coordinator"
+ android:fitsSystemWindows="true"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent">
+
+ <!-- App Bar -->
+ <com.google.android.material.appbar.AppBarLayout
+ android:id="@+id/app_bar_layout"
+ android:layout_width="match_parent"
+ android:layout_height="200dp">
+
+ <com.google.android.material.appbar.CollapsingToolbarLayout
+ android:id="@+id/collapsing_toolbar_layout"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent"
+ app:expandedTitleMarginStart="48dp"
+ app:expandedTitleMarginEnd="64dp"
+ app:layout_scrollFlags="scroll|exitUntilCollapsed"
+ app:contentScrim="#00FFFF">
+
+ <View android:layout_width="match_parent"
+ android:layout_height="200dp"
+ android:background="#FF0000"/>
+
+ <androidx.appcompat.widget.Toolbar
+ android:id="@+id/toolbar"
+ android:layout_width="match_parent"
+ android:layout_height="?attr/actionBarSize"
+ app:layout_collapseMode="pin"/>
+ </com.google.android.material.appbar.CollapsingToolbarLayout>
+ </com.google.android.material.appbar.AppBarLayout>
+
+ <!-- Content -->
+ <androidx.core.widget.NestedScrollView
+ android:id="@+id/top_nested_scroll_view"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent"
+ app:layout_behavior="@string/appbar_scrolling_view_behavior"
+ android:padding="16dp">
+
+ <LinearLayout
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:orientation="vertical">
+
+ <TextView
+ android:id="@+id/top_nested_text"
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:focusableInTouchMode="true"
+ android:background="#00FF00"
+ android:text="@string/medium_text"
+ android:textAppearance="?android:attr/textAppearance"/>
+
+ <androidx.core.widget.NestedScrollView
+ android:layout_width="match_parent"
+ android:layout_height="400dp"
+ android:padding="16dp">
+
+ <LinearLayout
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:orientation="vertical">
+
+ <TextView
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:text="@string/short_text"
+ android:textAppearance="?android:attr/textAppearance"/>
+
+ <androidx.core.widget.NestedScrollView
+ android:layout_width="match_parent"
+ android:layout_height="200dp"
+ android:padding="16dp">
+
+ <TextView
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:text="@string/long_text"
+ android:textAppearance="?android:attr/textAppearance"/>
+ </androidx.core.widget.NestedScrollView>
+ <TextView
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:text="@string/long_text"
+ android:textAppearance="?android:attr/textAppearance"/>
+ </LinearLayout>
+ </androidx.core.widget.NestedScrollView>
+ <TextView
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:text="@string/long_text"
+ android:textAppearance="?android:attr/textAppearance"/>
+ </LinearLayout>
+ </androidx.core.widget.NestedScrollView>
+</androidx.coordinatorlayout.widget.CoordinatorLayout>
diff --git a/coordinatorlayout/coordinatorlayout/src/androidTest/res/values/strings.xml b/coordinatorlayout/coordinatorlayout/src/androidTest/res/values/strings.xml
new file mode 100644
index 0000000..285994a
--- /dev/null
+++ b/coordinatorlayout/coordinatorlayout/src/androidTest/res/values/strings.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Copyright 2022 The Android Open Source Project
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<resources>
+ <string name="short_text">a short string for nested scroll view tests.</string>
+ <string name="medium_text">
+ This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going.
+ </string>
+ <string name="long_text">
+ This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it.
+ This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it. This is some long text. It just keeps going. Look at it. Scroll it. Scroll the nested version of it.
+ </string>
+ <string name="appbar_scrolling_view_behavior" translatable="false">com.google.android.material.appbar.AppBarLayout$ScrollingViewBehavior</string>
+</resources>
diff --git a/coordinatorlayout/coordinatorlayout/src/main/java/androidx/coordinatorlayout/widget/CoordinatorLayout.java b/coordinatorlayout/coordinatorlayout/src/main/java/androidx/coordinatorlayout/widget/CoordinatorLayout.java
index dbb1b5e..71b0362 100644
--- a/coordinatorlayout/coordinatorlayout/src/main/java/androidx/coordinatorlayout/widget/CoordinatorLayout.java
+++ b/coordinatorlayout/coordinatorlayout/src/main/java/androidx/coordinatorlayout/widget/CoordinatorLayout.java
@@ -18,6 +18,7 @@
import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX;
+import android.annotation.SuppressLint;
import android.content.Context;
import android.content.res.Resources;
import android.content.res.TypedArray;
@@ -37,6 +38,7 @@
import android.util.Log;
import android.util.SparseArray;
import android.view.Gravity;
+import android.view.KeyEvent;
import android.view.MotionEvent;
import android.view.View;
import android.view.ViewGroup;
@@ -1793,6 +1795,7 @@
@SuppressWarnings("unchecked")
public boolean onStartNestedScroll(@NonNull View child, @NonNull View target,
int axes, int type) {
+
boolean handled = false;
final int childCount = getChildCount();
@@ -1935,6 +1938,140 @@
}
@Override
+ public boolean dispatchKeyEvent(
+ @SuppressLint("InvalidNullabilityOverride") @NonNull KeyEvent event
+ ) {
+ boolean handled = super.dispatchKeyEvent(event);
+
+ if (!handled) {
+ if (event.getAction() == KeyEvent.ACTION_DOWN) {
+ switch (event.getKeyCode()) {
+ case KeyEvent.KEYCODE_DPAD_UP:
+ case KeyEvent.KEYCODE_DPAD_DOWN:
+ case KeyEvent.KEYCODE_SPACE:
+
+ int yScrollDelta;
+
+ if (event.getKeyCode() == KeyEvent.KEYCODE_SPACE) {
+ if (event.isShiftPressed()) {
+ // Places the CoordinatorLayout at the top of the available
+ // content.
+ // Note: The delta may represent a value that would overshoot the
+ // top of the screen, but the children only use as much of the
+ // delta as they can support, so it will always go exactly to the
+ // top.
+ yScrollDelta = -getFullContentHeight();
+ } else {
+ // Places the CoordinatorLayout at the bottom of the available
+ // content.
+ yScrollDelta = getFullContentHeight() - getHeight();
+ }
+
+ } else if (event.isAltPressed()) { // For UP and DOWN KeyEvents
+ // Full page scroll
+ yScrollDelta = getHeight();
+
+ } else {
+ // Regular arrow scroll
+ yScrollDelta = (int) (getHeight() * 0.1f);
+ }
+
+ View focusedView = findDeepestFocusedChild(this);
+
+ // Convert delta to negative if the key event is UP.
+ if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_UP) {
+ yScrollDelta = -yScrollDelta;
+ }
+
+ handled = manuallyTriggersNestedScrollFromKeyEvent(
+ focusedView,
+ yScrollDelta
+ );
+
+ break;
+ }
+ }
+ }
+
+ return handled;
+ }
+
+ private View findDeepestFocusedChild(View startingParentView) {
+ View focusedView = startingParentView;
+ while (focusedView != null) {
+ if (focusedView.isFocused()) {
+ return focusedView;
+ }
+ focusedView = focusedView instanceof ViewGroup
+ ? ((ViewGroup) focusedView).getFocusedChild()
+ : null;
+ }
+ return null;
+ }
+
+ /*
+ * Returns the height by adding up all children's heights (this is often larger than the screen
+ * height).
+ */
+ private int getFullContentHeight() {
+ int scrollRange = 0;
+ for (int i = 0; i < getChildCount(); i++) {
+ View child = getChildAt(i);
+ CoordinatorLayout.LayoutParams lp =
+ (CoordinatorLayout.LayoutParams) child.getLayoutParams();
+ int childSize = child.getHeight() + lp.topMargin + lp.bottomMargin;
+ scrollRange += childSize;
+ }
+ return scrollRange;
+ }
+
+ /* This method only triggers when the focused child has passed on handling the
+ * KeyEvent to scroll (meaning the child is already scrolled as far as it can in that
+ * direction).
+ *
+ * For example, a key event should still expand/collapse a CollapsingAppBar event though the
+ * a NestedScrollView is at the top/bottom of its content.
+ */
+ private boolean manuallyTriggersNestedScrollFromKeyEvent(View focusedView, int yScrollDelta) {
+ boolean handled = false;
+
+ /* If this method is triggered and the event is triggered by a child, it means the
+ * child can't scroll any farther (and passed the event back up to the CoordinatorLayout),
+ * so the CoordinatorLayout triggers its own nested scroll to move content.
+ *
+ * To properly manually trigger onNestedScroll(), we need to
+ * 1. Call onStartNestedScroll() before onNestedScroll()
+ * 2. Call onNestedScroll() and pass this CoordinatorLayout as the child (because that is
+ * what we want to scroll
+ * 3. Call onStopNestedScroll() after onNestedScroll()
+ */
+ onStartNestedScroll(
+ this, // Passes the CoordinatorLayout itself, since we want it to scroll.
+ focusedView,
+ ViewCompat.SCROLL_AXIS_VERTICAL,
+ ViewCompat.TYPE_NON_TOUCH
+ );
+
+ onNestedScroll(
+ focusedView,
+ 0,
+ 0,
+ 0,
+ yScrollDelta,
+ ViewCompat.TYPE_NON_TOUCH,
+ mBehaviorConsumed
+ );
+
+ onStopNestedScroll(focusedView, ViewCompat.TYPE_NON_TOUCH);
+
+ if (mBehaviorConsumed[1] > 0) {
+ handled = true;
+ }
+
+ return handled;
+ }
+
+ @Override
public void onNestedPreScroll(@NonNull View target, int dx, int dy,
@NonNull int[] consumed) {
onNestedPreScroll(target, dx, dy, consumed, ViewCompat.TYPE_TOUCH);
@@ -3083,6 +3220,7 @@
}
void setNestedScrollAccepted(int type, boolean accept) {
+
switch (type) {
case ViewCompat.TYPE_TOUCH:
mDidAcceptNestedScrollTouch = accept;
diff --git a/core/core/src/androidTest/java/androidx/core/widget/NestedScrollViewWithCollapsingToolbarTest.java b/core/core/src/androidTest/java/androidx/core/widget/NestedScrollViewWithCollapsingToolbarTest.java
index 47133e0..74a1306 100644
--- a/core/core/src/androidTest/java/androidx/core/widget/NestedScrollViewWithCollapsingToolbarTest.java
+++ b/core/core/src/androidTest/java/androidx/core/widget/NestedScrollViewWithCollapsingToolbarTest.java
@@ -21,16 +21,16 @@
import android.content.Context;
import android.util.AttributeSet;
import android.view.InputDevice;
+import android.view.KeyEvent;
import android.view.MotionEvent;
import android.view.View;
import android.widget.FrameLayout;
import android.widget.LinearLayout;
import android.widget.TextView;
-import androidx.annotation.NonNull;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
-import androidx.test.filters.SmallTest;
+import androidx.test.filters.MediumTest;
import org.junit.Test;
import org.junit.runner.RunWith;
@@ -39,7 +39,7 @@
* Tests that CollapsingToolbarLayout properly collapses/expands with a NestedScrollView.
*/
@RunWith(AndroidJUnit4.class)
-@SmallTest
+@MediumTest
public class NestedScrollViewWithCollapsingToolbarTest {
private static final String LONG_TEXT = "This is some long text. It just keeps going. Look at"
+ " it. Scroll it. Scroll the nested version of it. This is some long text. It just"
@@ -72,8 +72,9 @@
private MockCoordinatorLayoutWithCollapsingToolbarAndNestedScrollView mChildNestedScrollView;
+ /*** Touch swiping tests at the top/bottom of the child ***/
@Test
- public void isOnStartNestedScrollTriggered_touchSwipeUpInChild_triggeredInParent() {
+ public void isOnStartNestedScrollCalled_touchSwipeUpInChild_calledInParent() {
// Arrange
setupNestedScrollViewInNestedScrollView(
ApplicationProvider.getApplicationContext(),
@@ -92,7 +93,7 @@
}
@Test
- public void isOnStartNestedScrollTriggered_touchSwipeDownInChild_triggeredInParent() {
+ public void isOnStartNestedScrollCalled_touchSwipeDownInChild_calledInParent() {
// Arrange
setupNestedScrollViewInNestedScrollView(
ApplicationProvider.getApplicationContext(),
@@ -110,9 +111,9 @@
assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
}
-
+ /*** Rotary scrolling tests at the top/bottom of the child ***/
@Test
- public void isOnStartNestedScrollTriggered_rotaryScrollInChildPastTop_triggeredInParent() {
+ public void isOnStartNestedScrollCalled_rotaryScrollInChildPastTop_calledInParent() {
// Arrange
setupNestedScrollViewInNestedScrollView(
ApplicationProvider.getApplicationContext(),
@@ -134,7 +135,7 @@
}
@Test
- public void isOnStartNestedScrollTriggered_rotaryScrollInChildPastBottom_triggeredInParent() {
+ public void isOnStartNestedScrollCalled_rotaryScrollInChildPastBottom_calledInParent() {
// Arrange
setupNestedScrollViewInNestedScrollView(
ApplicationProvider.getApplicationContext(),
@@ -158,8 +159,9 @@
assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
}
+ /*** Mouse scrolling tests at the top/bottom of the child ***/
@Test
- public void isOnStartNestedScrollTriggered_mouseScrollInChildPastTop_triggeredInParent() {
+ public void isOnStartNestedScrollCalled_mouseScrollInChildPastTop_calledInParent() {
// Arrange
setupNestedScrollViewInNestedScrollView(
ApplicationProvider.getApplicationContext(),
@@ -181,7 +183,7 @@
}
@Test
- public void isOnStartNestedScrollTriggered_mouseScrollInChildPastBottom_triggeredInParent() {
+ public void isOnStartNestedScrollCalled_mouseScrollInChildPastBottom_calledInParent() {
// Arrange
setupNestedScrollViewInNestedScrollView(
ApplicationProvider.getApplicationContext(),
@@ -205,6 +207,319 @@
assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
}
+ /*** Keyboard event tests BOTH inside the child and at the top/bottom of the child ***/
+ // Keyboard events within the child (should trigger OnStartNestedScroll() in parent)
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardUpInChild_calledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+
+ // Move to bottom of the child NestedScrollView, so we can scroll up and not go past child.
+ int scrollRange = mChildNestedScrollView.getScrollRange();
+ mChildNestedScrollView.scrollTo(0, scrollRange);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_DPAD_UP,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_DPAD_UP,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger a scroll event in parent. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ assertEquals(1, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardDownInChild_calledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_DPAD_DOWN,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_DPAD_DOWN,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger a scroll event in parent. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ // Should trigger in parent of scroll event.
+ assertEquals(1, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+ // Keyboard events at the top/bottom bounds of the child (should NOT trigger
+ // OnStartNestedScroll() in the parent).
+
+ // For events at the bounds of the nested child, Keyboard events are handled a little different
+ // from the rest. If they are at the bound, they will not handle the event
+ // (return false) and so the container view will handle it (something like CoordinatorLayout).
+ // Where with the other types (from Touch, Rotary, and Scroll), the NestedScrollView will
+ // handle those bound crossing events itself, and thus why these tests don't have a
+ // OnStartNestedScroll() in the parent
+
+ // Keyboard events inside the child (should still trigger OnStartNestedScroll() in parent)
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardUpInChildPastTop_notCalledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_DPAD_UP,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_DPAD_UP,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger in parent of scroll event. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ assertEquals(0, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardDownInChildPastBottom_notCalledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+ // Move to bottom of the child NestedScrollView, so we can try scrolling past it.
+ int scrollRange = mChildNestedScrollView.getScrollRange();
+ mChildNestedScrollView.scrollTo(0, scrollRange);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_DPAD_DOWN,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_DPAD_DOWN,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger in parent of scroll event. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ // Should trigger in parent of scroll event.
+ assertEquals(0, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardAltUpInChildPastTop_notCalledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_DPAD_UP,
+ 0,
+ KeyEvent.META_ALT_ON | KeyEvent.META_ALT_LEFT_ON
+ );
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_DPAD_UP,
+ 0,
+ KeyEvent.META_ALT_ON | KeyEvent.META_ALT_LEFT_ON
+ );
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger in parent of scroll event. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ // Should trigger in parent of scroll event.
+ assertEquals(0, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardAltDownInChildPastBottom_notCalledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+ // Move to bottom of the child NestedScrollView, so we can try scrolling past it.
+ int scrollRange = mChildNestedScrollView.getScrollRange();
+ mChildNestedScrollView.scrollTo(0, scrollRange);
+
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_DPAD_DOWN,
+ 0,
+ KeyEvent.META_ALT_ON | KeyEvent.META_ALT_LEFT_ON
+ );
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_DPAD_DOWN,
+ 0,
+ KeyEvent.META_ALT_ON | KeyEvent.META_ALT_LEFT_ON
+ );
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger in parent of scroll event. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ // Should trigger in parent of scroll event.
+ assertEquals(0, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardShiftSpaceInChildPastTop_notCalledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_SPACE,
+ 0,
+ KeyEvent.META_SHIFT_ON);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_SPACE,
+ 0,
+ KeyEvent.META_SHIFT_ON);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger in parent of scroll event. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ // Should trigger in parent of scroll event.
+ assertEquals(0, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
+
+ @Test
+ public void isOnStartNestedScrollCalled_keyboardSpaceInChildPastBottom_notCalledInParent() {
+ // Arrange
+ setupNestedScrollViewInNestedScrollView(
+ ApplicationProvider.getApplicationContext(),
+ 100,
+ 600);
+ // Move to bottom of the child NestedScrollView, so we can try scrolling past it.
+ int scrollRange = mChildNestedScrollView.getScrollRange();
+ mChildNestedScrollView.scrollTo(0, scrollRange);
+
+ // Act
+ mChildNestedScrollView.requestFocus();
+ KeyEvent keyEventPressDown = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_DOWN,
+ KeyEvent.KEYCODE_SPACE,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressDown);
+
+ KeyEvent keyEventPressUp = new KeyEvent(
+ 0,
+ 0,
+ KeyEvent.ACTION_UP,
+ KeyEvent.KEYCODE_SPACE,
+ 0);
+ mChildNestedScrollView.executeKeyEvent(keyEventPressUp);
+
+ // Assert
+ // Should trigger in parent of scroll event. Note: OnStartNestedScroll is triggered on
+ // key action down only, not key action up, so that is why the count is one.
+ // Should trigger in parent of scroll event.
+ assertEquals(0, mParentNestedScrollView.getOnStartNestedScrollCount());
+ // Should not trigger in child (because child doesn't have its own inner NestedScrollView).
+ assertEquals(0, mChildNestedScrollView.getOnStartNestedScrollCount());
+ }
private TextView createTextView(Context context, int width, int height, String textContent) {
TextView textView = new TextView(context);
@@ -221,10 +536,13 @@
}
private void setupNestedScrollViewInNestedScrollView(Context context, int width, int height) {
+
+ // 1. Setup Views
+
// The parent NestedScrollView contains a LinearLayout with three Views:
- // 1. TextView
- // 2. A child NestedScrollView (contains its own TextView)
- // 3. TextView
+ // a. TextView
+ // b. A child NestedScrollView (contains its own TextView)
+ // c. TextView
int childHeight = height / 3;
// Creates child NestedScrollView first
@@ -264,6 +582,16 @@
mParentNestedScrollView.setMinimumHeight(height);
mParentNestedScrollView.setBackgroundColor(0xCC00FF00);
mParentNestedScrollView.addView(linearLayout);
+
+ // 2. Measure Parent
+ int measureSpecWidth =
+ View.MeasureSpec.makeMeasureSpec(width, View.MeasureSpec.EXACTLY);
+ int measureSpecHeight =
+ View.MeasureSpec.makeMeasureSpec(height, View.MeasureSpec.EXACTLY);
+ mParentNestedScrollView.measure(measureSpecWidth, measureSpecHeight);
+
+ // 3. Layout Parent
+ mParentNestedScrollView.layout(0, 0, width, height);
}
private void swipeDown(View view, boolean shortSwipe) {
@@ -373,12 +701,7 @@
}
@Override
- public boolean onStartNestedScroll(
- @NonNull View child,
- @NonNull View target,
- int axes,
- int type
- ) {
+ public boolean onStartNestedScroll(View child, View target, int axes, int type) {
mOnStartNestedScrollCount++;
return super.onStartNestedScroll(child, target, axes, type);
}
diff --git a/core/core/src/main/java/androidx/core/widget/NestedScrollView.java b/core/core/src/main/java/androidx/core/widget/NestedScrollView.java
index 24b6a4b..279e003 100644
--- a/core/core/src/main/java/androidx/core/widget/NestedScrollView.java
+++ b/core/core/src/main/java/androidx/core/widget/NestedScrollView.java
@@ -1034,17 +1034,19 @@
/*
* Handles scroll events for both touch and non-touch events (mouse scroll wheel,
- * rotary button, etc.).
+ * rotary button, keyboard, etc.).
*
- * Note: This returns the total scroll offset for touch event which is required for calculating
- * the scroll between move events. This returned value is NOT needed for non-touch events since
- * a scroll is a one time event.
+ * Note: This function returns the total scroll offset for this scroll event which is required
+ * for calculating the total scroll between multiple move events (touch). This returned value
+ * is NOT needed for non-touch events since a scroll is a one time event (vs. touch where a
+ * drag may be triggered multiple times with the movement of the finger).
*/
+ // TODO: You should rename this to nestedScrollBy() so it is different from View.scrollBy
private int scrollBy(
int verticalScrollDistance,
int x,
int touchType,
- boolean isSourceMouse
+ boolean isSourceMouseOrKeyboard
) {
int totalScrollOffset = 0;
@@ -1081,7 +1083,7 @@
// Overscroll is for adding animations at the top/bottom of a view when the user scrolls
// beyond the beginning/end of the view. Overscroll is not used with a mouse.
- boolean canOverscroll = canOverScroll() && !isSourceMouse;
+ boolean canOverscroll = canOverScroll() && !isSourceMouseOrKeyboard;
// Scrolls content in the current View, but clamps it if it goes too far.
boolean hitScrollBarrier =
@@ -1585,7 +1587,6 @@
mTempRect.top = mTempRect.bottom - height;
}
}
-
return scrollAndFocus(direction, mTempRect.top, mTempRect.bottom);
}
@@ -1618,7 +1619,7 @@
handled = false;
} else {
int delta = up ? (top - containerTop) : (bottom - containerBottom);
- doScrollY(delta);
+ scrollBy(delta, 0, ViewCompat.TYPE_NON_TOUCH, true);
}
if (newFocused != findFocus()) newFocused.requestFocus(direction);
@@ -1645,8 +1646,10 @@
nextFocused.getDrawingRect(mTempRect);
offsetDescendantRectToMyCoords(nextFocused, mTempRect);
int scrollDelta = computeScrollDeltaToGetChildRectOnScreen(mTempRect);
- doScrollY(scrollDelta);
+
+ scrollBy(scrollDelta, 0, ViewCompat.TYPE_NON_TOUCH, true);
nextFocused.requestFocus(direction);
+
} else {
// no new focus
int scrollDelta = maxJump;
@@ -1665,7 +1668,9 @@
if (scrollDelta == 0) {
return false;
}
- doScrollY(direction == View.FOCUS_DOWN ? scrollDelta : -scrollDelta);
+
+ int finalScrollDelta = direction == View.FOCUS_DOWN ? scrollDelta : -scrollDelta;
+ scrollBy(finalScrollDelta, 0, ViewCompat.TYPE_NON_TOUCH, true);
}
if (currentFocused != null && currentFocused.isFocused()
