स्क्रोल करने के हाथ के जेस्चर का ऐनिमेशन

लिखने का तरीका आज़माएं
Android के लिए, Jetpack Compose को यूज़र इंटरफ़ेस (यूआई) टूलकिट के तौर पर सुझाया जाता है. Compose में टच और इनपुट इस्तेमाल करने का तरीका जानें.

Android में, आम तौर पर ScrollView क्लास का इस्तेमाल करके स्क्रोल किया जाता है. किसी भी स्टैंडर्ड लेआउट को ScrollView में नेस्ट करें, जो अपने कंटेनर की सीमाओं से परे हो सकता है. इससे, फ़्रेमवर्क से मैनेज किया जाने वाला स्क्रोल किया जा सकने वाला व्यू मिलता है. कस्टम स्क्रोलर को लागू करना सिर्फ़ खास स्थितियों के लिए ज़रूरी है. इस दस्तावेज़ में, स्क्रोलर का इस्तेमाल करके, टच जेस्चर के जवाब में स्क्रोलिंग इफ़ेक्ट दिखाने का तरीका बताया गया है.

आपका ऐप्लिकेशन, टच इवेंट के जवाब में स्क्रॉल करने वाला ऐनिमेशन बनाने के लिए ज़रूरी डेटा इकट्ठा करने के लिए, स्क्रॉलर—Scroller या OverScroller—का इस्तेमाल कर सकता है. ये दोनों एक जैसे हैं, लेकिन OverScroller में उपयोगकर्ताओं को यह बताने के तरीके भी शामिल हैं कि पैन या फ़्लिंग जेस्चर के बाद, वे कॉन्टेंट के किनारों तक पहुंच गए हैं.

  • Android 12 (एपीआई लेवल 31) से, विज़ुअल एलिमेंट को खींचने पर स्ट्रेच होता है और छोड़ने पर वापस आ जाता है. साथ ही, फ़्लिंग इवेंट पर फ़्लिंग होता है और छोड़ने पर वापस आ जाता है.
  • Android 11 (एपीआई लेवल 30) और उससे पहले के वर्शन पर, किनारों पर खींचने या फ़्लिंग जेस्चर के बाद, सीमाओं पर "ग्लो" वाला इफ़ेक्ट दिखता है.

इस दस्तावेज़ में मौजूद InteractiveChart सैंपल, इन ओवरस्क्रोल इफ़ेक्ट को दिखाने के लिए EdgeEffect क्लास का इस्तेमाल करता है.

समय के साथ स्क्रोलिंग को ऐनिमेट करने के लिए, स्क्रोलर का इस्तेमाल किया जा सकता है. इसके लिए, प्लैटफ़ॉर्म के स्टैंडर्ड स्क्रोलिंग फ़िज़िक्स का इस्तेमाल किया जाता है. जैसे, घर्षण, वेग, और अन्य विशेषताएं. स्क्रोलर खुद कुछ नहीं दिखाता. स्क्रोलर समय के साथ आपके लिए स्क्रोल ऑफ़सेट को ट्रैक करते हैं, लेकिन वे आपके व्यू पर उन जगहों को अपने-आप लागू नहीं करते. आपको नए निर्देशों को इस दर पर पाना और लागू करना होगा कि स्क्रॉल करने पर ऐनिमेशन स्मूद दिखे.

स्क्रोलिंग से जुड़ी शब्दावली को समझना

स्क्रोल करना ऐसा शब्द है जिसका Android में अलग-अलग मतलब हो सकता है. यह संदर्भ के हिसाब से तय होता है.

