Skip to content

Emit onJumpToLocator when swiping across resources in scroll mode #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 9, 2023
Merged

Emit onJumpToLocator when swiping across resources in scroll mode #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da7b9e6
Emit `onJumpToLocator` when swiping across resources in scroll mode
mickael-menu Jan 27, 2023
88362be
Merge branch 'develop' into scroll-jump
mickael-menu Jan 27, 2023
52aa1c3
Fix offset
mickael-menu Feb 9, 2023
08457e0
Merge branch 'develop' into scroll-jump
mickael-menu Feb 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ All notable changes to this project will be documented in this file. Take a look
* New `EPUBNavigatorFragment.Configuration.useReadiumCssFontSize` option to revert to the 2.2.0 strategy for setting the font size of reflowable EPUB publications.
* The native font size strategy introduced in 2.3.0 uses the Android web view's [`WebSettings.textZoom`](https://developer.android.com/reference/android/webkit/WebSettings#setTextZoom(int)) property to adjust the font size. 2.2.0 was using Readium CSS's [`--USER__fontSize` variable](https://readium.org/readium-css/docs/CSS12-user_prefs.html#font-size).
* `WebSettings.textZoom` will work with more publications than `--USER__fontSize`, even the ones poorly authored. However the page width is not adjusted when changing the font size to keep the optimal line length.
* Scroll mode: jumping between two EPUB resources with a horizontal swipe triggers the `Navigator.Listener.onJumpToLocator()` callback.
* This can be used to allow the user to go back to their previous location if they swiped across chapters by mistake.

#### Changed

Expand Down
74 changes: 49 additions & 25 deletions readium/navigator/src/main/java/org/readium/r2/navigator/R2BasicWebView.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ open class R2BasicWebView(context: Context, attrs: AttributeSet) : WebView(conte
fun onProgressionChanged()
fun onHighlightActivated(id: String)
fun onHighlightAnnotationMarkActivated(id: String)
fun goForward(animated: Boolean = false, completion: () -> Unit = {}): Boolean
fun goBackward(animated: Boolean = false, completion: () -> Unit = {}): Boolean
fun goForward(animated: Boolean = false, completion: () -> Unit = {}): Boolean = false
fun goBackward(animated: Boolean = false, completion: () -> Unit = {}): Boolean = false

/**
* Returns the custom [ActionMode.Callback] to be used with the text selection menu.
Expand All @@ -75,15 +75,23 @@ open class R2BasicWebView(context: Context, attrs: AttributeSet) : WebView(conte

@InternalReadiumApi
fun javascriptInterfacesForResource(link: Link): Map<String, Any?> = emptyMap()

@InternalReadiumApi
fun shouldOverrideUrlLoading(webView: WebView, request: WebResourceRequest): Boolean = false

@InternalReadiumApi
fun shouldInterceptRequest(webView: WebView, request: WebResourceRequest): WebResourceResponse? = null

@InternalReadiumApi
fun resourceAtUrl(url: String): Resource? = null

/**
* Requests to load the next resource in the reading order.
*
* @param jump Indicates whether it's a discontinuous jump from the current locator. Used
* for scroll mode.
*/
@InternalReadiumApi
fun goToNextResource(jump: Boolean, animated: Boolean): Boolean = false
@InternalReadiumApi
fun goToPreviousResource(jump: Boolean, animated: Boolean): Boolean = false
}

var listener: Listener? = null
Expand Down Expand Up @@ -183,22 +191,31 @@ open class R2BasicWebView(context: Context, attrs: AttributeSet) : WebView(conte
val listener = listener ?: return@launch
listener.onScroll()

fun goRight() {
val isRtl = (listener.readingProgression == ReadingProgression.RTL)

fun goRight(jump: Boolean) {
if (listener.readingProgression == ReadingProgression.RTL) {
listener.goBackward(animated = animated)
listener.goBackward(animated = animated) // Legacy
listener.goToPreviousResource(jump = jump, animated = animated)
} else {
listener.goForward(animated = animated)
listener.goForward(animated = animated) // Legacy
listener.goToNextResource(jump = jump, animated = animated)
}
}

if (scrollMode || !this@R2BasicWebView.canScrollHorizontally(1)) {
goRight()
} else {
runJavaScript("readium.scrollRight();") { success ->
if (!success.toBoolean()) {
goRight()
when {
scrollMode ->
goRight(jump = true)

!this@R2BasicWebView.canScrollHorizontally(1) ->
goRight(jump = false)

else ->
runJavaScript("readium.scrollRight();") { success ->
if (!success.toBoolean()) {
goRight(jump = false)
}
}
}
}
}
}
Expand All @@ -209,22 +226,29 @@ open class R2BasicWebView(context: Context, attrs: AttributeSet) : WebView(conte
val listener = listener ?: return@launch
listener.onScroll()

fun goLeft() {
fun goLeft(jump: Boolean) {
if (listener.readingProgression == ReadingProgression.RTL) {
listener.goForward(animated = animated)
listener.goForward(animated = animated) // legacy
listener.goToNextResource(jump = jump, animated = animated)
} else {
listener.goBackward(animated = animated)
listener.goBackward(animated = animated) // legacy
listener.goToPreviousResource(jump = jump, animated = animated)
}
}

if (scrollMode || !this@R2BasicWebView.canScrollHorizontally(-1)) {
goLeft()
} else {
runJavaScript("readium.scrollLeft();") { success ->
if (!success.toBoolean()) {
goLeft()
when {
scrollMode ->
goLeft(jump = true)

!this@R2BasicWebView.canScrollHorizontally(-1) ->
goLeft(jump = false)

else ->
runJavaScript("readium.scrollLeft();") { success ->
if (!success.toBoolean()) {
goLeft(jump = false)
}
}
}
}
}
}
Expand Down
36 changes: 28 additions & 8 deletions readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubNavigatorFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,11 +763,13 @@ class EpubNavigatorFragment internal constructor(
r2Activity?.highlightAnnotationMarkActivated(id)
}

override fun goForward(animated: Boolean, completion: () -> Unit): Boolean =
goToNextResource(animated, completion)
override fun goToPreviousResource(jump: Boolean, animated: Boolean): Boolean {
return this@EpubNavigatorFragment.goToPreviousResource(jump = jump, animated = animated)
}

override fun goBackward(animated: Boolean, completion: () -> Unit): Boolean =
goToPreviousResource(animated, completion)
override fun goToNextResource(jump: Boolean, animated: Boolean): Boolean {
return this@EpubNavigatorFragment.goToNextResource(jump = jump, animated = animated)
}

override val selectionActionModeCallback: ActionMode.Callback?
get() = config.selectionActionModeCallback
Expand All @@ -791,7 +793,7 @@ class EpubNavigatorFragment internal constructor(

override fun goForward(animated: Boolean, completion: () -> Unit): Boolean {
if (publication.metadata.presentation.layout == EpubLayout.FIXED) {
return goToNextResource(animated, completion)
return goToNextResource(jump = false, animated = animated, completion)
}

val webView = currentReflowablePageFragment?.webView ?: return false
Expand All @@ -809,7 +811,7 @@ class EpubNavigatorFragment internal constructor(

override fun goBackward(animated: Boolean, completion: () -> Unit): Boolean {
if (publication.metadata.presentation.layout == EpubLayout.FIXED) {
return goToPreviousResource(animated, completion)
return goToPreviousResource(jump = false, animated = animated, completion)
}

val webView = currentReflowablePageFragment?.webView ?: return false
Expand All @@ -825,12 +827,16 @@ class EpubNavigatorFragment internal constructor(
return true
}

private fun goToNextResource(animated: Boolean, completion: () -> Unit): Boolean {
private fun goToNextResource(jump: Boolean, animated: Boolean, completion: () -> Unit = {}): Boolean {
val adapter = resourcePager.adapter ?: return false
if (resourcePager.currentItem >= adapter.count - 1) {
return false
}

if (jump) {
locatorToNextResource()?.let { listener?.onJumpToLocator(it) }
}

resourcePager.setCurrentItem(resourcePager.currentItem + 1, animated)

currentReflowablePageFragment?.webView?.let { webView ->
Expand All @@ -845,11 +851,15 @@ class EpubNavigatorFragment internal constructor(
return true
}

private fun goToPreviousResource(animated: Boolean, completion: () -> Unit): Boolean {
private fun goToPreviousResource(jump: Boolean, animated: Boolean, completion: () -> Unit = {}): Boolean {
if (resourcePager.currentItem <= 0) {
return false
}

if (jump) {
locatorToPreviousResource()?.let { listener?.onJumpToLocator(it) }
}

resourcePager.setCurrentItem(resourcePager.currentItem - 1, animated)

currentReflowablePageFragment?.webView?.let { webView ->
Expand All @@ -864,6 +874,16 @@ class EpubNavigatorFragment internal constructor(
return true
}

private fun locatorToPreviousResource(): Locator? =
locatorToResourceAtIndex(resourcePager.currentItem - 1)

private fun locatorToNextResource(): Locator? =
locatorToResourceAtIndex(resourcePager.currentItem + 1)

private fun locatorToResourceAtIndex(index: Int): Locator? =
publication.readingOrder.getOrNull(index)
?.let { publication.locatorFromLink(it) }

private val r2PagerAdapter: R2PagerAdapter?
get() = if (::resourcePager.isInitialized) resourcePager.adapter as? R2PagerAdapter
else null
Expand Down