java.lang.Object
↳androidx.core.view.ViewParentCompat
Gradle dependencies
compile group: 'androidx.core', name: 'core', version: '1.15.0-alpha02'
- groupId: androidx.core
- artifactId: core
- version: 1.15.0-alpha02
Artifact androidx.core:core:1.15.0-alpha02 it located at Google repository (https://maven.google.com/)
Androidx artifact mapping:
androidx.core:core com.android.support:support-compat
Androidx class mapping:
androidx.core.view.ViewParentCompat android.support.v4.view.ViewParentCompat
Overview
Helper for accessing features in .
Summary
Methods |
---|
public static void | notifySubtreeAccessibilityStateChanged(ViewParent parent, View child, View source, int changeType)
Notifies a view parent that the accessibility state of one of its
descendants has changed and that the structure of the subtree is
different. |
public static boolean | onNestedFling(ViewParent parent, View target, float velocityX, float velocityY, boolean consumed)
Request a fling from a nested scroll. |
public static boolean | onNestedPreFling(ViewParent parent, View target, float velocityX, float velocityY)
React to a nested fling before the target view consumes it. |
public static void | onNestedPreScroll(ViewParent parent, View target, int dx, int dy, int[] consumed[])
React to a nested scroll in progress before the target view consumes a portion of the scroll. |
public static void | onNestedPreScroll(ViewParent parent, View target, int dx, int dy, int[] consumed[], int type)
React to a nested scroll in progress before the target view consumes a portion of the scroll. |
public static void | onNestedScroll(ViewParent parent, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed)
React to a nested scroll in progress. |
public static void | onNestedScroll(ViewParent parent, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type)
React to a nested scroll in progress. |
public static void | onNestedScroll(ViewParent parent, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type, int[] consumed[])
React to a nested scroll in progress. |
public static void | onNestedScrollAccepted(ViewParent parent, View child, View target, int nestedScrollAxes)
React to the successful claiming of a nested scroll operation. |
public static void | onNestedScrollAccepted(ViewParent parent, View child, View target, int nestedScrollAxes, int type)
React to the successful claiming of a nested scroll operation. |
public static boolean | onStartNestedScroll(ViewParent parent, View child, View target, int nestedScrollAxes)
React to a descendant view initiating a nestable scroll operation, claiming the
nested scroll operation if appropriate. |
public static boolean | onStartNestedScroll(ViewParent parent, View child, View target, int nestedScrollAxes, int type)
React to a descendant view initiating a nestable scroll operation, claiming the
nested scroll operation if appropriate. |
public static void | onStopNestedScroll(ViewParent parent, View target)
React to a nested scroll operation ending. |
public static void | onStopNestedScroll(ViewParent parent, View target, int type)
React to a nested scroll operation ending. |
public static boolean | requestSendAccessibilityEvent(ViewParent parent, View child, AccessibilityEvent event)
Called by a child to request from its parent to send an . |
from java.lang.Object | clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods
public static boolean
requestSendAccessibilityEvent(ViewParent parent, View child, AccessibilityEvent event)
Deprecated: Use
directly.
Called by a child to request from its parent to send an .
The child has already populated a record for itself in the event and is delegating
to its parent to send the event. The parent can optionally add a record for itself.
Note: An accessibility event is fired by an individual view which populates the
event with a record for its state and requests from its parent to perform
the sending. The parent can optionally add a record for itself before
dispatching the request to its parent. A parent can also choose not to
respect the request for sending the event. The accessibility event is sent
by the topmost view in the view tree.
Parameters:
parent: The parent whose method to invoke.
child: The child which requests sending the event.
event: The event to be sent.
Returns:
True if the event was sent.
public static boolean
onStartNestedScroll(ViewParent parent, View child, View target, int nestedScrollAxes)
React to a descendant view initiating a nestable scroll operation, claiming the
nested scroll operation if appropriate.
This version of the method just calls
ViewParentCompat.onStartNestedScroll(ViewParent, View, View, int, int) using the touch input type.
Parameters:
parent: ViewParent that contains the child view.
child: Direct child of this ViewParent containing target
target: View that initiated the nested scroll
nestedScrollAxes: Flags consisting of ViewCompat.SCROLL_AXIS_HORIZONTAL,
ViewCompat.SCROLL_AXIS_VERTICAL or both
Returns:
true if this ViewParent accepts the nested scroll operation
public static void
onNestedScrollAccepted(ViewParent parent, View child, View target, int nestedScrollAxes)
React to the successful claiming of a nested scroll operation.
This version of the method just calls
ViewParentCompat.onNestedScrollAccepted(ViewParent, View, View, int, int) using the touch input type.
Parameters:
parent: ViewParent that contains the child view.
child: Direct child of this ViewParent containing target
target: View that initiated the nested scroll
nestedScrollAxes: Flags consisting of ViewCompat.SCROLL_AXIS_HORIZONTAL,
ViewCompat.SCROLL_AXIS_VERTICAL or both
public static void
onStopNestedScroll(ViewParent parent, View target)
React to a nested scroll operation ending.
This version of the method just calls ViewParentCompat.onStopNestedScroll(ViewParent, View, int)
using the touch input type.
Parameters:
parent: ViewParent that contains the target view.
target: View that initiated the nested scroll
public static void
onNestedScroll(ViewParent parent, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed)
React to a nested scroll in progress.
This version of the method just calls
ViewParentCompat.onNestedScroll(ViewParent, View, int, int, int, int, int) using the touch input
type.
Parameters:
parent: ViewParent that contains the target view.
target: The descendent view controlling the nested scroll
dxConsumed: Horizontal scroll distance in pixels already consumed by target
dyConsumed: Vertical scroll distance in pixels already consumed by target
dxUnconsumed: Horizontal scroll distance in pixels not consumed by target
dyUnconsumed: Vertical scroll distance in pixels not consumed by target
public static void
onNestedScroll(ViewParent parent, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type)
React to a nested scroll in progress.
This method will be called when the ViewParent's current nested scrolling child view
dispatches a nested scroll event. To receive calls to this method the ViewParent must have
previously returned true
for a call to
ViewParentCompat.onStartNestedScroll(ViewParent, View, View, int, int).
Both the consumed and unconsumed portions of the scroll distance are reported to the
ViewParent. An implementation may choose to use the consumed portion to match or chase scroll
position of multiple child elements, for example. The unconsumed portion may be used to
allow continuous dragging of multiple scrolling or draggable elements, such as scrolling
a list within a vertical drawer where the drawer begins dragging once the edge of inner
scrolling content is reached.
Parameters:
parent: ViewParent that contains the target view.
target: The descendant view controlling the nested scroll
dxConsumed: Horizontal scroll distance in pixels already consumed by target
dyConsumed: Vertical scroll distance in pixels already consumed by target
dxUnconsumed: Horizontal scroll distance in pixels not consumed by target
dyUnconsumed: Vertical scroll distance in pixels not consumed by target
type: the type of input which cause this scroll event
public static void
onNestedPreScroll(ViewParent parent, View target, int dx, int dy, int[] consumed[])
React to a nested scroll in progress before the target view consumes a portion of the scroll.
This version of the method just calls
ViewParentCompat.onNestedPreScroll(ViewParent, View, int, int, int[], int) using the touch input
type.
Parameters:
parent: ViewParent that contains the target view.
target: View that initiated the nested scroll
dx: Horizontal scroll distance in pixels
dy: Vertical scroll distance in pixels
consumed: Output. The horizontal and vertical scroll distance consumed by this parent
public static boolean
onStartNestedScroll(ViewParent parent, View child, View target, int nestedScrollAxes, int type)
React to a descendant view initiating a nestable scroll operation, claiming the
nested scroll operation if appropriate.
This method will be called in response to a descendant view invoking
ViewCompat.startNestedScroll(View, int). Each parent up the view hierarchy will be
given an opportunity to respond and claim the nested scrolling operation by returning
true
.
This method may be overridden by ViewParent implementations to indicate when the view
is willing to support a nested scrolling operation that is about to begin. If it returns
true, this ViewParent will become the target view's nested scrolling parent for the duration
of the scroll operation in progress. When the nested scroll is finished this ViewParent
will receive a call to ViewParentCompat.onStopNestedScroll(ViewParent, View, int).
Parameters:
parent: ViewParent that contains the child view.
child: Direct child of this ViewParent containing target
target: View that initiated the nested scroll
nestedScrollAxes: Flags consisting of ViewCompat.SCROLL_AXIS_HORIZONTAL,
ViewCompat.SCROLL_AXIS_VERTICAL or both
type: the type of input which cause this scroll event
Returns:
true if this ViewParent accepts the nested scroll operation
public static void
onNestedScrollAccepted(ViewParent parent, View child, View target, int nestedScrollAxes, int type)
React to the successful claiming of a nested scroll operation.
This method will be called after
onStartNestedScroll returns true.
It offers an opportunity for the view and its superclasses to perform initial configuration
for the nested scroll. Implementations of this method should always call their superclass's
implementation of this method if one is present.
Parameters:
parent: ViewParent that contains the child view.
child: Direct child of this ViewParent containing target
target: View that initiated the nested scroll
nestedScrollAxes: Flags consisting of ViewCompat.SCROLL_AXIS_HORIZONTAL,
ViewCompat.SCROLL_AXIS_VERTICAL or both
type: the type of input which cause this scroll event
See also: ViewParentCompat.onStartNestedScroll(ViewParent, View, View, int), ViewParentCompat.onStopNestedScroll(ViewParent, View, int)
public static void
onStopNestedScroll(ViewParent parent, View target, int type)
React to a nested scroll operation ending.
Perform cleanup after a nested scrolling operation.
This method will be called when a nested scroll stops, for example when a nested touch
scroll ends with a MotionEvent
or MotionEvent
event.
Implementations of this method should always call their superclass's implementation of this
method if one is present.
Parameters:
parent: ViewParent that contains the target view.
target: View that initiated the nested scroll
type: the type of input which cause this scroll event
public static void
onNestedScroll(ViewParent parent, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type, int[] consumed[])
React to a nested scroll in progress.
This method will be called when the ViewParent's current nested scrolling child view
dispatches a nested scroll event. To receive calls to this method the ViewParent must have
previously returned true
for a call to
ViewParentCompat.onStartNestedScroll(ViewParent, View, View, int, int).
Both the consumed and unconsumed portions of the scroll distance are reported to the
ViewParent. An implementation may choose to use the consumed portion to match or chase scroll
position of multiple child elements, for example. The unconsumed portion may be used to
allow continuous dragging of multiple scrolling or draggable elements, such as scrolling
a list within a vertical drawer where the drawer begins dragging once the edge of inner
scrolling content is reached.
Parameters:
parent: ViewParent that contains the target view.
target: The descendent view controlling the nested scroll
dxConsumed: Horizontal scroll distance in pixels already consumed by target
dyConsumed: Vertical scroll distance in pixels already consumed by target
dxUnconsumed: Horizontal scroll distance in pixels not consumed by target
dyUnconsumed: Vertical scroll distance in pixels not consumed by target
type: the type of input which cause this scroll event
consumed: Output. If not null, upon this method returning, will contain the scroll
distances consumed by this nested scrolling parent and the scroll distances
consumed by any other parent up the view hierarchy.
public static void
onNestedPreScroll(ViewParent parent, View target, int dx, int dy, int[] consumed[], int type)
React to a nested scroll in progress before the target view consumes a portion of the scroll.
When working with nested scrolling often the parent view may want an opportunity
to consume the scroll before the nested scrolling child does. An example of this is a
drawer that contains a scrollable list. The user will want to be able to scroll the list
fully into view before the list itself begins scrolling.
onNestedPreScroll
is called when a nested scrolling child invokes
ViewCompat.dispatchNestedPreScroll(View, int, int, int[], int[]). The implementation
should report how any pixels of the scroll reported by dx, dy were consumed in the
consumed
array. Index 0 corresponds to dx and index 1 corresponds to dy.
This parameter will never be null. Initial values for consumed[0] and consumed[1]
will always be 0.
Parameters:
parent: ViewParent that contains the target view.
target: View that initiated the nested scroll
dx: Horizontal scroll distance in pixels
dy: Vertical scroll distance in pixels
consumed: Output. The horizontal and vertical scroll distance consumed by this parent
type: the type of input which cause this scroll event
public static boolean
onNestedFling(ViewParent parent, View target, float velocityX, float velocityY, boolean consumed)
Request a fling from a nested scroll.
This method signifies that a nested scrolling child has detected suitable conditions
for a fling. Generally this means that a touch scroll has ended with a
in the direction of scrolling that meets or exceeds
the
along a scrollable axis.
If a nested scrolling child view would normally fling but it is at the edge of
its own content, it can use this method to delegate the fling to its nested scrolling
parent instead. The parent may optionally consume the fling or observe a child fling.
Parameters:
parent: ViewParent that contains the target view.
target: View that initiated the nested scroll
velocityX: Horizontal velocity in pixels per second
velocityY: Vertical velocity in pixels per second
consumed: true if the child consumed the fling, false otherwise
Returns:
true if this parent consumed or otherwise reacted to the fling
public static boolean
onNestedPreFling(ViewParent parent, View target, float velocityX, float velocityY)
React to a nested fling before the target view consumes it.
This method siginfies that a nested scrolling child has detected a fling with the given
velocity along each axis. Generally this means that a touch scroll has ended with a
in the direction of scrolling that meets or exceeds
the
along a scrollable axis.
If a nested scrolling parent is consuming motion as part of a
pre-scroll, it may be
appropriate for it to also consume the pre-fling to complete that same motion. By returning
true
from this method, the parent indicates that the child should not
fling its own internal content as well.
Parameters:
parent: ViewParent that contains the target view.
target: View that initiated the nested scroll
velocityX: Horizontal velocity in pixels per second
velocityY: Vertical velocity in pixels per second
Returns:
true if this parent consumed the fling ahead of the target view
public static void
notifySubtreeAccessibilityStateChanged(ViewParent parent, View child, View source, int changeType)
Deprecated: Call directly.
Notifies a view parent that the accessibility state of one of its
descendants has changed and that the structure of the subtree is
different.
Parameters:
parent: ViewParent that contains the target view.
child: The direct child whose subtree has changed.
source: The descendant view that changed.
changeType: A bit mask of the types of changes that occurred. One
or more of:
Source
/*
* Copyright 2018 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.core.view;
import android.os.Build;
import android.util.Log;
import android.view.MotionEvent;
import android.view.VelocityTracker;
import android.view.View;
import android.view.ViewConfiguration;
import android.view.ViewParent;
import android.view.accessibility.AccessibilityEvent;
import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;
/**
* Helper for accessing features in {@link ViewParent}.
*/
public final class ViewParentCompat {
private static final String TAG = "ViewParentCompat";
private static int[] sTempNestedScrollConsumed;
/*
* Hide the constructor.
*/
private ViewParentCompat() {}
/**
* Called by a child to request from its parent to send an {@link AccessibilityEvent}.
* The child has already populated a record for itself in the event and is delegating
* to its parent to send the event. The parent can optionally add a record for itself.
* <p>
* Note: An accessibility event is fired by an individual view which populates the
* event with a record for its state and requests from its parent to perform
* the sending. The parent can optionally add a record for itself before
* dispatching the request to its parent. A parent can also choose not to
* respect the request for sending the event. The accessibility event is sent
* by the topmost view in the view tree.</p>
*
* @param parent The parent whose method to invoke.
* @param child The child which requests sending the event.
* @param event The event to be sent.
* @return True if the event was sent.
*
* @deprecated Use {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
* directly.
*/
@androidx.annotation.ReplaceWith(expression = "parent.requestSendAccessibilityEvent(child, event)")
@Deprecated
public static boolean requestSendAccessibilityEvent(
ViewParent parent, View child, AccessibilityEvent event) {
return parent.requestSendAccessibilityEvent(child, event);
}
/**
* React to a descendant view initiating a nestable scroll operation, claiming the
* nested scroll operation if appropriate.
*
* <p>This version of the method just calls
* {@link #onStartNestedScroll(ViewParent, View, View, int, int)} using the touch input type.
* </p>
*
* @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
* {@link ViewCompat#SCROLL_AXIS_VERTICAL} or both
* @return true if this ViewParent accepts the nested scroll operation
*/
public static boolean onStartNestedScroll(@NonNull ViewParent parent, @NonNull View child,
@NonNull View target, int nestedScrollAxes) {
return onStartNestedScroll(parent, child, target, nestedScrollAxes, ViewCompat.TYPE_TOUCH);
}
/**
* React to the successful claiming of a nested scroll operation.
*
* <p>This version of the method just calls
* {@link #onNestedScrollAccepted(ViewParent, View, View, int, int)} using the touch input type.
* </p>
*
* @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
* {@link ViewCompat#SCROLL_AXIS_VERTICAL} or both
*/
public static void onNestedScrollAccepted(@NonNull ViewParent parent, @NonNull View child,
@NonNull View target, int nestedScrollAxes) {
onNestedScrollAccepted(parent, child, target, nestedScrollAxes, ViewCompat.TYPE_TOUCH);
}
/**
* React to a nested scroll operation ending.
*
* <p>This version of the method just calls {@link #onStopNestedScroll(ViewParent, View, int)}
* using the touch input type.</p>
*
* @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
*/
public static void onStopNestedScroll(@NonNull ViewParent parent, @NonNull View target) {
onStopNestedScroll(parent, target, ViewCompat.TYPE_TOUCH);
}
/**
* React to a nested scroll in progress.
*
* <p>This version of the method just calls
* {@link #onNestedScroll(ViewParent, View, int, int, int, int, int)} using the touch input
* type.
*
* @param parent ViewParent that contains the target view.
* @param target The descendent view controlling the nested scroll
* @param dxConsumed Horizontal scroll distance in pixels already consumed by target
* @param dyConsumed Vertical scroll distance in pixels already consumed by target
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by target
* @param dyUnconsumed Vertical scroll distance in pixels not consumed by target
*/
public static void onNestedScroll(@NonNull ViewParent parent, @NonNull View target,
int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed) {
onNestedScroll(parent, target, dxConsumed, dyConsumed, dxUnconsumed, dyUnconsumed,
ViewCompat.TYPE_TOUCH, getTempNestedScrollConsumed());
}
/**
* React to a nested scroll in progress.
*
* <p>This method will be called when the ViewParent's current nested scrolling child view
* dispatches a nested scroll event. To receive calls to this method the ViewParent must have
* previously returned <code>true</code> for a call to
* {@link #onStartNestedScroll(ViewParent, View, View, int, int)}.</p>
*
* <p>Both the consumed and unconsumed portions of the scroll distance are reported to the
* ViewParent. An implementation may choose to use the consumed portion to match or chase scroll
* position of multiple child elements, for example. The unconsumed portion may be used to
* allow continuous dragging of multiple scrolling or draggable elements, such as scrolling
* a list within a vertical drawer where the drawer begins dragging once the edge of inner
* scrolling content is reached.</p>
*
* @param parent ViewParent that contains the target view.
* @param target The descendant view controlling the nested scroll
* @param dxConsumed Horizontal scroll distance in pixels already consumed by target
* @param dyConsumed Vertical scroll distance in pixels already consumed by target
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by target
* @param dyUnconsumed Vertical scroll distance in pixels not consumed by target
* @param type the type of input which cause this scroll event
*/
public static void onNestedScroll(@NonNull ViewParent parent, @NonNull View target,
int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type) {
onNestedScroll(parent, target, dxConsumed, dyConsumed, dxUnconsumed, dyUnconsumed,
type, getTempNestedScrollConsumed());
}
/**
* React to a nested scroll in progress before the target view consumes a portion of the scroll.
*
* <p>This version of the method just calls
* {@link #onNestedPreScroll(ViewParent, View, int, int, int[], int)} using the touch input
* type.</p>
*
* @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param dx Horizontal scroll distance in pixels
* @param dy Vertical scroll distance in pixels
* @param consumed Output. The horizontal and vertical scroll distance consumed by this parent
*/
public static void onNestedPreScroll(@NonNull ViewParent parent, @NonNull View target, int dx,
int dy, @NonNull int[] consumed) {
onNestedPreScroll(parent, target, dx, dy, consumed, ViewCompat.TYPE_TOUCH);
}
/**
* React to a descendant view initiating a nestable scroll operation, claiming the
* nested scroll operation if appropriate.
*
* <p>This method will be called in response to a descendant view invoking
* {@link ViewCompat#startNestedScroll(View, int)}. Each parent up the view hierarchy will be
* given an opportunity to respond and claim the nested scrolling operation by returning
* <code>true</code>.</p>
*
* <p>This method may be overridden by ViewParent implementations to indicate when the view
* is willing to support a nested scrolling operation that is about to begin. If it returns
* true, this ViewParent will become the target view's nested scrolling parent for the duration
* of the scroll operation in progress. When the nested scroll is finished this ViewParent
* will receive a call to {@link #onStopNestedScroll(ViewParent, View, int)}.
* </p>
*
* @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
* {@link ViewCompat#SCROLL_AXIS_VERTICAL} or both
* @param type the type of input which cause this scroll event
* @return true if this ViewParent accepts the nested scroll operation
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
public static boolean onStartNestedScroll(@NonNull ViewParent parent, @NonNull View child,
@NonNull View target, int nestedScrollAxes, int type) {
if (parent instanceof NestedScrollingParent2) {
// First try the NestedScrollingParent2 API
return ((NestedScrollingParent2) parent).onStartNestedScroll(child, target,
nestedScrollAxes, type);
} else if (type == ViewCompat.TYPE_TOUCH) {
// Else if the type is the default (touch), try the NestedScrollingParent API
if (Build.VERSION.SDK_INT >= 21) {
try {
return Api21Impl.onStartNestedScroll(parent, child, target, nestedScrollAxes);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onStartNestedScroll", e);
}
} else if (parent instanceof NestedScrollingParent) {
return ((NestedScrollingParent) parent).onStartNestedScroll(child, target,
nestedScrollAxes);
}
}
return false;
}
/**
* React to the successful claiming of a nested scroll operation.
*
* <p>This method will be called after
* {@link #onStartNestedScroll(ViewParent, View, View, int) onStartNestedScroll} returns true.
* It offers an opportunity for the view and its superclasses to perform initial configuration
* for the nested scroll. Implementations of this method should always call their superclass's
* implementation of this method if one is present.</p>
*
* @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
* {@link ViewCompat#SCROLL_AXIS_VERTICAL} or both
* @param type the type of input which cause this scroll event
* @see #onStartNestedScroll(ViewParent, View, View, int)
* @see #onStopNestedScroll(ViewParent, View, int)
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
public static void onNestedScrollAccepted(@NonNull ViewParent parent, @NonNull View child,
@NonNull View target, int nestedScrollAxes, int type) {
if (parent instanceof NestedScrollingParent2) {
// First try the NestedScrollingParent2 API
((NestedScrollingParent2) parent).onNestedScrollAccepted(child, target,
nestedScrollAxes, type);
} else if (type == ViewCompat.TYPE_TOUCH) {
// Else if the type is the default (touch), try the NestedScrollingParent API
if (Build.VERSION.SDK_INT >= 21) {
try {
Api21Impl.onNestedScrollAccepted(parent, child, target, nestedScrollAxes);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onNestedScrollAccepted", e);
}
} else if (parent instanceof NestedScrollingParent) {
((NestedScrollingParent) parent).onNestedScrollAccepted(child, target,
nestedScrollAxes);
}
}
}
/**
* React to a nested scroll operation ending.
*
* <p>Perform cleanup after a nested scrolling operation.
* This method will be called when a nested scroll stops, for example when a nested touch
* scroll ends with a {@link MotionEvent#ACTION_UP} or {@link MotionEvent#ACTION_CANCEL} event.
* Implementations of this method should always call their superclass's implementation of this
* method if one is present.</p>
*
* @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param type the type of input which cause this scroll event
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
public static void onStopNestedScroll(@NonNull ViewParent parent, @NonNull View target,
int type) {
if (parent instanceof NestedScrollingParent2) {
// First try the NestedScrollingParent2 API
((NestedScrollingParent2) parent).onStopNestedScroll(target, type);
} else if (type == ViewCompat.TYPE_TOUCH) {
// Else if the type is the default (touch), try the NestedScrollingParent API
if (Build.VERSION.SDK_INT >= 21) {
try {
Api21Impl.onStopNestedScroll(parent, target);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onStopNestedScroll", e);
}
} else if (parent instanceof NestedScrollingParent) {
((NestedScrollingParent) parent).onStopNestedScroll(target);
}
}
}
/**
* React to a nested scroll in progress.
*
* <p>This method will be called when the ViewParent's current nested scrolling child view
* dispatches a nested scroll event. To receive calls to this method the ViewParent must have
* previously returned <code>true</code> for a call to
* {@link #onStartNestedScroll(ViewParent, View, View, int, int)}.</p>
*
* <p>Both the consumed and unconsumed portions of the scroll distance are reported to the
* ViewParent. An implementation may choose to use the consumed portion to match or chase scroll
* position of multiple child elements, for example. The unconsumed portion may be used to
* allow continuous dragging of multiple scrolling or draggable elements, such as scrolling
* a list within a vertical drawer where the drawer begins dragging once the edge of inner
* scrolling content is reached.</p>
*
* @param parent ViewParent that contains the target view.
* @param target The descendent view controlling the nested scroll
* @param dxConsumed Horizontal scroll distance in pixels already consumed by target
* @param dyConsumed Vertical scroll distance in pixels already consumed by target
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by target
* @param dyUnconsumed Vertical scroll distance in pixels not consumed by target
* @param type the type of input which cause this scroll event
* @param consumed Output. If not null, upon this method returning, will contain the scroll
* distances consumed by this nested scrolling parent and the scroll distances
* consumed by any other parent up the view hierarchy.
*/
public static void onNestedScroll(@NonNull ViewParent parent, @NonNull View target,
int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type,
@NonNull int[] consumed) {
if (parent instanceof NestedScrollingParent3) {
((NestedScrollingParent3) parent).onNestedScroll(target, dxConsumed, dyConsumed,
dxUnconsumed, dyUnconsumed, type, consumed);
} else {
// If we are calling anything less than NestedScrollingParent3, add the unconsumed
// distances to the consumed parameter so calling NestedScrollingChild3 implementations
// are told the entire scroll distance was consumed (for backwards compat).
consumed[0] += dxUnconsumed;
consumed[1] += dyUnconsumed;
if (parent instanceof NestedScrollingParent2) {
((NestedScrollingParent2) parent).onNestedScroll(target, dxConsumed, dyConsumed,
dxUnconsumed, dyUnconsumed, type);
} else if (type == ViewCompat.TYPE_TOUCH) {
// Else if the type is the default (touch), try the NestedScrollingParent API
if (Build.VERSION.SDK_INT >= 21) {
try {
Api21Impl.onNestedScroll(parent, target, dxConsumed, dyConsumed,
dxUnconsumed, dyUnconsumed);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onNestedScroll", e);
}
} else if (parent instanceof NestedScrollingParent) {
((NestedScrollingParent) parent).onNestedScroll(target, dxConsumed, dyConsumed,
dxUnconsumed, dyUnconsumed);
}
}
}
}
/**
* React to a nested scroll in progress before the target view consumes a portion of the scroll.
*
* <p>When working with nested scrolling often the parent view may want an opportunity
* to consume the scroll before the nested scrolling child does. An example of this is a
* drawer that contains a scrollable list. The user will want to be able to scroll the list
* fully into view before the list itself begins scrolling.</p>
*
* <p><code>onNestedPreScroll</code> is called when a nested scrolling child invokes
* {@link ViewCompat#dispatchNestedPreScroll(View, int, int, int[], int[])}. The implementation
* should report how any pixels of the scroll reported by dx, dy were consumed in the
* <code>consumed</code> array. Index 0 corresponds to dx and index 1 corresponds to dy.
* This parameter will never be null. Initial values for consumed[0] and consumed[1]
* will always be 0.</p>
*
* @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param dx Horizontal scroll distance in pixels
* @param dy Vertical scroll distance in pixels
* @param consumed Output. The horizontal and vertical scroll distance consumed by this parent
* @param type the type of input which cause this scroll event
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
public static void onNestedPreScroll(@NonNull ViewParent parent, @NonNull View target, int dx,
int dy, @NonNull int[] consumed, int type) {
if (parent instanceof NestedScrollingParent2) {
// First try the NestedScrollingParent2 API
((NestedScrollingParent2) parent).onNestedPreScroll(target, dx, dy, consumed, type);
} else if (type == ViewCompat.TYPE_TOUCH) {
// Else if the type is the default (touch), try the NestedScrollingParent API
if (Build.VERSION.SDK_INT >= 21) {
try {
Api21Impl.onNestedPreScroll(parent, target, dx, dy, consumed);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onNestedPreScroll", e);
}
} else if (parent instanceof NestedScrollingParent) {
((NestedScrollingParent) parent).onNestedPreScroll(target, dx, dy, consumed);
}
}
}
/**
* Request a fling from a nested scroll.
*
* <p>This method signifies that a nested scrolling child has detected suitable conditions
* for a fling. Generally this means that a touch scroll has ended with a
* {@link VelocityTracker velocity} in the direction of scrolling that meets or exceeds
* the {@link ViewConfiguration#getScaledMinimumFlingVelocity() minimum fling velocity}
* along a scrollable axis.</p>
*
* <p>If a nested scrolling child view would normally fling but it is at the edge of
* its own content, it can use this method to delegate the fling to its nested scrolling
* parent instead. The parent may optionally consume the fling or observe a child fling.</p>
*
* @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param velocityX Horizontal velocity in pixels per second
* @param velocityY Vertical velocity in pixels per second
* @param consumed true if the child consumed the fling, false otherwise
* @return true if this parent consumed or otherwise reacted to the fling
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
public static boolean onNestedFling(@NonNull ViewParent parent, @NonNull View target,
float velocityX, float velocityY, boolean consumed) {
if (Build.VERSION.SDK_INT >= 21) {
try {
return Api21Impl.onNestedFling(parent, target, velocityX, velocityY, consumed);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onNestedFling", e);
}
} else if (parent instanceof NestedScrollingParent) {
return ((NestedScrollingParent) parent).onNestedFling(target, velocityX, velocityY,
consumed);
}
return false;
}
/**
* React to a nested fling before the target view consumes it.
*
* <p>This method siginfies that a nested scrolling child has detected a fling with the given
* velocity along each axis. Generally this means that a touch scroll has ended with a
* {@link VelocityTracker velocity} in the direction of scrolling that meets or exceeds
* the {@link ViewConfiguration#getScaledMinimumFlingVelocity() minimum fling velocity}
* along a scrollable axis.</p>
*
* <p>If a nested scrolling parent is consuming motion as part of a
* {@link #onNestedPreScroll(ViewParent, View, int, int, int[]) pre-scroll}, it may be
* appropriate for it to also consume the pre-fling to complete that same motion. By returning
* <code>true</code> from this method, the parent indicates that the child should not
* fling its own internal content as well.</p>
*
* @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param velocityX Horizontal velocity in pixels per second
* @param velocityY Vertical velocity in pixels per second
* @return true if this parent consumed the fling ahead of the target view
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
public static boolean onNestedPreFling(@NonNull ViewParent parent, @NonNull View target,
float velocityX, float velocityY) {
if (Build.VERSION.SDK_INT >= 21) {
try {
return Api21Impl.onNestedPreFling(parent, target, velocityX, velocityY);
} catch (AbstractMethodError e) {
Log.e(TAG, "ViewParent " + parent + " does not implement interface "
+ "method onNestedPreFling", e);
}
} else if (parent instanceof NestedScrollingParent) {
return ((NestedScrollingParent) parent).onNestedPreFling(target, velocityX,
velocityY);
}
return false;
}
/**
* Notifies a view parent that the accessibility state of one of its
* descendants has changed and that the structure of the subtree is
* different.
*
* @param parent ViewParent that contains the target view.
* @param child The direct child whose subtree has changed.
* @param source The descendant view that changed.
* @param changeType A bit mask of the types of changes that occurred. One
* or more of:
* <ul>
* <li>{@link AccessibilityEvent#CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION}
* <li>{@link AccessibilityEvent#CONTENT_CHANGE_TYPE_SUBTREE}
* <li>{@link AccessibilityEvent#CONTENT_CHANGE_TYPE_TEXT}
* <li>{@link AccessibilityEvent#CONTENT_CHANGE_TYPE_UNDEFINED}
* </ul>
* @deprecated Call {@link ViewParent#notifySubtreeAccessibilityStateChanged()} directly.
*/
@Deprecated
@androidx.annotation.ReplaceWith(expression = "parent.notifySubtreeAccessibilityStateChanged(child, source, changeType)")
public static void notifySubtreeAccessibilityStateChanged(@NonNull ViewParent parent,
@NonNull View child, @NonNull View source, int changeType) {
parent.notifySubtreeAccessibilityStateChanged(child, source, changeType);
}
private static int[] getTempNestedScrollConsumed() {
if (sTempNestedScrollConsumed == null) {
sTempNestedScrollConsumed = new int[2];
} else {
sTempNestedScrollConsumed[0] = 0;
sTempNestedScrollConsumed[1] = 0;
}
return sTempNestedScrollConsumed;
}
@RequiresApi(21)
static class Api21Impl {
private Api21Impl() {
// This class is not instantiable.
}
static boolean onStartNestedScroll(ViewParent viewParent, View view, View view1, int i) {
return viewParent.onStartNestedScroll(view, view1, i);
}
static void onNestedScrollAccepted(ViewParent viewParent, View view, View view1, int i) {
viewParent.onNestedScrollAccepted(view, view1, i);
}
static void onStopNestedScroll(ViewParent viewParent, View view) {
viewParent.onStopNestedScroll(view);
}
static void onNestedScroll(ViewParent viewParent, View view, int i, int i1, int i2,
int i3) {
viewParent.onNestedScroll(view, i, i1, i2, i3);
}
static void onNestedPreScroll(ViewParent viewParent, View view, int i, int i1, int[] ints) {
viewParent.onNestedPreScroll(view, i, i1, ints);
}
static boolean onNestedFling(ViewParent viewParent, View view, float v, float v1,
boolean b) {
return viewParent.onNestedFling(view, v, v1, b);
}
static boolean onNestedPreFling(ViewParent viewParent, View view, float v, float v1) {
return viewParent.onNestedPreFling(view, v, v1);
}
}
}