स्क्रोल करना, व्यूपोर्ट को आगे-पीछे करने की सामान्य प्रोसेस है. व्यूपोर्ट, कॉन्टेंट की वह "विंडो" होती है जिसे देखा जा रहा है. जब स्क्रोल, x- और y-ऐक्सिस, दोनों में होता है, तो इसे पैनिंग कहा जाता है. इस दस्तावेज़ में दिए गए InteractiveChart सैंपल ऐप्लिकेशन में, स्क्रोल करने, खींचने, और फ़्लिंग करने के दो अलग-अलग तरीके दिखाए गए हैं:

  • खींचना और छोड़ना: यह स्क्रोलिंग का एक तरीका है. यह तब होता है, जब कोई उपयोगकर्ता अपने उंगली को टचस्क्रीन पर खींचता है और छोड़ता है. खींचकर छोड़ने की सुविधा को लागू करने के लिए, GestureDetector.OnGestureListener में onScroll() को बदलें. खींचने और छोड़ने के बारे में ज़्यादा जानकारी के लिए, खींचें और छोड़ें लेख पढ़ें.
  • फ़्लिंगिंग: यह उस तरह की स्क्रोलिंग होती है जिसमें उपयोगकर्ता अपनी उंगली को तेज़ी से खींचता और हटाता है. जब उपयोगकर्ता अपनी उंगली हटा लेता है, तो आप आम तौर पर व्यूपोर्ट को इधर-उधर मूव करते रहना चाहते हैं, लेकिन जब तक व्यूपोर्ट रुक जाए, तब तक यह सुविधा काम न करे. GestureDetector.OnGestureListener में onFling() को बदलकर और स्क्रोलर ऑब्जेक्ट का इस्तेमाल करके, फ़्लिंग की सुविधा लागू की जा सकती है.
  • पैन करना: x- और y-ऐक्सिस, दोनों पर एक साथ स्क्रोल करने को पैन करना कहा जाता है.

आम तौर पर, स्क्रॉलर ऑब्जेक्ट का इस्तेमाल फ़्लिंग जेस्चर के साथ किया जाता है. हालांकि, इनका इस्तेमाल किसी भी ऐसे कॉन्टेक्स्ट में किया जा सकता है जहां आपको यूज़र इंटरफ़ेस (यूआई) को टच इवेंट के जवाब में स्क्रॉल करने के लिए दिखाना हो. उदाहरण के लिए, टच इवेंट को सीधे प्रोसेस करने के लिए, onTouchEvent() को बदला जा सकता है. साथ ही, उन टच इवेंट के जवाब में स्क्रोलिंग इफ़ेक्ट या "पेज पर स्नैप करें" ऐनिमेशन बनाया जा सकता है.

ऐसे कॉम्पोनेंट जिनमें स्क्रोलिंग की सुविधा पहले से मौजूद होती है

Android के इन कॉम्पोनेंट में, स्क्रोल करने और स्क्रोल करने के दौरान स्क्रीन पर दिखने वाले कॉन्टेंट के ज़्यादा आगे या पीछे जाने की सुविधा पहले से मौजूद होती है:

अगर आपके ऐप्लिकेशन को किसी दूसरे कॉम्पोनेंट में स्क्रोलिंग और ओवरस्क्रोलिंग की सुविधा चाहिए, तो यह तरीका अपनाएं:

  1. टच-आधारित स्क्रोलिंग को अपनी पसंद के मुताबिक लागू करना.
  2. Android 12 और उसके बाद के वर्शन वाले डिवाइसों पर काम करने के लिए, स्ट्रेच ओवरस्क्रोल इफ़ेक्ट लागू करें.

टच-आधारित स्क्रोलिंग को कस्टम तरीके से लागू करना

इस सेक्शन में यह बताया गया है कि अगर आपका ऐप्लिकेशन किसी ऐसे कॉम्पोनेंट का इस्तेमाल करता है जिसमें स्क्रोल और ओवरस्क्रोलिंग के लिए पहले से मौजूद सहायता नहीं होती, तो अपना स्क्रोलर कैसे बनाएं.

यह स्निपेट, InteractiveChart के सैंपल से लिया गया है. यह GestureDetector का इस्तेमाल करता है और GestureDetector.SimpleOnGestureListener तरीके onFling() को बदल देता है. यह फ़्लिंग जेस्चर को ट्रैक करने के लिए OverScroller का इस्तेमाल करता है. अगर उपयोगकर्ता फ़्लिंग जेस्चर करने के बाद, कॉन्टेंट के किनारों पर पहुंच जाता है, तो कंटेनर से पता चलता है कि उपयोगकर्ता कॉन्टेंट के आखिर में पहुंच गया है. यह जानकारी, डिवाइस पर चल रहे Android वर्शन पर निर्भर करती है:

  • Android 12 और उसके बाद के वर्शन पर, विज़ुअल एलिमेंट स्ट्रेच और वापस आ जाते हैं.
  • Android 11 और उससे पहले के वर्शन पर, विज़ुअल एलिमेंट में चमक वाला इफ़ेक्ट दिखता है.

