Package 

Interface NestedScrollingChild3

  • All Implemented Interfaces:
    tds.androidx.core.view.NestedScrollingChild , tds.androidx.core.view.NestedScrollingChild2 
    
public interface NestedScrollingChild3
 implements NestedScrollingChild2

    This interface should be implemented by View subclasses that wish to support dispatching nested scrolling operations to a cooperating parent ViewGroup.

    Classes implementing this interface should create a final instance of a NestedScrollingChildHelper as a field and delegate any View methods to the NestedScrollingChildHelper methods of the same signature.

    Views invoking nested scrolling functionality should always do so from the relevant ViewCompat, ViewGroupCompat or ViewParentCompat compatibility shim static methods. This ensures interoperability with nested scrolling views on all versions of Android.

    • Method Summary

      Modifier and Type Method Description
      abstract void dispatchNestedScroll(int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, @Nullable() Array<int> offsetInWindow, int type, @NonNull() Array<int> consumed) Dispatch one step of a nested scroll in progress.

      • Methods inherited from class tds.androidx.core.view.NestedScrollingChild2

        dispatchNestedPreScroll, dispatchNestedScroll, hasNestedScrollingParent, startNestedScroll, stopNestedScroll

      • Methods inherited from class tds.androidx.core.view.NestedScrollingChild

        dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPreScroll, dispatchNestedScroll, hasNestedScrollingParent, isNestedScrollingEnabled, setNestedScrollingEnabled, startNestedScroll, stopNestedScroll

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • dispatchNestedScroll

         abstract void dispatchNestedScroll(int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, @Nullable() Array<int> offsetInWindow, int type, @NonNull() Array<int> consumed)

        Dispatch one step of a nested scroll in progress.

        Implementations of views that support nested scrolling should call this to reportinfo about a scroll in progress to the current nested scrolling parent. If a nested scrollis not currently in progress or nested scrolling is not enabled for this view this method does nothing.

        Compatible View implementations should also call dispatchNestedPreScroll beforeconsuming a component of the scroll event themselves.

        The original nested scrolling child (where the input events were received to start thescroll) must provide a non-null consumed parameter with values {0, 0}.

        Parameters:
        dxConsumed - Horizontal distance in pixels consumed by this view during this scroll step
        dyConsumed - Vertical distance in pixels consumed by this view during this scroll step
        dxUnconsumed - Horizontal scroll distance in pixels not consumed by this view
        dyUnconsumed - Horizontal scroll distance in pixels not consumed by this view
        offsetInWindow - Optional.
        type - the type of input which cause this scroll event
        consumed - Output.