-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #215 from rubensousa/snap_helper
Add DpadSelectionSnapHelper for proper touch event support
- Loading branch information
Showing
9 changed files
with
277 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
dpadrecyclerview/src/main/java/com/rubensousa/dpadrecyclerview/DpadSelectionSnapHelper.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| /* | ||
| * Copyright 2024 Rúben Sousa | ||
| * | ||
| * 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 com.rubensousa.dpadrecyclerview | ||
|
|
||
| import android.util.DisplayMetrics | ||
| import android.view.View | ||
| import android.view.ViewGroup | ||
| import androidx.core.view.forEach | ||
| import androidx.recyclerview.widget.LinearSmoothScroller | ||
| import androidx.recyclerview.widget.LinearSnapHelper | ||
| import androidx.recyclerview.widget.RecyclerView | ||
| import androidx.recyclerview.widget.RecyclerView.SmoothScroller.ScrollVectorProvider | ||
| import androidx.recyclerview.widget.SnapHelper | ||
| import com.rubensousa.dpadrecyclerview.layoutmanager.PivotLayoutManager | ||
| import kotlin.math.abs | ||
| import kotlin.math.max | ||
| import kotlin.math.min | ||
|
|
||
| /** | ||
| * A [SnapHelper] that scrolls Views to their alignment configuration | ||
| * and performs selections automatically. | ||
| * Use this only if you need to support touch event handling, | ||
| * as [DpadRecyclerView] by default does not handle selection on touch events. | ||
| */ | ||
| class DpadSelectionSnapHelper : LinearSnapHelper() { | ||
|
|
||
| private val maxScrollOnFlingDurationMs = 500 | ||
| private val millisecondsPerInch = 100f | ||
| private var currentRecyclerView: DpadRecyclerView? = null | ||
|
|
||
| override fun attachToRecyclerView(recyclerView: RecyclerView?) { | ||
| super.attachToRecyclerView(recyclerView) | ||
| if (recyclerView is DpadRecyclerView) { | ||
| currentRecyclerView = recyclerView | ||
| return | ||
| } | ||
| if (recyclerView != null) { | ||
| throw IllegalArgumentException("Only DpadRecyclerView can be used with DpadSnapHelper") | ||
| } | ||
| } | ||
|
|
||
| override fun calculateDistanceToFinalSnap( | ||
| layoutManager: RecyclerView.LayoutManager, targetView: View | ||
| ): IntArray { | ||
| val distance = intArrayOf(0, 0) | ||
| if (layoutManager !is PivotLayoutManager) { | ||
| return distance | ||
| } | ||
| val scrollOffset = layoutManager.getScrollOffset(targetView) | ||
| layoutManager.select(targetView) | ||
| if (layoutManager.isHorizontal()) { | ||
| distance[0] = scrollOffset | ||
| } else { | ||
| distance[1] = scrollOffset | ||
| } | ||
| return distance | ||
| } | ||
|
|
||
| override fun findSnapView(layoutManager: RecyclerView.LayoutManager): View? { | ||
| if (layoutManager !is PivotLayoutManager) { | ||
| return null | ||
| } | ||
| var nearestView: View? = null | ||
| var nearestOffset: Int = Int.MAX_VALUE | ||
| for (i in 0 until layoutManager.childCount) { | ||
| val child = layoutManager.getChildAt(i) ?: continue | ||
| val offset = abs(layoutManager.getScrollOffset(child)) | ||
| if (offset < nearestOffset && hasFocusableChild(child)) { | ||
| nearestOffset = offset | ||
| nearestView = child | ||
| } | ||
| } | ||
| return nearestView | ||
| } | ||
|
|
||
| private fun hasFocusableChild(view: View): Boolean { | ||
| if (view.isFocusable || view.isFocusableInTouchMode) { | ||
| return true | ||
| } | ||
| val viewGroup = view as? ViewGroup ?: return false | ||
| viewGroup.forEach { child -> | ||
| if (hasFocusableChild(child)) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| override fun createScroller( | ||
| layoutManager: RecyclerView.LayoutManager | ||
| ): RecyclerView.SmoothScroller? { | ||
| val recyclerView = currentRecyclerView ?: return null | ||
| if (layoutManager !is ScrollVectorProvider) { | ||
| return null | ||
| } | ||
| return object : LinearSmoothScroller(recyclerView.context) { | ||
|
|
||
| override fun onTargetFound( | ||
| targetView: View, state: RecyclerView.State, action: Action | ||
| ) { | ||
| val snapDistances = calculateDistanceToFinalSnap(layoutManager, targetView) | ||
| val dx = snapDistances[0] | ||
| val dy = snapDistances[1] | ||
| val time = calculateTimeForDeceleration( | ||
| max(abs(dx.toDouble()), abs(dy.toDouble())).toInt() | ||
| ) | ||
| if (time > 0) { | ||
| action.update(dx, dy, time, mDecelerateInterpolator) | ||
| } | ||
| } | ||
|
|
||
| override fun calculateSpeedPerPixel(displayMetrics: DisplayMetrics): Float { | ||
| return millisecondsPerInch / displayMetrics.densityDpi | ||
| } | ||
|
|
||
| override fun calculateTimeForScrolling(dx: Int): Int { | ||
| return min( | ||
| maxScrollOnFlingDurationMs.toDouble(), | ||
| super.calculateTimeForScrolling(dx).toDouble() | ||
| ).toInt() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.