यहां दिए गए स्निपेट के पहले हिस्से में, onFling() को लागू करने का तरीका बताया गया है:

Kotlin

// Viewport extremes. See currentViewport for a discussion of the viewport.
private val AXIS_X_MIN = -1f
private val AXIS_X_MAX = 1f
private val AXIS_Y_MIN = -1f
private val AXIS_Y_MAX = 1f

// The current viewport. This rectangle represents the visible chart
// domain and range. The viewport is the part of the app that the
// user manipulates via touch gestures.
private val currentViewport = RectF(AXIS_X_MIN, AXIS_Y_MIN, AXIS_X_MAX, AXIS_Y_MAX)

// The current destination rectangle—in pixel coordinates—into which
// the chart data must be drawn.
private lateinit var contentRect: Rect

private lateinit var scroller: OverScroller
private lateinit var scrollerStartViewport: RectF
...
private val gestureListener = object : GestureDetector.SimpleOnGestureListener() {

    override fun onDown(e: MotionEvent): Boolean {
        // Initiates the decay phase of any active edge effects.
        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
            releaseEdgeEffects()
        }
        scrollerStartViewport.set(currentViewport)
        // Aborts any active scroll animations and invalidates.
        scroller.forceFinished(true)
        ViewCompat.postInvalidateOnAnimation(this@InteractiveLineGraphView)
        return true
    }
    ...
    override fun onFling(
            e1: MotionEvent,
            e2: MotionEvent,
            velocityX: Float,
            velocityY: Float
    ): Boolean {
        fling((-velocityX).toInt(), (-velocityY).toInt())
        return true
    }
}

private fun fling(velocityX: Int, velocityY: Int) {
    // Initiates the decay phase of any active edge effects.
    // On Android 12 and later, the edge effect (stretch) must
    // continue.
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
            releaseEdgeEffects()
    }
    // Flings use math in pixels, as opposed to math based on the viewport.
    val surfaceSize: Point = computeScrollSurfaceSize()
    val (startX: Int, startY: Int) = scrollerStartViewport.run {
        set(currentViewport)
        (surfaceSize.x * (left - AXIS_X_MIN) / (AXIS_X_MAX - AXIS_X_MIN)).toInt() to
                (surfaceSize.y * (AXIS_Y_MAX - bottom) / (AXIS_Y_MAX - AXIS_Y_MIN)).toInt()
    }
    // Before flinging, stops the current animation.
    scroller.forceFinished(true)
    // Begins the animation.
    scroller.fling(
            // Current scroll position.
            startX,
            startY,
            velocityX,
            velocityY,
            /*
             * Minimum and maximum scroll positions. The minimum scroll
             * position is generally 0 and the maximum scroll position
             * is generally the content size less the screen size. So if the
             * content width is 1000 pixels and the screen width is 200
             * pixels, the maximum scroll offset is 800 pixels.
             */
            0, surfaceSize.x - contentRect.width(),
            0, surfaceSize.y - contentRect.height(),
            // The edges of the content. This comes into play when using
            // the EdgeEffect class to draw "glow" overlays.
            contentRect.width() / 2,
            contentRect.height() / 2
    )
    // Invalidates to trigger computeScroll().
    ViewCompat.postInvalidateOnAnimation(this)
}

Java

// Viewport extremes. See currentViewport for a discussion of the viewport.
private static final float AXIS_X_MIN = -1f;
private static final float AXIS_X_MAX = 1f;
private static final float AXIS_Y_MIN = -1f;
private static final float AXIS_Y_MAX = 1f;

// The current viewport. This rectangle represents the visible chart
// domain and range. The viewport is the part of the app that the
// user manipulates via touch gestures.
private RectF currentViewport =
  new RectF(AXIS_X_MIN, AXIS_Y_MIN, AXIS_X_MAX, AXIS_Y_MAX);

// The current destination rectangle—in pixel coordinates—into which
// the chart data must be drawn.
private final Rect contentRect = new Rect();

private final OverScroller scroller;
private final RectF scrollerStartViewport =
  new RectF(); // Used only for zooms and flings.
...
private final GestureDetector.SimpleOnGestureListener gestureListener
        = new GestureDetector.SimpleOnGestureListener() {
    @Override
    public boolean onDown(MotionEvent e) {
         if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
            releaseEdgeEffects();
        }
        scrollerStartViewport.set(currentViewport);
        scroller.forceFinished(true);
        ViewCompat.postInvalidateOnAnimation(InteractiveLineGraphView.this);
        return true;
    }
...
    @Override
    public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX, float velocityY) {
        fling((int) -velocityX, (int) -velocityY);
        return true;
    }
};

private void fling(int velocityX, int velocityY) {
    // Initiates the decay phase of any active edge effects.
    // On Android 12 and later, the edge effect (stretch) must
    // continue.
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
            releaseEdgeEffects();
    }
    // Flings use math in pixels, as opposed to math based on the viewport.
    Point surfaceSize = computeScrollSurfaceSize();
    scrollerStartViewport.set(currentViewport);
    int startX = (int) (surfaceSize.x * (scrollerStartViewport.left -
            AXIS_X_MIN) / (
            AXIS_X_MAX - AXIS_X_MIN));
    int startY = (int) (surfaceSize.y * (AXIS_Y_MAX -
            scrollerStartViewport.bottom) / (
            AXIS_Y_MAX - AXIS_Y_MIN));
    // Before flinging, stops the current animation.
    scroller.forceFinished(true);
    // Begins the animation.
    scroller.fling(
            // Current scroll position.
            startX,
            startY,
            velocityX,
            velocityY,
            /*
             * Minimum and maximum scroll positions. The minimum scroll
             * position is generally 0 and the maximum scroll position
             * is generally the content size less the screen size. So if the
             * content width is 1000 pixels and the screen width is 200
             * pixels, the maximum scroll offset is 800 pixels.
             */
            0, surfaceSize.x - contentRect.width(),
            0, surfaceSize.y - contentRect.height(),
            // The edges of the content. This comes into play when using
            // the EdgeEffect class to draw "glow" overlays.
            contentRect.width() / 2,
            contentRect.height() / 2);
    // Invalidates to trigger computeScroll().
    ViewCompat.postInvalidateOnAnimation(this);
}

जब onFling(), postInvalidateOnAnimation() को कॉल करता है, तो यह x और y की वैल्यू अपडेट करने के लिए, computeScroll() को ट्रिगर करता है. आम तौर पर, ऐसा तब किया जाता है, जब कोई व्यू चाइल्ड, स्क्रोलर ऑब्जेक्ट का इस्तेमाल करके स्क्रोल को ऐनिमेट कर रहा हो. जैसा कि पिछले उदाहरण में दिखाया गया है.

ज़्यादातर व्यू, स्क्रोलर ऑब्जेक्ट के x और y पोज़िशन को सीधे scrollTo() पर पास करते हैं. computeScroll() को लागू करने का यह तरीका अलग है: यह x और y की मौजूदा जगह की जानकारी पाने के लिए, computeScrollOffset() को कॉल करता है. जब स्क्रीन पर, ओवरस्क्रोल "ग्लो" एज इफ़ेक्ट दिखाने की ज़रूरी शर्तें पूरी हो जाती हैं, तो कोड ओवरस्क्रोल ग्लो इफ़ेक्ट सेट अप करता है और व्यू को अमान्य करने के लिए postInvalidateOnAnimation() को कॉल करता है. ज़रूरी शर्तें पूरी होने का मतलब है कि डिसप्ले को ज़ूम इन किया गया है, x या y की वैल्यू तय सीमा से बाहर है, और ऐप्लिकेशन में पहले से ही ओवरस्क्रोल नहीं दिख रहा है.

Kotlin

// Edge effect/overscroll tracking objects.
private lateinit var edgeEffectTop: EdgeEffect
private lateinit var edgeEffectBottom: EdgeEffect
private lateinit var edgeEffectLeft: EdgeEffect
private lateinit var edgeEffectRight: EdgeEffect

private var edgeEffectTopActive: Boolean = false
private var edgeEffectBottomActive: Boolean = false
private var edgeEffectLeftActive: Boolean = false
private var edgeEffectRightActive: Boolean = false

override fun computeScroll() {
    super.computeScroll()

    var needsInvalidate = false

    // The scroller isn't finished, meaning a fling or
    // programmatic pan operation is active.
    if (scroller.computeScrollOffset()) {
        val surfaceSize: Point = computeScrollSurfaceSize()
        val currX: Int = scroller.currX
        val currY: Int = scroller.currY

        val (canScrollX: Boolean, canScrollY: Boolean) = currentViewport.run {
            (left > AXIS_X_MIN || right < AXIS_X_MAX) to (top > AXIS_Y_MIN || bottom < AXIS_Y_MAX)
        }

        /*
         * If you are zoomed in, currX or currY is
         * outside of bounds, and you aren't already
         * showing overscroll, then render the overscroll
         * glow edge effect.
         */
        if (canScrollX
                && currX < 0
                && edgeEffectLeft.isFinished
                && !edgeEffectLeftActive) {
            edgeEffectLeft.onAbsorb(scroller.currVelocity.toInt())
            edgeEffectLeftActive = true
            needsInvalidate = true
        } else if (canScrollX
                && currX > surfaceSize.x - contentRect.width()
                && edgeEffectRight.isFinished
                && !edgeEffectRightActive) {
            edgeEffectRight.onAbsorb(scroller.currVelocity.toInt())
            edgeEffectRightActive = true
            needsInvalidate = true
        }

        if (canScrollY
                && currY < 0
                && edgeEffectTop.isFinished
                && !edgeEffectTopActive) {
            edgeEffectTop.onAbsorb(scroller.currVelocity.toInt())
            edgeEffectTopActive = true
            needsInvalidate = true
        } else if (canScrollY
                && currY > surfaceSize.y - contentRect.height()
                && edgeEffectBottom.isFinished
                && !edgeEffectBottomActive) {
            edgeEffectBottom.onAbsorb(scroller.currVelocity.toInt())
            edgeEffectBottomActive = true
            needsInvalidate = true
        }
        ...
    }
}

Java

// Edge effect/overscroll tracking objects.
private EdgeEffectCompat edgeEffectTop;
private EdgeEffectCompat edgeEffectBottom;
private EdgeEffectCompat edgeEffectLeft;
private EdgeEffectCompat edgeEffectRight;

private boolean edgeEffectTopActive;
private boolean edgeEffectBottomActive;
private boolean edgeEffectLeftActive;
private boolean edgeEffectRightActive;

@Override
public void computeScroll() {
    super.computeScroll();

    boolean needsInvalidate = false;

    // The scroller isn't finished, meaning a fling or
    // programmatic pan operation is active.
    if (scroller.computeScrollOffset()) {
        Point surfaceSize = computeScrollSurfaceSize();
        int currX = scroller.getCurrX();
        int currY = scroller.getCurrY();

        boolean canScrollX = (currentViewport.left > AXIS_X_MIN
                || currentViewport.right < AXIS_X_MAX);
        boolean canScrollY = (currentViewport.top > AXIS_Y_MIN
                || currentViewport.bottom < AXIS_Y_MAX);

        /*
         * If you are zoomed in, currX or currY is
         * outside of bounds, and you aren't already
         * showing overscroll, then render the overscroll
         * glow edge effect.
         */
        if (canScrollX
                && currX < 0
                && edgeEffectLeft.isFinished()
                && !edgeEffectLeftActive) {
            edgeEffectLeft.onAbsorb((int)mScroller.getCurrVelocity());
            edgeEffectLeftActive = true;
            needsInvalidate = true;
        } else if (canScrollX
                && currX > (surfaceSize.x - contentRect.width())
                && edgeEffectRight.isFinished()
                && !edgeEffectRightActive) {
            edgeEffectRight.onAbsorb((int)mScroller.getCurrVelocity());
            edgeEffectRightActive = true;
            needsInvalidate = true;
        }

        if (canScrollY
                && currY < 0
                && edgeEffectTop.isFinished()
                && !edgeEffectTopActive) {
            edgeEffectRight.onAbsorb((int)mScroller.getCurrVelocity());
            edgeEffectTopActive = true;
            needsInvalidate = true;
        } else if (canScrollY
                && currY > (surfaceSize.y - contentRect.height())
                && edgeEffectBottom.isFinished()
                && !edgeEffectBottomActive) {
            edgeEffectRight.onAbsorb((int)mScroller.getCurrVelocity());
            edgeEffectBottomActive = true;
            needsInvalidate = true;
        }
        ...
    }

यहां कोड का वह सेक्शन दिया गया है जो असल ज़ूम करता है:

Kotlin

lateinit var zoomer: Zoomer
val zoomFocalPoint = PointF()
...
// If a zoom is in progress—either programmatically
// or through double touch—this performs the zoom.
if (zoomer.computeZoom()) {
    val newWidth: Float = (1f - zoomer.currZoom) * scrollerStartViewport.width()
    val newHeight: Float = (1f - zoomer.currZoom) * scrollerStartViewport.height()
    val pointWithinViewportX: Float =
            (zoomFocalPoint.x - scrollerStartViewport.left) / scrollerStartViewport.width()
    val pointWithinViewportY: Float =
            (zoomFocalPoint.y - scrollerStartViewport.top) / scrollerStartViewport.height()
    currentViewport.set(
            zoomFocalPoint.x - newWidth * pointWithinViewportX,
            zoomFocalPoint.y - newHeight * pointWithinViewportY,
            zoomFocalPoint.x + newWidth * (1 - pointWithinViewportX),
            zoomFocalPoint.y + newHeight * (1 - pointWithinViewportY)
    )
    constrainViewport()
    needsInvalidate = true
}
if (needsInvalidate) {
    ViewCompat.postInvalidateOnAnimation(this)
}

Java

// Custom object that is functionally similar to Scroller.
Zoomer zoomer;
private PointF zoomFocalPoint = new PointF();
...
// If a zoom is in progress—either programmatically
// or through double touch—this performs the zoom.
if (zoomer.computeZoom()) {
    float newWidth = (1f - zoomer.getCurrZoom()) *
            scrollerStartViewport.width();
    float newHeight = (1f - zoomer.getCurrZoom()) *
            scrollerStartViewport.height();
    float pointWithinViewportX = (zoomFocalPoint.x -
            scrollerStartViewport.left)
            / scrollerStartViewport.width();
    float pointWithinViewportY = (zoomFocalPoint.y -
            scrollerStartViewport.top)
            / scrollerStartViewport.height();
    currentViewport.set(
            zoomFocalPoint.x - newWidth * pointWithinViewportX,
            zoomFocalPoint.y - newHeight * pointWithinViewportY,
            zoomFocalPoint.x + newWidth * (1 - pointWithinViewportX),
            zoomFocalPoint.y + newHeight * (1 - pointWithinViewportY));
    constrainViewport();
    needsInvalidate = true;
}
if (needsInvalidate) {
    ViewCompat.postInvalidateOnAnimation(this);
}

यह computeScrollSurfaceSize() तरीका है जिसे पिछले स्निपेट में कॉल किया जाता है. यह स्क्रोल किए जा सकने वाले मौजूदा प्लैटफ़ॉर्म के साइज़ का हिसाब पिक्सल में लगाता है. उदाहरण के लिए, अगर पूरा चार्ट दिख रहा है, तो यह mContentRect का मौजूदा साइज़ है. अगर चार्ट को दोनों दिशाओं में 200% ज़ूम इन किया जाता है, तो दिखाया गया साइज़, हॉरिज़ॉन्टल और वर्टिकल तौर पर दोगुना हो जाता है.

Kotlin

private fun computeScrollSurfaceSize(): Point {
    return Point(
            (contentRect.width() * (AXIS_X_MAX - AXIS_X_MIN) / currentViewport.width()).toInt(),
            (contentRect.height() * (AXIS_Y_MAX - AXIS_Y_MIN) / currentViewport.height()).toInt()
    )
}

Java

private Point computeScrollSurfaceSize() {
    return new Point(
            (int) (contentRect.width() * (AXIS_X_MAX - AXIS_X_MIN)
                    / currentViewport.width()),
            (int) (contentRect.height() * (AXIS_Y_MAX - AXIS_Y_MIN)
                    / currentViewport.height()));
}

स्क्रोलर के इस्तेमाल के एक और उदाहरण के लिए, ViewPager क्लास का सोर्स कोड देखें. यह फ़्लिंग के जवाब में स्क्रोल करता है और "पेज पर स्नैप करें" ऐनिमेशन लागू करने के लिए, स्क्रोल का इस्तेमाल करता है.

स्ट्रेच ओवरस्क्रोल इफ़ेक्ट को लागू करना

Android 12 से, EdgeEffect ने स्ट्रेच ओवरस्क्रोल इफ़ेक्ट लागू करने के लिए, ये एपीआई जोड़े हैं:

  • getDistance()
  • onPullDistance()

स्ट्रेच ओवरस्क्रोल की सुविधा का इस्तेमाल करके, लोगों को बेहतरीन अनुभव देने के लिए, ये काम करें:

  1. उपयोगकर्ता के कॉन्टेंट को छूने पर, जब स्ट्रैच ऐनिमेशन लागू होता है, तब टच को "कैच" के तौर पर रजिस्टर करें. उपयोगकर्ता ऐनिमेशन बंद कर देता है और फिर से स्ट्रेच में बदलाव करना शुरू कर देता है.
  2. जब उपयोगकर्ता अपने फ़िंगर को स्ट्रेच की विपरीत दिशा में ले जाता है, तब स्ट्रेच को तब तक छोड़ें, जब तक वह पूरी तरह से हट न जाए. इसके बाद, स्क्रोल करना शुरू करें.
  3. जब उपयोगकर्ता स्ट्रेच के दौरान फ़्लिंग करता है, तो स्ट्रेच इफ़ेक्ट को बेहतर बनाने के लिए, EdgeEffect को फ़्लिंग करें.

ऐनिमेशन देखें

जब कोई उपयोगकर्ता ऐक्टिव स्ट्रेच ऐनिमेशन को कैच करता है, तो EdgeEffect.getDistance() 0 दिखाता है. इस स्थिति से यह पता चलता है कि खिंचाव के दौरान टच मोशन का इस्तेमाल किया जाना चाहिए. ज़्यादातर कंटेनर में, onInterceptTouchEvent() में कैच का पता चलता है, जैसा कि इस कोड स्निपेट में दिखाया गया है:

Kotlin

override fun onInterceptTouchEvent(ev: MotionEvent): Boolean {
  ...
  when (action and MotionEvent.ACTION_MASK) {
    MotionEvent.ACTION_DOWN ->
      ...
      isBeingDragged = EdgeEffectCompat.getDistance(edgeEffectBottom) > 0f ||
          EdgeEffectCompat.getDistance(edgeEffectTop) > 0f
      ...
  }
  return isBeingDragged
}

Java

@Override
public boolean onInterceptTouchEvent(MotionEvent ev) {
  ...
  switch (action & MotionEvent.ACTION_MASK) {
    case MotionEvent.ACTION_DOWN:
      ...
      isBeingDragged = EdgeEffectCompat.getDistance(edgeEffectBottom) > 0
          || EdgeEffectCompat.getDistance(edgeEffectTop) > 0;
      ...
  }
}

पिछले उदाहरण में, mIsBeingDragged के true होने पर onInterceptTouchEvent(), true दिखाता है. इसलिए, बच्चे के इवेंट का इस्तेमाल करने से पहले, उसे इस्तेमाल करना काफ़ी है.

ओवरस्क्रोल इफ़ेक्ट को हटाना

स्क्रोल करने से पहले, स्ट्रेच इफ़ेक्ट को हटाना ज़रूरी है, ताकि स्क्रोल किए जा रहे कॉन्टेंट पर स्ट्रेच न हो. यहां दिया गया कोड सैंपल, इस सबसे सही तरीके को लागू करता है:

Kotlin

override fun onTouchEvent(ev: MotionEvent): Boolean {
  val activePointerIndex = ev.actionIndex

  when (ev.getActionMasked()) {
    MotionEvent.ACTION_MOVE ->
      val x = ev.getX(activePointerIndex)
      val y = ev.getY(activePointerIndex)
      var deltaY = y - lastMotionY
      val pullDistance = deltaY / height
      val displacement = x / width

      if (deltaY < 0f && EdgeEffectCompat.getDistance(edgeEffectTop) > 0f) {
        deltaY -= height * EdgeEffectCompat.onPullDistance(edgeEffectTop,
            pullDistance, displacement);
      }
      if (deltaY > 0f && EdgeEffectCompat.getDistance(edgeEffectBottom) > 0f) {
        deltaY += height * EdgeEffectCompat.onPullDistance(edgeEffectBottom,
            -pullDistance, 1 - displacement);
      }
      ...
  }

Java

@Override
public boolean onTouchEvent(MotionEvent ev) {

  final int actionMasked = ev.getActionMasked();

  switch (actionMasked) {
    case MotionEvent.ACTION_MOVE:
      final float x = ev.getX(activePointerIndex);
      final float y = ev.getY(activePointerIndex);
      float deltaY = y - lastMotionY;
      float pullDistance = deltaY / getHeight();
      float displacement = x / getWidth();

      if (deltaY < 0 && EdgeEffectCompat.getDistance(edgeEffectTop) > 0) {
        deltaY -= getHeight() * EdgeEffectCompat.onPullDistance(edgeEffectTop,
            pullDistance, displacement);
      }
      if (deltaY > 0 && EdgeEffectCompat.getDistance(edgeEffectBottom) > 0) {
        deltaY += getHeight() * EdgeEffectCompat.onPullDistance(edgeEffectBottom,
            -pullDistance, 1 - displacement);
      }
            ...

जब उपयोगकर्ता खींच रहा हो, तो टच इवेंट को नेस्ट किए गए स्क्रोलिंग कंटेनर में पास करने या स्क्रोल करने से पहले, EdgeEffect पुल डिस्टेंस का इस्तेमाल करें. ऊपर दिए गए कोड सैंपल में, getDistance() एक सकारात्मक वैल्यू दिखाता है. ऐसा तब होता है, जब कोई किनारा इफ़ेक्ट दिखाया जा रहा हो और उसे मोशन के साथ रिलीज़ किया जा सकता हो. जब टच इवेंट, स्ट्रेच को रिलीज़ करता है, तो पहले इसे EdgeEffect इस्तेमाल करता है, ताकि नेस्ट किए गए स्क्रोलिंग जैसे अन्य इफ़ेक्ट दिखने से पहले, इसे पूरी तरह से रिलीज़ कर दिया जाए. getDistance() का इस्तेमाल करके, यह पता किया जा सकता है कि मौजूदा इफ़ेक्ट को रिलीज़ करने के लिए, कितनी दूरी की ज़रूरत है.

onPull() के उलट, onPullDistance(), पास किए गए डेल्टा की कुल वैल्यू दिखाता है. Android 12 में, अगर getDistance() के 0 होने पर, onPull() या onPullDistance() को नेगेटिव deltaDistance वैल्यू दी जाती हैं, तो स्ट्रेच इफ़ेक्ट नहीं बदलता. Android 11 और उससे पहले के वर्शन पर, onPull() की मदद से कुल दूरी की नेगेटिव वैल्यू के लिए, चमक वाले इफ़ेक्ट दिखाए जा सकते हैं.

ओवरस्क्रोल से ऑप्ट आउट करना

आपके पास लेआउट फ़ाइल में या प्रोग्राम के हिसाब से, ओवरस्क्रोल की सुविधा से ऑप्ट आउट करने का विकल्प होता है.

अपनी लेआउट फ़ाइल में ऑप्ट आउट करने के लिए, android:overScrollMode को यहां दिए गए उदाहरण में दिखाए गए तरीके से सेट करें:

<MyCustomView android:overScrollMode="never">
    ...
</MyCustomView>

प्रोग्राम के हिसाब से ऑप्ट आउट करने के लिए, इस तरह के कोड का इस्तेमाल करें:

Kotlin

customView.overScrollMode = View.OVER_SCROLL_NEVER

Java

customView.setOverScrollMode(View.OVER_SCROLL_NEVER);

अन्य संसाधन

इस बारे में ज़्यादा जानने के लिए, यहां दिए गए लेख पढ़ें: